'\" te .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved .TH mlib_MatrixMulSShift_U8_U8_Mod 3MLIB "2 Mar 2007" "SunOS 5.11" "mediaLib Library Functions" .SH NAME mlib_MatrixMulSShift_U8_U8_Mod, mlib_MatrixMulSShift_U8_U8_Sat, mlib_MatrixMulSShift_U8C_U8C_Mod, mlib_MatrixMulSShift_U8C_U8C_Sat, mlib_MatrixMulSShift_S8_S8_Mod, mlib_MatrixMulSShift_S8_S8_Sat, mlib_MatrixMulSShift_S8C_S8C_Mod, mlib_MatrixMulSShift_S8C_S8C_Sat, mlib_MatrixMulSShift_S16_S16_Mod, mlib_MatrixMulSShift_S16_S16_Sat, mlib_MatrixMulSShift_S16C_S16C_Mod, mlib_MatrixMulSShift_S16C_S16C_Sat, mlib_MatrixMulSShift_S32_S32_Mod, mlib_MatrixMulSShift_S32_S32_Sat, mlib_MatrixMulSShift_S32C_S32C_Mod, mlib_MatrixMulSShift_S32C_S32C_Sat \- matrix multiplication by scalar plus shifting .SH SYNOPSIS .LP .nf cc [ \fIflag\fR... ] \fIfile\fR... \fB-lmlib\fR [ \fIlibrary\fR... ] #include \fBmlib_status\fR \fBmlib_MatrixMulSShift_U8_U8_Mod\fR(\fBmlib_u8 *\fR\fIz\fR, \fBconst mlib_u8 *\fR\fIx\fR, \fBconst mlib_u8 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_U8_U8_Sat\fR(\fBmlib_u8 *\fR\fIz\fR, \fBconst mlib_u8 *\fR\fIx\fR, \fBconst mlib_u8 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_U8C_U8C_Mod\fR(\fBmlib_u8 *\fR\fIz\fR, \fBconst mlib_u8 *\fR\fIx\fR, \fBconst mlib_u8 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_U8C_U8C_Sat\fR(\fBmlib_u8 *\fR\fIz\fR, \fBconst mlib_u8 *\fR\fIx\fR, \fBconst mlib_u8 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S8_S8_Mod\fR(\fBmlib_s8 *\fR\fIz\fR, \fBconst mlib_s8 *\fR\fIx\fR, \fBconst mlib_s8 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S8_S8_Sat\fR(\fBmlib_s8 *\fR\fIz\fR, \fBconst mlib_s8 *\fR\fIx\fR, \fBconst mlib_s8 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S8C_S8C_Mod\fR(\fBmlib_s8 *\fR\fIz\fR, \fBconst mlib_s8 *\fR\fIx\fR, \fBconst mlib_s8 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S8C_S8C_Sat\fR(\fBmlib_s8 *\fR\fIz\fR, \fBconst mlib_s8 *\fR\fIx\fR, \fBconst mlib_s8 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S16_S16_Mod\fR(\fBmlib_s16 *\fR\fIz\fR, \fBconst mlib_s16 *\fR\fIx\fR, \fBconst mlib_s16 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S16_S16_Sat\fR(\fBmlib_s16 *\fR\fIz\fR, \fBconst mlib_s16 *\fR\fIx\fR, \fBconst mlib_s16 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S16C_S16C_Mod\fR(\fBmlib_s16 *\fR\fIz\fR, \fBconst mlib_s16 *\fR\fIx\fR, \fBconst mlib_s16 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S16C_S16C_Sat\fR(\fBmlib_s16 *\fR\fIz\fR, \fBconst mlib_s16 *\fR\fIx\fR, \fBconst mlib_s16 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S32_S32_Mod\fR(\fBmlib_s32 *\fR\fIz\fR, \fBconst mlib_s32 *\fR\fIx\fR, \fBconst mlib_s32 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S32_S32_Sat\fR(\fBmlib_s32 *\fR\fIz\fR, \fBconst mlib_s32 *\fR\fIx\fR, \fBconst mlib_s32 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S32C_S32C_Mod\fR(\fBmlib_s32 *\fR\fIz\fR, \fBconst mlib_s32 *\fR\fIx\fR, \fBconst mlib_s32 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .LP .nf \fBmlib_status\fR \fBmlib_MatrixMulSShift_S32C_S32C_Sat\fR(\fBmlib_s32 *\fR\fIz\fR, \fBconst mlib_s32 *\fR\fIx\fR, \fBconst mlib_s32 *\fR\fIc\fR, \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR, \fBmlib_s32\fR \fIshift\fR); .fi .SH DESCRIPTION .sp .LP Each of these functions performs a multiplication of a matrix with a scalar and shifts the result. .sp .LP For real data, the following equation is used: .sp .in +2 .nf z[i] = c[0]*x[i]*2**(-shift) .fi .in -2 .sp .LP where \fBi = 0, 1, ..., (m*n - 1)\fR. .sp .LP For complex data, the following equation is used: .sp .in +2 .nf z[2*i] = (c[0]*x[2*i] - c[1]*x[2*i + 1])*2**(-shift) z[2*i + 1] = (c[1]*x[2*i] + c[0]*x[2*i + 1])*2**(-shift) .fi .in -2 .sp .LP where \fBi = 0, 1, ..., (m*n - 1)\fR. .sp .LP The ranges of valid \fBshift\fR are: .sp .in +2 .nf 1 \(<= shift \(<= 8 for U8, S8, U8C, S8C types 1 \(<= shift \(<= 16 for S16, S16C types 1 \(<= shift \(<= 31 for S32, S32C types .fi .in -2 .SH PARAMETERS .sp .LP Each of the functions takes the following arguments: .sp .ne 2 .mk .na \fB\fIz\fR\fR .ad .RS 9n .rt Pointer to the destination matrix. .RE .sp .ne 2 .mk .na \fB\fIx\fR\fR .ad .RS 9n .rt Pointer to the source matrix. .RE .sp .ne 2 .mk .na \fB\fIc\fR\fR .ad .RS 9n .rt Pointer to the source scalar. When the function is used with complex data types, \fBc[0]\fR contains the scalar for the real part, and \fBc[1]\fR contains the scalar for the imaginary part. .RE .sp .ne 2 .mk .na \fB\fIm\fR\fR .ad .RS 9n .rt Number of rows in each matrix. .RE .sp .ne 2 .mk .na \fB\fIn\fR\fR .ad .RS 9n .rt Number of columns in each matrix. .RE .sp .ne 2 .mk .na \fB\fIshift\fR\fR .ad .RS 9n .rt Right shifting factor. .RE .SH RETURN VALUES .sp .LP Each of the functions returns \fBMLIB_SUCCESS\fR if successful. Otherwise it returns \fBMLIB_FAILURE\fR. .SH ATTRIBUTES .sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp .sp .TS tab() box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) . ATTRIBUTE TYPEATTRIBUTE VALUE _ Interface StabilityCommitted _ MT-LevelMT-Safe .TE .SH SEE ALSO .sp .LP \fBmlib_MatrixMulSShift_U8_Mod\fR(3MLIB), \fBattributes\fR(5)