man pages section 3: Multimedia Library Functions

Exit Print View

Updated: July 2014
 
 

mlib_VectorMaximumMag_F32C(3MLIB)

Name

mlib_VectorMaximumMag_U8C, mlib_VectorMaximumMag_S8C, mlib_VectorMaximumMag_S16C, mlib_VectorMaximumMag_S32C, mlib_VectorMaximumMag_F32C, mlib_VectorMaximumMag_D64C - find the first element with the maximum magnitude in a vector

Synopsis

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

mlib_status mlib_VectorMaximumMag_U8C(mlib_u8 *max, 
     const mlib_u8 *x, mlib_s32 n);
mlib_status mlib_VectorMaximumMag_S8C(mlib_s8 *max, 
     const mlib_s8 *x, mlib_s32 n);
mlib_status mlib_VectorMaximumMag_S16C(mlib_s16 *max,
      const mlib_s16 *x, mlib_s32 n);
mlib_status mlib_VectorMaximumMag_S32C(mlib_s32 *max,
      const mlib_s32 *x, mlib_s32 n);
mlib_status mlib_VectorMaximumMag_F32C(mlib_f32 *max,
      const mlib_f32 *x, mlib_s32 n);
mlib_status mlib_VectorMaximumMag_D64C(mlib_d64 *max,
      const mlib_d64 *x, mlib_s32 n);

Description

Each of these functions finds the first element with the maximum magnitude in a complex vector, then puts the real and imaginary parts of it into max[0] and max[1], respectively.

Parameters

Each of the functions takes the following arguments:

max

Pointer to the first element with the maximum magnitude.

x

Pointer to the first element of the source vector.

n

Number of elements in the source vector.

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_VectorMinimumMag_U8C(3MLIB), mlib_MatrixMaximumMag_U8C(3MLIB), mlib_MatrixMinimumMag_U8C(3MLIB), attributes(5)