opensolaris man page for mlib_matrixmaximum_u8

mlib_MatrixMaximum_U8(3MLIB)				    mediaLib Library Functions				      mlib_MatrixMaximum_U8(3MLIB)

NAME
       mlib_MatrixMaximum_U8,  mlib_MatrixMaximum_S8,  mlib_MatrixMaximum_S16,	mlib_MatrixMaximum_S32,  mlib_MatrixMaximum_F32,  mlib_MatrixMaxi-
       mum_D64 - find the maximum value in a matrix

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

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

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

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

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

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

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

DESCRIPTION
       Each of these functions finds the maximum value of all elements in a matrix.

       It uses the following equation:

	 max[0] = MAX{ x[i]  i = 0, 1, ..., (m*n - 1) }

PARAMETERS
       Each of the functions takes the following arguments:

       max    Pointer to the maximum value.

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

SEE ALSO
       mlib_MatrixMinimum_U8(3MLIB), mlib_VectorMaximum_U8(3MLIB), mlib_VectorMinimum_U8(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					      mlib_MatrixMaximum_U8(3MLIB)