opensolaris man page for mlib_vectorang_s32c

mlib_VectorAng_U8C(3MLIB)				    mediaLib Library Functions					 mlib_VectorAng_U8C(3MLIB)

NAME
       mlib_VectorAng_U8C, mlib_VectorAng_S8C, mlib_VectorAng_S16C, mlib_VectorAng_S32C - vector complex phase (angle)

SYNOPSIS
       cc [ flag... ] file... -lmlib [ library... ]
       #include <mlib.h>

       mlib_status mlib_VectorAng_U8C(mlib_d64 *a,
	    const mlib_u8 *x, mlib_s32 n);

       mlib_status mlib_VectorAng_S8C(mlib_d64 *a,
	    const mlib_s8 *x, mlib_s32 n);

       mlib_status mlib_VectorAng_S16C(mlib_d64 *a,
	    const mlib_s16 *x, mlib_s32 n);

       mlib_status mlib_VectorAng_S32C(mlib_d64 *a,
	    const mlib_s32 *x, mlib_s32 n);

DESCRIPTION
       Each of these functions computes the phase vector of a complex vector.

       The following equation is used:

	 a[i] = atan(x[2*i + 1] / x[2*i])

       where i = 0, 1, ..., (n - 1).

PARAMETERS
       Each of the functions takes the following arguments:

       a    Pointer to the destination phase vector.

       x    Pointer to the source vector

       n    Number of elements in the vector.

RETURN VALUES
       Each of the functions returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.

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

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       attributes(5)

SunOS 5.11							    2 Mar 2007						 mlib_VectorAng_U8C(3MLIB)