man pages section 3: Multimedia Library Functions

Exit Print View

Updated: July 2014
 
 

mlib_VectorAdd_S16_Mod (3MLIB)

Name

mlib_VectorAdd_U8_Mod, mlib_VectorAdd_U8_Sat, mlib_VectorAdd_U8C_Mod, mlib_VectorAdd_U8C_Sat, mlib_VectorAdd_S8_Mod, mlib_VectorAdd_S8_Sat, mlib_VectorAdd_S8C_Mod, mlib_VectorAdd_S8C_Sat, mlib_VectorAdd_S16_Mod, mlib_VectorAdd_S16_Sat, mlib_VectorAdd_S16C_Mod, mlib_VectorAdd_S16C_Sat, mlib_VectorAdd_S32_Mod, mlib_VectorAdd_S32_Sat, mlib_VectorAdd_S32C_Mod, mlib_VectorAdd_S32C_Sat - vector addition, in place

Synopsis

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

mlib_status mlib_VectorAdd_U8_Mod(mlib_u8 *xz, 
     const mlib_u8 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_U8_Sat(mlib_u8 *xz, 
     const mlib_u8 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_U8C_Mod(mlib_u8 *xz, 
     const mlib_u8 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_U8C_Sat(mlib_u8 *xz, 
     const mlib_u8 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S8_Mod(mlib_s8 *xz, 
     const mlib_s8 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S8_Sat(mlib_s8 *xz, 
    const mlib_s8 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S8C_Mod(mlib_s8 *xz, 
     const mlib_s8 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S8C_Sat(mlib_s8 *xz, 
     const mlib_s8 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S16_Mod(mlib_s16 *xz, 
     const mlib_s16 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S16_Sat(mlib_s16 *xz, 
     const mlib_s16 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S16C_Mod(mlib_s16 *xz, 
     const mlib_s16 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S16C_Sat(mlib_s16 *xz, 
     const mlib_s16 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S32_Mod(mlib_s32 *xz, 
     const mlib_s32 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S32_Sat(mlib_s32 *xz, 
     const mlib_s32 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S32C_Mod(mlib_s32 *xz, 
     const mlib_s32 *y, mlib_s32 n);
mlib_status mlib_VectorAdd_S32C_Sat(mlib_s32 *xz, 
     const mlib_s32 *y, mlib_s32 n);

Description

Each of these functions performs the in-place addition of one vector to another vector.

It uses the following equation:

xz[i] = xz[i] + y[i]

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

Parameters

Each of the functions takes the following arguments:

xz

Pointer to the first element of the first source and destination vector.

y

Pointer to the first element of the second source vector.

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 TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe

See also

mlib_VectorAdd_U8_U8_Mod(3MLIB), attributes(5)