xref: /netbsd-src/lib/libm/man/acosh.3 (revision 2a399c6883d870daece976daec6ffa7bb7f934ce)
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.\"	$NetBSD: acosh.3,v 1.9 1997/10/09 11:27:07 lukem Exp $
34.\"
35.Dd May 6, 1991
36.Dt ACOSH 3
37.Os
38.Sh NAME
39.Nm acosh
40.Nd inverse hyperbolic cosine function
41.Sh SYNOPSIS
42.Fd #include <math.h>
43.Ft double
44.Fn acosh "double x"
45.Ft float
46.Fn acoshf "float x"
47.Sh DESCRIPTION
48The
49.Fn acosh
50and
51.Fn acoshf
52functions compute the inverse hyperbolic cosine
53of the real
54argument
55.Ar x .
56.Sh RETURN VALUES
57.\" POSIX_MODE
58If x is less than one,
59.Fn acosh "x"
60and
61.Fn acoshf "x"
62return NaN and set the global variable
63.Va errno
64to EDOM.
65.\" SVR4_MODE
66.\" call
67.\" .Xr matherr 3 .
68.Sh SEE ALSO
69.Xr asinh 3 ,
70.Xr atanh 3 ,
71.Xr exp 3 ,
72.Xr math 3
73.\" .Xr matherr 3
74.Sh HISTORY
75The
76.Fn acosh
77function appeared in
78.Bx 4.3 .
79