Content-type: text/html Man page of mlib_VectorAddS_U8_Mod

mlib_VectorAddS_U8_Mod

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

NAME

mlib_VectorAddS_U8_Mod, mlib_VectorAddS_U8_Sat, mlib_VectorAddS_U8C_Mod, mlib_VectorAddS_U8C_Sat, mlib_VectorAddS_S8_Mod, mlib_VectorAddS_S8_Sat, mlib_VectorAddS_S8C_Mod, mlib_VectorAddS_S8C_Sat, mlib_VectorAddS_S16_Mod, mlib_VectorAddS_S16_Sat, mlib_VectorAddS_S16C_Mod, mlib_VectorAddS_S16C_Sat, mlib_VectorAddS_S32_Mod, mlib_VectorAddS_S32_Sat, mlib_VectorAddS_S32C_Mod, mlib_VectorAddS_S32C_Sat - vector addition to scalar, in place  

SYNOPSIS

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

DESCRIPTION

Each of these functions performs an in-place addition of a scalar to a vector.

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

Interface StabilityCommitted

MT-Level

 

SEE ALSO

mlib_VectorAddS_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