Content-type: text/html Man page of mlib_VectorScale_U8_Mod

mlib_VectorScale_U8_Mod

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

NAME

mlib_VectorScale_U8_Mod, mlib_VectorScale_U8_Sat, mlib_VectorScale_U8C_Mod, mlib_VectorScale_U8C_Sat, mlib_VectorScale_S8_Mod, mlib_VectorScale_S8_Sat, mlib_VectorScale_S8C_Mod, mlib_VectorScale_S8C_Sat, mlib_VectorScale_S16_Mod, mlib_VectorScale_S16_Sat, mlib_VectorScale_S16C_Mod, mlib_VectorScale_S16C_Sat, mlib_VectorScale_S32_Mod, mlib_VectorScale_S32_Sat, mlib_VectorScale_S32C_Mod, mlib_VectorScale_S32C_Sat - vector linear scaling, in place  

SYNOPSIS

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

mlib_status mlib_VectorScale_U8_Mod(mlib_u8 *xz, 
    const mlib_u8 *a, const mlib_u8 *b, mlib_s32 n);

mlib_status mlib_VectorScale_U8_Sat(mlib_u8 *xz, 
    const mlib_u8 *a, const mlib_u8 *b, mlib_s32 n);

mlib_status mlib_VectorScale_U8C_Mod(mlib_u8 *xz, 
    const mlib_u8 *a, const mlib_u8 *b, mlib_s32 n);

mlib_status mlib_VectorScale_U8C_Sat(mlib_u8 *xz, 
    const mlib_u8 *a, const mlib_u8 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S8_Mod(mlib_s8 *xz, 
    const mlib_s8 *a, const mlib_s8 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S8_Sat(mlib_s8 *xz, 
    const mlib_s8 *a, const mlib_s8 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S8C_Mod(mlib_s8 *xz, 
    const mlib_s8 *a, const mlib_s8 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S8C_Sat(mlib_s8 *xz, 
    const mlib_s8 *a, const mlib_s8 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S16_Mod(mlib_s16 *xz, 
    const mlib_s16 *a, const mlib_s16 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S16_Sat(mlib_s16 *xz, 
    const mlib_s16 *a, const mlib_s16 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S16C_Mod(mlib_s16 *xz, 
    const mlib_s16 *a, const mlib_s16 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S16C_Sat(mlib_s16 *xz, 
    const mlib_s16 *a, const mlib_s16 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S32_Mod(mlib_s32 *xz, 
    const mlib_s32 *a, const mlib_s32 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S32_Sat(mlib_s32 *xz, 
    const mlib_s32 *a, const mlib_s32 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S32C_Mod(mlib_s32 *xz, 
    const mlib_s32 *a, const mlib_s32 *b, mlib_s32 n);

mlib_status mlib_VectorScale_S32C_Sat(mlib_s32 *xz, 
    const mlib_s32 *a, const mlib_s32 *b, mlib_s32 n);

 

DESCRIPTION

Each of these functions performs an in-place scaling of a vector by multiplying by a scalar and adding an offset.

For real data, the following equation is used:

xz[i] = a[0]*xz[i] + b[0]

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

For complex data, the following equation is used:

tmp         = xz[2*i]
xz[2*i]     = a[0]*tmp - a[1]*xz[2*i + 1] + b[0]
xz[2*i + 1] = a[1]*tmp + a[0]*xz[2*i + 1] + b[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.

a

Pointer to the source scaling factor. When the function is used with complex data types, a[0] contains the real part of the scaling factor, and a[1] contains the imaginary part of the scaling factor.

b

Pointer to the source offset. When the function is used with complex data types, b[0] contains the real part of the offset, and b[1] contains the imaginary part of the offset.

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

Interface StabilityCommitted

MT-Level

 

SEE ALSO

mlib_VectorScale_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:16 GMT, October 02, 2010