Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / msun / man / acosh.3
1 .\" Copyright (c) 1991 Regents of the University of California.
2 .\" 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 .\"     from: @(#)acosh.3       5.2 (Berkeley) 5/6/91
33 .\" $FreeBSD: src/lib/msun/man/acosh.3,v 1.6.2.3 2001/12/17 10:08:36 ru Exp $
34 .\"
35 .Dd May 6, 1991
36 .Dt ACOSH 3
37 .Os
38 .Sh NAME
39 .Nm acosh ,
40 .Nm acoshf
41 .Nd inverse hyperbolic cosine functions
42 .Sh LIBRARY
43 .Lb libm
44 .Sh SYNOPSIS
45 .In math.h
46 .Ft double
47 .Fn acosh "double x"
48 .Ft float
49 .Fn acoshf "float x"
50 .Sh DESCRIPTION
51 The
52 .Fn acosh
53 and the
54 .Fn acoshf
55 functions compute the inverse hyperbolic cosine
56 of the real
57 argument
58 .Ar x .
59 For a discussion of error due to roundoff, see
60 .Xr math 3 .
61 .Sh RETURN VALUES
62 The
63 .Fn acosh
64 and the
65 .Fn acoshf
66 functions
67 return the inverse hyperbolic cosine of
68 .Ar x .
69 On the
70 .Tn VAX
71 and
72 .Tn Tahoe ,
73 if the argument is less than one
74 .Fn acosh
75 sets the global variable
76 .Va errno
77 to
78 .Er EDOM
79 and
80 causes a reserved operand fault.
81 .Sh SEE ALSO
82 .Xr asinh 3 ,
83 .Xr atanh 3 ,
84 .Xr exp 3 ,
85 .Xr math 3
86 .Sh HISTORY
87 The
88 .Fn acosh
89 function appeared in
90 .Bx 4.3 .