usr/src/man/man3mvec/vz_log_.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 VZ_LOG_ 3MVEC "Dec 14, 2007" "SunOS 5.11" "Vector Math Library Functions"
   7 .SH NAME
   8 vz_log_, vc_log_ \- vector complex logarithm functions
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lmvec\fR [ \fIlibrary\fR\&.\|.\|. ]
  13
  14 \fBvoid\fR \fBvz_log_\fR(\fBint *\fR\fIn\fR, \fBdouble complex * restrict\fR \fIz\fR,
  15      \fBint *\fR\fIstridez\fR, \fBdouble _complex * restrict\fR \fIw\fR, \fBint *\fR\fIstridew\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBvoid\fR \fBvc_log_\fR(\fBint *\fR\fIn\fR, \fBfloat complex * restrict\fR \fIz\fR,
  21      \fBint *\fR\fIstridez\fR, \fBfloat complex * restrict\fR \fIw\fR, \fBint *\fR\fIstridew\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 These functions evaluate the complex function \fBlog\fR(\fIz\fR) for an entire
  28 vector of values at once. The first parameter specifies the number of values to
  29 compute. Subsequent parameters specify the argument and result vectors. Each
  30 vector is described by a pointer to the first element and a stride, which is
  31 the increment between successive elements.
  32 .sp
  33 .LP
  34 Specifically, \fBvz_log_\fR(\fIn\fR, \fIz\fR, \fIsz\fR, \fIw\fR, \fIsw\fR)
  35 computes \fIw\fR[\fIi\fR * *\fIsw\fR] = \fBlog\fR(\fIz\fR[\fIi\fR * *\fIsz\fR])
  36 for each \fIi\fR = 0, 1, ..., *\fIn\fR - 1. The \fBvc_log_()\fR function
  37 performs the same computation for single precision data.
  38 .sp
  39 .LP
  40 These functions are not guaranteed to deliver results that are identical to the
  41 results of the \fBclog\fR(3M) functions given the same arguments.
  42 .SH USAGE
  43 .sp
  44 .LP
  45 The element count *\fIn\fR must be greater than zero. The strides for the
  46 argument and result arrays can be arbitrary integers, but the arrays themselves
  47 must not be the same or overlap. A zero stride effectively collapses an entire
  48 vector into a single element. A negative stride causes a vector to be accessed
  49 in descending memory order, but note that the corresponding pointer must still
  50 point to the first element of the vector to be used; if the stride is negative,
  51 this will be the highest-addressed element in memory. This convention differs
  52 from the Level 1 BLAS, in which array parameters always refer to the
  53 lowest-addressed element in memory even when negative increments are used.
  54 .sp
  55 .LP
  56 These functions assume that the default round-to-nearest rounding direction
  57 mode is in effect. On x86, these functions also assume that the default
  58 round-to-64-bit rounding precision mode is in effect. The result of calling a
  59 vector function with a non-default rounding mode in effect is undefined.
  60 .sp
  61 .LP
  62 Unlike the c99 \fBclog\fR(3M) functions, the vector complex exponential
  63 functions make no attempt to handle special cases and exceptions; they simply
  64 use textbook formulas to compute a complex exponential in terms of real
  65 elementary functions. As a result, these functions can raise different
  66 exceptions and/or deliver different results from \fBclog()\fR.
  67 .SH ATTRIBUTES
  68 .sp
  69 .LP
  70 See \fBattributes\fR(5) for descriptions of the following attributes:
  71 .sp
  72
  73 .sp
  74 .TS
  75 tab(    ) box;
  76 cw(2.75i) |cw(2.75i)
  77 lw(2.75i) |lw(2.75i)
  78 .
  79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  80 _
  81 Interface Stability     Committed
  82 _
  83 MT-Level        MT-Safe
  84 .TE
  85
  86 .SH SEE ALSO
  87 .sp
  88 .LP
  89 \fBclog\fR(3M), \fBattributes\fR(5)