man3/asinh.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
   6 .\"
   7 .\" References consulted:
   8 .\"     Linux libc source code
   9 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  10 .\"     386BSD man pages
  11 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  12 .\" Modified 2002-07-27 by Walter Harms
  13 .\"     (walter.harms@informatik.uni-oldenburg.de)
  14 .\"
  15 .TH asinh 3 (date) "Linux man-pages (unreleased)"
  16 .SH NAME
  17 asinh, asinhf, asinhl \- inverse hyperbolic sine function
  18 .SH LIBRARY
  19 Math library
  20 .RI ( libm ", " \-lm )
  21 .SH SYNOPSIS
  22 .nf
  23 .B #include <math.h>
  24 .PP
  25 .BI "double asinh(double " x );
  26 .BI "float asinhf(float " x );
  27 .BI "long double asinhl(long double " x );
  28 .fi
  29 .PP
  30 .RS -4
  31 Feature Test Macro Requirements for glibc (see
  32 .BR feature_test_macros (7)):
  33 .RE
  34 .PP
  35 .BR asinh ():
  36 .nf
  37     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  38         || _XOPEN_SOURCE >= 500
  39 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
  40         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  41         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  42 .fi
  43 .PP
  44 .BR asinhf (),
  45 .BR asinhl ():
  46 .nf
  47     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  48         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  49         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  50 .fi
  51 .SH DESCRIPTION
  52 These functions calculate the inverse hyperbolic sine of
  53 .IR x ;
  54 that is the value whose hyperbolic sine is
  55 .IR x .
  56 .SH RETURN VALUE
  57 On success, these functions return the inverse hyperbolic sine of
  58 .IR x .
  59 .PP
  60 If
  61 .I x
  62 is a NaN, a NaN is returned.
  63 .PP
  64 If
  65 .I x
  66 is +0 (\-0), +0 (\-0) is returned.
  67 .PP
  68 If
  69 .I x
  70 is positive infinity (negative infinity),
  71 positive infinity (negative infinity) is returned.
  72 .\"
  73 .\" POSIX.1-2001 documents an optional range error for subnormal x;
  74 .\" glibc 2.8 does not do this.
  75 .SH ERRORS
  76 No errors occur.
  77 .SH ATTRIBUTES
  78 For an explanation of the terms used in this section, see
  79 .BR attributes (7).
  80 .ad l
  81 .nh
  82 .TS
  83 allbox;
  84 lbx lb lb
  85 l l l.
  86 Interface       Attribute       Value
  87 T{
  88 .BR asinh (),
  89 .BR asinhf (),
  90 .BR asinhl ()
  91 T}      Thread safety   MT-Safe
  92 .TE
  93 .hy
  94 .ad
  95 .sp 1
  96 .SH STANDARDS
  97 C99, POSIX.1-2001, POSIX.1-2008.
  98 .PP
  99 The variant returning
 100 .I double
 101 also conforms to
 102 SVr4, 4.3BSD.
 103 .SH SEE ALSO
 104 .BR acosh (3),
 105 .BR atanh (3),
 106 .BR casinh (3),
 107 .BR cosh (3),
 108 .BR sinh (3),
 109 .BR tanh (3)