lib/libm/common_source/atanh.3

   1 .\" Copyright (c) 1985, 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\"     @(#)atanh.3     8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libm/common_source/atanh.3,v 1.4.2.2 2001/08/17 15:43:04 ru Exp $
  34 .\" $DragonFly: src/lib/libm/common_source/Attic/atanh.3,v 1.2 2003/06/17 04:26:50 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt ATANH 3
  38 .Os
  39 .Sh NAME
  40 .Nm atanh
  41 .Nd inverse hyperbolic tangent function
  42 .Sh LIBRARY
  43 .Lb libm
  44 .Sh SYNOPSIS
  45 .Fd #include <math.h>
  46 .Ft double
  47 .Fn atanh "double x"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn  atanh
  51 function computes the inverse hyperbolic tangent
  52 of the real
  53 argument
  54 .Ar x .
  55 For a discussion of error due to roundoff, see
  56 .Xr math 3 .
  57 .Sh RETURN VALUES
  58 The
  59 .Fn atanh
  60 function
  61 returns the inverse hyperbolic tangent of
  62 .Ar x
  63 if successful.
  64 On the
  65 .Tn VAX
  66 and
  67 .Tn Tahoe ,
  68 if the argument has absolute value
  69 bigger than or equal to 1,
  70 .Fn atanh
  71 sets the global variable
  72 .Va errno
  73 to
  74 .Er EDOM
  75 and
  76 a reserved operand fault is generated.
  77 .Sh SEE ALSO
  78 .Xr acosh 3 ,
  79 .Xr asinh 3 ,
  80 .Xr exp 3 ,
  81 .Xr infnan 3 ,
  82 .Xr math 3
  83 .Sh HISTORY
  84 The
  85 .Fn atanh
  86 function appeared in
  87 .Bx 4.3 .