mlib_VectorNorm_S8_Sat (3MLIB)

Name

mlib_VectorNorm_U8_Sat, mlib_VectorNorm_S8_Sat, mlib_VectorNorm_S16_Sat, mlib_VectorNorm_S32_Sat - vector norm

Synopsis

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

mlib_status mlib_VectorNorm_U8_Sat(mlib_d64 *z, const mlib_u8 *x,
     mlib_s32 n);

mlib_status mlib_VectorNorm_S8_Sat(mlib_d64 *z, const mlib_s8 *x,
     mlib_s32 n);

mlib_status mlib_VectorNorm_S16_Sat(mlib_d64 *z, const mlib_s16 *x,
     mlib_s32 n);

mlib_status mlib_VectorNorm_S32_Sat(mlib_d64 *z, const mlib_s32 *x,
     mlib_s32 n);

Description

Each of these functions computes the vector normal.

The following equation is used:

         n-1
z[0] = ( SUM x[i]**2 )**0.5
         i=0

Parameters

Each of the functions takes the following arguments:

z

Pointer to the norm of the vector.

x

Pointer to the first element of the 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

attributes(5)