manual/LDP_man-pages/original/man3/sinh.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 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified 1996-06-08 by aeb
  31 .\" Modified 2002-07-27 by Walter Harms
  32 .\"     (walter.harms@informatik.uni-oldenburg.de)
  33 .\"
  34 .TH SINH 3  2008-08-05 "" "Linux Programmer's Manual"
  35 .SH NAME
  36 sinh, sinhf, sinhl \- hyperbolic sine function
  37 .SH SYNOPSIS
  38 .nf
  39 .B #include <math.h>
  40 .sp
  41 .BI "double sinh(double " x );
  42 .br
  43 .BI "float sinhf(float " x );
  44 .br
  45 .BI "long double sinhl(long double " x );
  46 .fi
  47 .sp
  48 Link with \fI\-lm\fP.
  49 .sp
  50 .in -4n
  51 Feature Test Macro Requirements for glibc (see
  52 .BR feature_test_macros (7)):
  53 .in
  54 .sp
  55 .ad l
  56 .BR sinhf (),
  57 .BR sinhl ():
  58 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or
  59 .I cc\ -std=c99
  60 .ad b
  61 .SH DESCRIPTION
  62 The
  63 .BR sinh ()
  64 function returns the hyperbolic sine of \fIx\fP, which
  65 is defined mathematically as:
  66 .nf
  67
  68     sinh(x) = (exp(x) \- exp(\-x)) / 2
  69 .fi
  70 .SH "RETURN VALUE"
  71 On success, these functions return the hyperbolic sine of
  72 .IR x .
  73
  74 If
  75 .I x
  76 is a NaN, a NaN is returned.
  77
  78 If
  79 .I x
  80 is +0 (\-0), +0 (\-0) is returned.
  81
  82 If
  83 .I x
  84 is positive infinity (negative infinity),
  85 positive infinity (negative infinity) is returned.
  86
  87 If the result overflows,
  88 a range error occurs,
  89 and the functions return
  90 .BR HUGE_VAL ,
  91 .BR HUGE_VALF ,
  92 or
  93 .BR HUGE_VALL ,
  94 respectively, with the same sign as
  95 .IR x .
  96 .\"
  97 .\" POSIX.1-2001 documents an optional range error (underflow)
  98 .\" for subnormal x;
  99 .\" glibc 2.8 does not do this.
 100 .SH ERRORS
 101 See
 102 .BR math_error (7)
 103 for information on how to determine whether an error has occurred
 104 when calling these functions.
 105 .PP
 106 The following errors can occur:
 107 .TP
 108 Range error: result overflow
 109 .I errno
 110 is set to
 111 .BR ERANGE .
 112 An overflow floating-point exception
 113 .RB ( FE_OVERFLOW )
 114 is raised.
 115 .SH "CONFORMING TO"
 116 C99, POSIX.1-2001.
 117 The variant returning
 118 .I double
 119 also conforms to
 120 SVr4, 4.3BSD, C89.
 121 .SH "SEE ALSO"
 122 .BR acosh (3),
 123 .BR asinh (3),
 124 .BR atanh (3),
 125 .BR cosh (3),
 126 .BR csinh (3),
 127 .BR tanh (3)