xref: /netbsd/lib/libm/man/sincos.3 (revision 69d28794)
15fd1b5edSchristos.\" Copyright (c) 2011 Steven G. Kargl.
25fd1b5edSchristos.\"
35fd1b5edSchristos.\" Redistribution and use in source and binary forms, with or without
45fd1b5edSchristos.\" modification, are permitted provided that the following conditions
55fd1b5edSchristos.\" are met:
65fd1b5edSchristos.\" 1. Redistributions of source code must retain the above copyright
75fd1b5edSchristos.\"    notice, this list of conditions and the following disclaimer.
85fd1b5edSchristos.\" 2. Redistributions in binary form must reproduce the above copyright
95fd1b5edSchristos.\"    notice, this list of conditions and the following disclaimer in the
105fd1b5edSchristos.\"    documentation and/or other materials provided with the distribution.
115fd1b5edSchristos.\"
125fd1b5edSchristos.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
135fd1b5edSchristos.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
145fd1b5edSchristos.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
155fd1b5edSchristos.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
165fd1b5edSchristos.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
175fd1b5edSchristos.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
185fd1b5edSchristos.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
195fd1b5edSchristos.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
205fd1b5edSchristos.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
215fd1b5edSchristos.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
225fd1b5edSchristos.\" SUCH DAMAGE.
235fd1b5edSchristos.\"
245fd1b5edSchristos.\" $FreeBSD: head/lib/msun/man/sincos.3 366583 2020-10-09 19:12:44Z gbe $
25*69d28794Schristos.\" $NetBSD: sincos.3,v 1.2 2023/06/11 15:28:21 christos Exp $
265fd1b5edSchristos.\"
27*69d28794Schristos.Dd June 11, 2023
285fd1b5edSchristos.Dt SINCOS 3
295fd1b5edSchristos.Os
305fd1b5edSchristos.Sh NAME
315fd1b5edSchristos.Nm sincos ,
325fd1b5edSchristos.Nm sincosf ,
335fd1b5edSchristos.Nm sincosl
345fd1b5edSchristos.Nd sine and cosine functions
355fd1b5edSchristos.Sh LIBRARY
365fd1b5edSchristos.Lb libm
375fd1b5edSchristos.Sh SYNOPSIS
385fd1b5edSchristos.In math.h
395fd1b5edSchristos.Ft void
405fd1b5edSchristos.Fn sincos "double x" "double *s" "double *c"
415fd1b5edSchristos.Ft void
425fd1b5edSchristos.Fn sincosf "float x" "float *s" "float *c"
435fd1b5edSchristos.Ft void
445fd1b5edSchristos.Fn sincosl "long double x" "long double *s" "long double *c"
455fd1b5edSchristos.Sh DESCRIPTION
465fd1b5edSchristosThe
475fd1b5edSchristos.Fn sincos ,
485fd1b5edSchristos.Fn sincosf ,
495fd1b5edSchristosand
505fd1b5edSchristos.Fn sincosl
515fd1b5edSchristosfunctions compute the sine and cosine of
525fd1b5edSchristos.Fa x .
535fd1b5edSchristosUsing these functions allows argument reduction to occur only
545fd1b5edSchristosonce instead of twice with individual invocations of
555fd1b5edSchristos.Fn sin
565fd1b5edSchristosand
575fd1b5edSchristos.Fn cos .
585fd1b5edSchristosLike
595fd1b5edSchristos.Fn sin
605fd1b5edSchristosand
615fd1b5edSchristos.Fn cos ,
625fd1b5edSchristosa large magnitude argument may yield a result with little
635fd1b5edSchristosor no significance.
645fd1b5edSchristos.Sh RETURN VALUES
655fd1b5edSchristosUpon returning from
665fd1b5edSchristos.Fn sincos ,
675fd1b5edSchristos.Fn sincosf ,
685fd1b5edSchristosand
695fd1b5edSchristos.Fn sincosl ,
705fd1b5edSchristosthe memory pointed to by
715fd1b5edSchristos.Ar "*s"
725fd1b5edSchristosand
735fd1b5edSchristos.Ar "*c"
745fd1b5edSchristosare assigned the values of sine and cosine, respectively.
755fd1b5edSchristos.Sh SEE ALSO
765fd1b5edSchristos.Xr cos 3 ,
775fd1b5edSchristos.Xr sin 3 ,
785fd1b5edSchristos.Sh HISTORY
795fd1b5edSchristosThese functions were added to
80*69d28794Schristos.Fx 11.2
815fd1b5edSchristosand
825fd1b5edSchristos.Nx 10.0
835fd1b5edSchristosto aid in writing various complex function contained in
845fd1b5edSchristos.St -isoC-99 .
855fd1b5edSchristos
86