Initial import from FreeBSD RELENG_4:
[games.git] / lib / msun / man / asin.3
1 .\" Copyright (c) 1991 The 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: @(#)asin.3        5.1 (Berkeley) 5/2/91
33 .\" $FreeBSD: src/lib/msun/man/asin.3,v 1.6.2.4 2001/12/17 10:08:36 ru Exp $
34 .\"
35 .Dd May 2, 1991
36 .Dt ASIN 3
37 .Os
38 .Sh NAME
39 .Nm asin ,
40 .Nm asinf
41 .Nd arc sine functions
42 .Sh LIBRARY
43 .Lb libm
44 .Sh SYNOPSIS
45 .In math.h
46 .Ft double
47 .Fn asin "double  x"
48 .Ft float
49 .Fn asinf "float  x"
50 .Sh DESCRIPTION
51 The
52 .Fn asin
53 and the
54 .Fn asinf
55 functions compute the principal value of the arc sine of
56 .Fa x .
57 A domain error occurs for arguments not in the range
58 .Bq -1 , +1 .
59 For a discussion of error due to roundoff, see
60 .Xr math 3 .
61 .Sh RETURN VALUES
62 The
63 .Fn asin
64 and the
65 .Fn asinf
66 functions return the arc sine in the range
67 .Bk -words
68 .Bq -\*(Pi/2 , +\*(Pi/2
69 .Ek
70 radians.
71 On the
72 .Tn VAX ,
73 and Tahoe,
74 if:
75 .Bd -unfilled -offset indent
76 .Pf \&| Ns Ar x Ns \&| > 1
77 .Ed
78 .Pp
79 the
80 global variable
81 .Va errno
82 is set to
83 .Er EDOM
84 and
85 a reserved operand fault generated.
86 .Sh SEE ALSO
87 .Xr acos 3 ,
88 .Xr atan 3 ,
89 .Xr atan2 3 ,
90 .Xr cos 3 ,
91 .Xr cosh 3 ,
92 .Xr math 3 ,
93 .Xr sin 3 ,
94 .Xr sinh 3 ,
95 .Xr tan 3 ,
96 .Xr tanh 3
97 .Sh STANDARDS
98 The
99 .Fn asin
100 function conforms to
101 .St -isoC .