xref: /illumos-gate/usr/src/man/man3mvec/vz_pow_.3mvec (revision e8921a52c53ee69f7b65f054d9b2e886139daa59)
te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
VZ_POW_ 3MVEC "Dec 14, 2007" "SunOS 5.11" "Vector Math Library Functions"
NAME
vz_pow_, vc_pow_ - vector complex power functions
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -lmvec [ library.\|.\|. ]

void vz_pow_(int *n, double complex * restrict z,
 int *stridez, double complex * restrict w, int *stridew,
 double complex * restrict u, int *strideu,
 double * tmp);

void vc_pow_(int *n, float complex * restrict z,
 int *stridez, float complex * restrict w, int *stridew,
 float complex * restrict u, int *strideu,
 float * tmp);
DESCRIPTION

These functions evaluate the complex function z^w for an entire vector of values at once. The first parameter specifies the number of values to compute. Subsequent parameters specify the argument and result vectors. Each vector is described by a pointer to the first element and a stride, which is the increment between successive elements. The last argument is a pointer to scratch storage; this storage must be large enough to hold 3 * *n consecutive values of the real type corresponding to the complex type of the argument and result.

Specifically, vz_pow_(n, z, sz, w, sw, u, su, tmp) computes u[i * *su] = (z[i * *sz])^(w[i * *sw]) for each i = 0, 1, ..., *n - 1. The vc_pow_() function performs the same computation for single precision data.

These functions are not guaranteed to deliver results that are identical to the results of the cpow(3M) functions given the same arguments.

USAGE

The element count *n must be greater than zero. The strides for the argument and result arrays can be arbitrary integers, but the arrays themselves must not be the same or overlap. A zero stride effectively collapses an entire vector into a single element. A negative stride causes a vector to be accessed in descending memory order, but note that the corresponding pointer must still point to the first element of the vector to be used; if the stride is negative, this will be the highest-addressed element in memory. This convention differs from the Level 1 BLAS, in which array parameters always refer to the lowest-addressed element in memory even when negative increments are used.

These functions assume that the default round-to-nearest rounding direction mode is in effect. On x86, these functions also assume that the default round-to-64-bit rounding precision mode is in effect. The result of calling a vector function with a non-default rounding mode in effect is undefined.

Unlike the c99 cpow(3M) functions, the vector complex exponential functions make no attempt to handle special cases and exceptions; they simply use textbook formulas to compute a complex exponential in terms of real elementary functions. As a result, these functions can raise different exceptions and/or deliver different results from cpow().

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
SEE ALSO

cpow(3M), attributes(5)