Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

OpenSolaris 2009.06 - man page for mlib_matrixmulsshift_s16_sat (opensolaris section 3mlib)

mlib_MatrixMulSShift_U8_Mod(3MLIB)			    mediaLib Library Functions				mlib_MatrixMulSShift_U8_Mod(3MLIB)

NAME
mlib_MatrixMulSShift_U8_Mod, mlib_MatrixMulSShift_U8_Sat, mlib_MatrixMulSShift_U8C_Mod, mlib_MatrixMulSShift_U8C_Sat, mlib_Matrix- MulSShift_S8_Mod, mlib_MatrixMulSShift_S8_Sat, mlib_MatrixMulSShift_S8C_Mod, mlib_MatrixMulSShift_S8C_Sat, mlib_MatrixMulSShift_S16_Mod, mlib_MatrixMulSShift_S16_Sat, mlib_MatrixMulSShift_S16C_Mod, mlib_MatrixMulSShift_S16C_Sat, mlib_MatrixMulSShift_S32_Mod, mlib_Matrix- MulSShift_S32_Sat, mlib_MatrixMulSShift_S32C_Mod, mlib_MatrixMulSShift_S32C_Sat - matrix multiplication by scalar plus shifting, in place
SYNOPSIS
cc [ flag... ] file... -lmlib [ library... ] #include <mlib.h> mlib_status mlib_MatrixMulSShift_U8_Mod(mlib_u8 *xz, const mlib_u8 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_U8_Sat(mlib_u8 *xz, const mlib_u8 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_U8C_Mod(mlib_u8 *xz, const mlib_u8 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_U8C_Sat(mlib_u8 *xz, const mlib_u8 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S8_Mod(mlib_s8 *xz, const mlib_s8 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S8_Sat(mlib_s8 *xz, const mlib_s8 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S8C_Mod(mlib_s8 *xz, const mlib_s8 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S8C_Sat(mlib_s8 *xz, const mlib_s8 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S16_Mod(mlib_s16 *xz, const mlib_s16 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S16_Sat(mlib_s16 *xz, const mlib_s16 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S16C_Mod(mlib_s16 *xz, const mlib_s16 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S16C_Sat(mlib_s16 *xz, const mlib_s16 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S32_Mod(mlib_s32 *xz, const mlib_s32 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S32_Sat(mlib_s32 *xz, const mlib_s32 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S32C_Mod(mlib_s32 *xz, const mlib_s32 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift); mlib_status mlib_MatrixMulSShift_S32C_Sat(mlib_s32 *xz, const mlib_s32 *c, mlib_s32 m, mlib_s32 n, mlib_s32 shift);
DESCRIPTION
Each of these functions performs an in-place multiplication of a matrix with a scalar and shifts the result. For real data, the following equation is used: xz[i] = c[0]*xz[i]*2**(-shift) where i = 0, 1, ..., (m*n - 1). For complex data, the following equation is used: tmp = xz[2*i] xz[2*i] = (c[0]*tmp - c[1]*xz[2*i + 1])*2**(-shift) xz[2*i + 1] = (c[1]*tmp + c[0]*xz[2*i + 1])*2**(-shift) where i = 0, 1, ..., (m*n - 1). The ranges of valid shift are: 1 <= shift <= 8 for U8, S8, U8C, S8C types 1 <= shift <= 16 for S16, S16C types 1 <= shift <= 31 for S32, S32C types
PARAMETERS
Each of the functions takes the following arguments: xz Pointer to the source and destination matrix. 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. m Number of rows in each matrix. n Number of columns in each matrix. shift Right shifting factor.
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
mlib_MatrixMulSShift_U8_U8_Mod(3MLIB), attributes(5) SunOS 5.11 2 Mar 2007 mlib_MatrixMulSShift_U8_Mod(3MLIB)