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: src/lib/msun/man/atanh.3,v 1.6.2.3 2001/12/17 10:08:36 ru Exp $
  34 .\" $DragonFly: src/lib/msun/man/Attic/atanh.3,v 1.2 2003/06/17 04:26:52 dillon Exp $
  35 .\"
  36 .Dd May 6, 1991
  37 .Dt ATANH 3
  38 .Os
  39 .Sh NAME
  40 .Nm atanh ,
  41 .Nm atanhf
  42 .Nd inverse hyperbolic tangent functions
  43 .Sh LIBRARY
  44 .Lb libm
  45 .Sh SYNOPSIS
  46 .In math.h
  47 .Ft double
  48 .Fn atanh "double x"
  49 .Ft float
  50 .Fn atanhf "float x"
  51 .Sh DESCRIPTION
  52 The
  53 .Fn  atanh
  54 and the
  55 .Fn  atanhf
  56 functions compute the inverse hyperbolic tangent
  57 of the real
  58 argument
  59 .Ar x .
  60 For a discussion of error due to roundoff, see
  61 .Xr math 3 .
  62 .Sh RETURN VALUES
  63 The
  64 .Fn atanh
  65 and the
  66 .Fn atanhf
  67 functions
  68 return the inverse hyperbolic tangent of
  69 .Ar x
  70 if successful.
  71 On the
  72 .Tn VAX
  73 and
  74 .Tn Tahoe ,
  75 if the argument has absolute value
  76 bigger than or equal to 1,
  77 .Fn atanh
  78 sets the global variable
  79 .Va errno
  80 to
  81 .Er EDOM
  82 and
  83 a reserved operand fault is generated.
  84 .Sh SEE ALSO
  85 .Xr acosh 3 ,
  86 .Xr asinh 3 ,
  87 .Xr exp 3 ,
  88 .Xr math 3
  89 .Sh HISTORY
  90 The
  91 .Fn atanh
  92 function appeared in
  93 .Bx 4.3 .