lib/msun/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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     from: @(#)atanh.3       5.2 (Berkeley) 5/6/91
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd May 6, 1991
  36 .Dt ATANH 3
  37 .Os BSD 4.3
  38 .Sh NAME
  39 .Nm atanh ,
  40 .Nm atanhf
  41 .Nd inverse hyperbolic tangent functions
  42 .Sh SYNOPSIS
  43 .Fd #include <math.h>
  44 .Ft double
  45 .Fn atanh "double x"
  46 .Ft float
  47 .Fn atanhf "float x"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn  atanh
  51 and the
  52 .Fn  atanhf
  53 functions compute the inverse hyperbolic tangent
  54 of the real
  55 argument
  56 .Ar x .
  57 For a discussion of error due to roundoff, see
  58 .Xr math 3 .
  59 .Sh RETURN VALUES
  60 The
  61 .Fn atanh
  62 and the
  63 .Fn atanhf
  64 functions
  65 return the inverse hyperbolic tangent of
  66 .Ar x
  67 if successful.
  68 On the
  69 .Tn VAX
  70 and
  71 .Tn Tahoe ,
  72 if the argument has absolute value
  73 bigger than or equal to 1,
  74 .Fn atanh
  75 sets the global variable
  76 .Va errno
  77 to
  78 .Er EDOM
  79 and
  80 a reserved operand fault is generated.
  81 .Sh SEE ALSO
  82 .Xr acosh 3 ,
  83 .Xr asinh 3 ,
  84 .Xr exp 3 ,
  85 .Xr math 3
  86 .Sh HISTORY
  87 The
  88 .Fn atanh
  89 function appeared in
  90 .Bx 4.3 .