lib/msun/man/sincos.3

   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 .\" $FreeBSD$
  25 .\"
  26 .Dd March 12, 2011
  27 .Dt SINCOS 3
  28 .Os
  29 .Sh NAME
  30 .Nm sincos ,
  31 .Nm sincosf ,
  32 .Nm sincosl
  33 .Nd sine and cosine functions
  34 .Sh LIBRARY
  35 .Lb libm
  36 .Sh SYNOPSIS
  37 .In math.h
  38 .Ft void
  39 .Fn sincos "double x" "double *s" "double *c"
  40 .Ft void
  41 .Fn sincosf "float x" "float *s" "float *c"
  42 .Ft void
  43 .Fn sincosl "long double x" "long double *s" "long double *c"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn sincos ,
  47 .Fn sincosf ,
  48 and
  49 .Fn sincosl
  50 functions compute the sine and cosine of
  51 .Fa x .
  52 Using these functions allows argument reduction to occur only
  53 once instead of twice with individual invocations of
  54 .Fn sin
  55 and
  56 .Fn cos .
  57 Like
  58 .Fn sin
  59 and
  60 .Fn cos ,
  61 a large magnitude argument may yield a result with little
  62 or no significance.
  63 .Sh RETURN VALUES
  64 Upon returning from
  65 .Fn sincos ,
  66 .Fn sincosf ,
  67 and
  68 .Fn sincosl ,
  69 the memory pointed to by
  70 .Ar "*s"
  71 and
  72 .Ar "*c"
  73 are assigned the values of sine and cosine, respectively.
  74 .Sh SEE ALSO
  75 .Xr cos 3 ,
  76 .Xr sin 3 ,
  77 .Sh HISTORY
  78 These functions were added to
  79 .Fx 9.0
  80 to aid in writing various complex function contained in
  81 .St -isoC-99 .
  82