usr/src/man/man3mvec/vsincos_.3mvec

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH VSINCOS_ 3MVEC "Dec 14, 2007" "SunOS 5.11" "Vector Math Library Functions"
   7 .SH NAME
   8 vsincos_, vsincosf_ \- vector sincos functions
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lmvec\fR [ \fIlibrary\fR\&.\|.\|. ]
  13
  14 \fBvoid\fR \fBvsincos_\fR(\fBint *\fR\fIn\fR, \fBdouble * restrict\fR \fIx\fR, \fBint *\fR\fIstridex\fR,
  15      \fBdouble * restrict\fR \fIs\fR, \fBint *\fR\fIstrides\fR, \fBdouble * restrict\fR \fIc\fR,
  16      \fBint *\fR\fIstridec\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBvoid\fR \fBvsincosf_\fR(\fBint *\fR\fIn\fR, \fBfloat * restrict\fR \fIx\fR, \fBint *\fR\fIstridex\fR,
  22      \fBfloat * restrict\fR \fIs\fR, \fBint *\fR\fIstrides\fR, \fBfloat * restrict\fR \fIc\fR,
  23      \fBint *\fR\fIstridec\fR);
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 These functions evaluate both \fBsin\fR(\fIx\fR) and \fBcos\fR(\fIx\fR) for an
  30 entire vector of values at once. The first parameter specifies the number of
  31 values to compute. Subsequent parameters specify the argument and result
  32 vectors. Each vector is described by a pointer to the first element and a
  33 stride, which is the increment between successive elements.
  34 .sp
  35 .LP
  36 Specifically, \fBvsincos_\fR(\fIn\fR, \fIx\fR, \fIsx\fR, \fIs\fR, \fIss\fR,
  37 \fIc\fR, \fIsc\fR) simultaneously computes \fIs\fR[\fIi\fR * *\fIss\fR] =
  38 \fBsin\fR(\fIx\fR[\fIi\fR * *\fIsx\fR]) and \fIc\fR[\fIi\fR * *\fIsc\fR] =
  39 \fBcos\fR(\fIx\fR[\fIi\fR * *\fIsx\fR]) for each \fIi\fR = 0, 1, ..., *\fIn\fR
  40 - 1. The  \fBvsincosf_()\fR function performs the same computation for single
  41 precision data.
  42 .sp
  43 .LP
  44 These functions are not guaranteed to deliver results that are identical to the
  45 results of the \fBsincos\fR(3M) functions given the same arguments.
  46 Non-exceptional results, however, are accurate to within a unit in the last
  47 place.
  48 .SH USAGE
  49 .sp
  50 .LP
  51 The element count *\fIn\fR must be greater than zero. The strides for the
  52 argument and result arrays can be arbitrary integers, but the arrays themselves
  53 must not be the same or overlap. A zero stride effectively collapses an entire
  54 vector into a single element. A negative stride causes a vector to be accessed
  55 in descending memory order, but note that the corresponding pointer must still
  56 point to the first element of the vector to be used; if the stride is negative,
  57 this will be the highest-addressed element in memory. This convention differs
  58 from the Level 1 BLAS, in which array parameters always refer to the
  59 lowest-addressed element in memory even when negative increments are used.
  60 .sp
  61 .LP
  62 These functions assume that the default round-to-nearest rounding direction
  63 mode is in effect. On x86, these functions also assume that the default
  64 round-to-64-bit rounding precision mode is in effect. The result of calling a
  65 vector function with a non-default rounding mode in effect is undefined.
  66 .sp
  67 .LP
  68 These functions handle special cases and exceptions in the same way as the
  69 \fBsin()\fR and \fBcos()\fR functions when \fBc99\fR \fBMATHERREXCEPT\fR
  70 conventions are in effect. See \fBsin\fR(3M) and \fBcos\fR(3M) for the results
  71 for special cases.
  72 .sp
  73 .LP
  74 An application wanting to check for exceptions should call
  75 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
  76 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
  77 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
  78 raised. The application can then examine the result or argument vectors for
  79 exceptional values. Some vector functions can raise the inexact exception even
  80 if all elements of the argument array are such that the numerical results are
  81 exact.
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5) for descriptions of the following attributes:
  86 .sp
  87
  88 .sp
  89 .TS
  90 tab(    ) box;
  91 cw(2.75i) |cw(2.75i)
  92 lw(2.75i) |lw(2.75i)
  93 .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 Interface Stability     Committed
  97 _
  98 MT-Level        MT-Safe
  99 .TE
 100
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBcos\fR(3M), \fBsin\fR(3M), \fBsincos\fR(3M), \fBfeclearexcept\fR(3M),
 105 \fBfetestexcept\fR(3M), \fBattributes\fR(5)