contrib/openbsd_libm/man/atanh.3

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