xref: /freebsd/lib/msun/man/sincos.3 (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
1.\" Copyright (c) 2011 Steven G. Kargl.
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22.\" SUCH DAMAGE.
23.\"
24.Dd March 12, 2011
25.Dt SINCOS 3
26.Os
27.Sh NAME
28.Nm sincos ,
29.Nm sincosf ,
30.Nm sincosl
31.Nd sine and cosine functions
32.Sh LIBRARY
33.Lb libm
34.Sh SYNOPSIS
35.In math.h
36.Ft void
37.Fn sincos "double x" "double *s" "double *c"
38.Ft void
39.Fn sincosf "float x" "float *s" "float *c"
40.Ft void
41.Fn sincosl "long double x" "long double *s" "long double *c"
42.Sh DESCRIPTION
43The
44.Fn sincos ,
45.Fn sincosf ,
46and
47.Fn sincosl
48functions compute the sine and cosine of
49.Fa x .
50Using these functions allows argument reduction to occur only
51once instead of twice with individual invocations of
52.Fn sin
53and
54.Fn cos .
55Like
56.Fn sin
57and
58.Fn cos ,
59a large magnitude argument may yield a result with little
60or no significance.
61.Sh RETURN VALUES
62Upon returning from
63.Fn sincos ,
64.Fn sincosf ,
65and
66.Fn sincosl ,
67the memory pointed to by
68.Fa "*s"
69and
70.Fa "*c"
71are assigned the values of sine and cosine, respectively.
72.Sh SEE ALSO
73.Xr cos 3 ,
74.Xr sin 3
75.Sh HISTORY
76These functions were added to
77.Fx 11.2
78to aid in writing various complex function contained in
79.St -isoC-99 .
80
81