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