Current File : //usr/share/man/man3mlib/mlib_MatrixMaximumMag_U8C.3mlib

'\" te
.\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved 
.TH mlib_MatrixMaximumMag_U8C 3MLIB "2 Mar 2007" "SunOS 5.11" "mediaLib Library Functions"
.SH 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
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lmlib\fR [ \fIlibrary\fR... ]
#include <mlib.h>

\fBmlib_status\fR \fBmlib_MatrixMaximumMag_U8C\fR(\fBmlib_u8 *\fR\fImax\fR, \fBconst mlib_u8 *\fR\fIx\fR,
     \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_MatrixMaximumMag_S8C\fR(\fBmlib_s8 *\fR\fImax\fR, \fBconst mlib_s8 *\fR\fIx\fR,
     \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_MatrixMaximumMag_S16C\fR(\fBmlib_s16 *\fR\fImax\fR, \fBconst mlib_s16 *\fR\fIx\fR,
     \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_MatrixMaximumMag_S32C\fR(\fBmlib_s32 *\fR\fImax\fR, \fBconst mlib_s32 *\fR\fIx\fR,
     \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_MatrixMaximumMag_F32C\fR(\fBmlib_f32 *\fR\fImax\fR, \fBconst mlib_f32 *\fR\fIx\fR,
     \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_MatrixMaximumMag_D64C\fR(\fBmlib_d64 *\fR\fImax\fR, \fBconst mlib_d64 *\fR\fIx\fR,
     \fBmlib_s32\fR \fIm\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.SH DESCRIPTION
.sp
.LP
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 \fBmax[0]\fR and \fBmax[1]\fR, respectively.
.SH PARAMETERS
.sp
.LP
Each of the functions takes the following arguments:
.sp
.ne 2
.mk
.na
\fB\fImax\fR\fR
.ad
.RS 7n
.rt  
Pointer to the first element with the maximum magnitude
.RE

.sp
.ne 2
.mk
.na
\fB\fIx\fR\fR
.ad
.RS 7n
.rt  
Pointer to the first element of the source matrix.
.RE

.sp
.ne 2
.mk
.na
\fB\fIm\fR\fR
.ad
.RS 7n
.rt  
Number of rows in the source matrix
.RE

.sp
.ne 2
.mk
.na
\fB\fIn\fR\fR
.ad
.RS 7n
.rt  
Number of columns in the source matrix
.RE

.SH RETURN VALUES
.sp
.LP
Each of the functions returns \fBMLIB_SUCCESS\fR if successful. Otherwise it returns \fBMLIB_FAILURE\fR.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBmlib_MatrixMinimumMag_U8C\fR(3MLIB), \fBmlib_VectorMaximumMag_U8C\fR(3MLIB), \fBmlib_VectorMinimumMag_U8C\fR(3MLIB), \fBattributes\fR(5)