Content-type: text/html Man page of mlib_MatrixSub_U8_Mod

mlib_MatrixSub_U8_Mod

Section: mediaLib Library Functions (3MLIB)
Updated: 2 Mar 2007
Index Return to Main Contents
 

NAME

mlib_MatrixSub_U8_Mod, mlib_MatrixSub_U8_Sat, mlib_MatrixSub_U8C_Mod, mlib_MatrixSub_U8C_Sat, mlib_MatrixSub_S8_Mod, mlib_MatrixSub_S8_Sat, mlib_MatrixSub_S8C_Mod, mlib_MatrixSub_S8C_Sat, mlib_MatrixSub_S16_Mod, mlib_MatrixSub_S16_Sat, mlib_MatrixSub_S16C_Mod, mlib_MatrixSub_S16C_Sat, mlib_MatrixSub_S32_Mod, mlib_MatrixSub_S32_Sat, mlib_MatrixSub_S32C_Mod, mlib_MatrixSub_S32C_Sat - matrix subtraction, in place  

SYNOPSIS

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

mlib_status mlib_MatrixSub_U8_Mod(mlib_u8 *xz, 
   const mlib_u8 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_U8_Sat(mlib_u8 *xz, 
    const mlib_u8 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_U8C_Mod(mlib_u8 *xz, 
    const mlib_u8 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_U8C_Sat(mlib_u8 *xz, 
    const mlib_u8 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S8_Mod(mlib_s8 *xz, 
    const mlib_s8 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S8_Sat(mlib_s8 *xz, 
    const mlib_s8 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S8C_Mod(mlib_s8 *xz, 
    const mlib_s8 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S8C_Sat(mlib_s8 *xz, 
    const mlib_s8 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S16_Mod(mlib_s16 *xz, 
    const mlib_s16 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S16_Sat(mlib_s16 *xz, 
    const mlib_s16 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S16C_Mod(mlib_s16 *xz, 
    const mlib_s16 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S16C_Sat(mlib_s16 *xz, 
    const mlib_s16 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S32_Mod(mlib_s32 *xz, 
    const mlib_s32 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S32_Sat(mlib_s32 *xz, 
    const mlib_s32 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S32C_Mod(mlib_s32 *xz, 
    const mlib_s32 *y, mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixSub_S32C_Sat(mlib_s32 *xz, 
    const mlib_s32 *y, mlib_s32 m, mlib_s32 n);

 

DESCRIPTION

Each of these functions performs an in-place subtraction of the second matrix from the first matrix.

It uses the following equation:

xz[i] = xz[i] - y[i]

where i = 0, 1, ..., (m*n - 1) for real data; i = 0, 1, ..., (m*n*2 - 1) for complex data.  

PARAMETERS

Each of the functions takes the following arguments:

xz

Pointer to the first source and destination matrix.

y

Pointer to the second source matrix.

m

Number of rows in the matrices.

n

Number of columns in the matrices.

 

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 TYPEATTRIBUTE VALUE

Interface StabilityCommitted

MT-Level

 

SEE ALSO

mlib_MatrixSub_U8_U8_Mod(3MLIB), attributes(5)


 

Index

NAME
SYNOPSIS
DESCRIPTION
PARAMETERS
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:38:24 GMT, October 02, 2010