sunos man page for mlib_vectorsubs_s32c_mod

mlib_VectorSubS_U8_Mod(3MLIB)				    mediaLib Library Functions				     mlib_VectorSubS_U8_Mod(3MLIB)

NAME
       mlib_VectorSubS_U8_Mod,	mlib_VectorSubS_U8_Sat,  mlib_VectorSubS_U8C_Mod,  mlib_VectorSubS_U8C_Sat,  mlib_VectorSubS_S8_Mod,  mlib_Vector-
       SubS_S8_Sat, mlib_VectorSubS_S8C_Mod, mlib_VectorSubS_S8C_Sat, mlib_VectorSubS_S16_Mod, mlib_VectorSubS_S16_Sat,  mlib_VectorSubS_S16C_Mod,
       mlib_VectorSubS_S16C_Sat,  mlib_VectorSubS_S32_Mod,  mlib_VectorSubS_S32_Sat,  mlib_VectorSubS_S32C_Mod,  mlib_VectorSubS_S32C_Sat - vector
       subtraction from scalar, in place

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

       mlib_status mlib_VectorSubS_U8_Mod(mlib_u8 *xz, const mlib_u8 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_U8_Sat(mlib_u8 *xz, const mlib_u8 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_U8C_Mod(mlib_u8 *xz, const mlib_u8 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_U8C_Sat(mlib_u8 *xz, const mlib_u8 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S8_Mod(mlib_s8 *xz, const mlib_s8 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S8_Sat(mlib_s8 *xz, const mlib_s8 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S8C_Mod(mlib_s8 *xz, const mlib_s8 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S8C_Sat(mlib_s8 *xz, const mlib_s8 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S16_Mod(mlib_s16 *xz, const mlib_s16 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S16_Sat(mlib_s16 *xz, const mlib_s16 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S16C_Mod(mlib_s16 *xz, const mlib_s16 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S16C_Sat(mlib_s16 *xz, const mlib_s16 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S32_Mod(mlib_s32 *xz, const mlib_s32 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S32_Sat(mlib_s32 *xz, const mlib_s32 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S32C_Mod(mlib_s32 *xz, const mlib_s32 *c, mlib_s32 n);

       mlib_status mlib_VectorSubS_S32C_Sat(mlib_s32 *xz, const mlib_s32 *c, mlib_s32 n);

DESCRIPTION
       Each of these functions performs an in-place subtraction of a vector from a scalar.

       For real data, the following equation is used:

       xz[i] = c[0] - xz[i]

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

       For complex data, the following equation is used:

       xz[2*i]	   = c[0] - xz[2*i]
       xz[2*i + 1] = c[1] - xz[2*i + 1]

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

PARAMETERS
       Each of the functions takes the following arguments:

       xz	       Pointer to the first element of the source and destination vector.

       c	       Pointer to the source scalar.  When the function is used with complex data types, c[0] contains the  scalar  for  the  real
		       part, and c[1] contains the scalar for the imaginary part.

       n	       Number of elements in the vectors.

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	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       mlib_VectorSubS_U8_U8_Mod(3MLIB), attributes(5)

SunOS 5.10							    10 Nov 2004 				     mlib_VectorSubS_U8_Mod(3MLIB)