Content-type: text/html Man page of mlib_MatrixMaximumMag_U8C

mlib_MatrixMaximumMag_U8C

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

NAME

mlib_MatrixMaximumMag_U8C, mlib_MatrixMaximumMag_S8C, mlib_MatrixMaximumMag_S16C, mlib_MatrixMaximumMag_S32C, mlib_MatrixMaximumMag_F32C, mlib_MatrixMaximumMag_D64C - find the first element with the maximum magnitude in a matrix  

SYNOPSIS

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

mlib_status mlib_MatrixMaximumMag_U8C(mlib_u8 *max, const mlib_u8 *x,
    mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixMaximumMag_S8C(mlib_s8 *max, const mlib_s8 *x,
    mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixMaximumMag_S16C(mlib_s16 *max, const mlib_s16 *x,
    mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixMaximumMag_S32C(mlib_s32 *max, const mlib_s32 *x,
    mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixMaximumMag_F32C(mlib_f32 *max, const mlib_f32 *x,
    mlib_s32 m, mlib_s32 n);

mlib_status mlib_MatrixMaximumMag_D64C(mlib_d64 *max, const mlib_d64 *x,
    mlib_s32 m, mlib_s32 n);

 

DESCRIPTION

Each of these functions finds the first element with the maximum magnitude in a complex matrix, 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 matrix.

m

Number of rows in the source matrix

n

Number of columns in the source matrix

 

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_MatrixMinimumMag_U8C(3MLIB), mlib_VectorMaximumMag_U8C(3MLIB), mlib_VectorMinimumMag_U8C(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:14 GMT, October 02, 2010