mlib_VectorMag_U8C(3MLIB)				    mediaLib Library Functions					 mlib_VectorMag_U8C(3MLIB)

NAME

       mlib_VectorMag_U8C, mlib_VectorMag_S8C, mlib_VectorMag_S16C, mlib_VectorMag_S32C - vector complex magnitude

SYNOPSIS

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

       mlib_status mlib_VectorMag_U8C(mlib_d64 *m, const mlib_u8 *x,
	    mlib_s32 n);

       mlib_status mlib_VectorMag_S8C(mlib_d64 *m, const mlib_s8 *x,
	    mlib_s32 n);

       mlib_status mlib_VectorMag_S16C(mlib_d64 *m, const mlib_s16 *x,
	    mlib_s32 n);

       mlib_status mlib_VectorMag_S32C(mlib_d64 *m, const mlib_s32 *x,
	    mlib_s32 n);

DESCRIPTION

       Each of these functions computes the magnitude vector of the complex input vector.

       The following equation is used:

	 m[i] = (x[2*i]**2 + x[2*i + 1]**2)**0.5

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

PARAMETERS

       Each of the functions takes the following arguments:

       m    Pointer to the destination magnitude 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_VectorMag_U8C(3MLIB)