lib/libm/man/atanh.3

   1 .\" Copyright (c) 1985, 1991 Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     from: @(#)atanh.3       5.2 (Berkeley) 5/6/91
  29 .\"     $NetBSD: atanh.3,v 1.15 2003/08/07 16:44:46 agc Exp $
  30 .\"     $DragonFly: src/lib/libm/man/atanh.3,v 1.1 2005/07/26 21:15:20 joerg Exp $
  31 .\"
  32 .Dd May 6, 1991
  33 .Dt ATANH 3
  34 .Os
  35 .Sh NAME
  36 .Nm atanh ,
  37 .Nm atanhf
  38 .Nd inverse hyperbolic tangent function
  39 .Sh LIBRARY
  40 .Lb libm
  41 .Sh SYNOPSIS
  42 .In math.h
  43 .Ft double
  44 .Fn atanh "double x"
  45 .Ft float
  46 .Fn atanhf "float x"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn atanh
  50 and
  51 .Fn atanhf
  52 functions compute the inverse hyperbolic tangent
  53 of the real
  54 argument
  55 .Ar x .
  56 .Sh RETURN VALUES
  57 If |x|\*[Ge]1,
  58 .Fn atanh "x"
  59 and
  60 .Fn atanhf "x"
  61 .\" POSIX_MODE
  62 return +inf, -inf or NaN, and sets the global variable
  63 .Va errno
  64 to EDOM.
  65 .\" SYSV_MODE
  66 .\" call
  67 .\" .Xr matherr 3 .
  68 .Sh SEE ALSO
  69 .Xr acosh 3 ,
  70 .Xr asinh 3 ,
  71 .Xr exp 3 ,
  72 .Xr math 3
  73 .\" .Xr matherr 3
  74 .Sh HISTORY
  75 The
  76 .Fn atanh
  77 function appeared in
  78 .Bx 4.3 .