ClassesClassesClassesClasses | | | | Operators

max_matrixmax_matrixMaxMatrixmax_matrixMaxMatrixMaxMatrix (Operator)

Name

max_matrixmax_matrixMaxMatrixmax_matrixMaxMatrixMaxMatrix — Returns the elementwise maximum of a matrix.

Signature

max_matrix( : : MatrixID, MaxType : MatrixMaxID)

Herror max_matrix(const Hlong MatrixID, const char* MaxType, Hlong* MatrixMaxID)

Herror T_max_matrix(const Htuple MatrixID, const Htuple MaxType, Htuple* MatrixMaxID)

Herror max_matrix(const HTuple& MatrixID, const HTuple& MaxType, Hlong* MatrixMaxID)

HMatrix HMatrix::MaxMatrix(const HTuple& MaxType) const

void MaxMatrix(const HTuple& MatrixID, const HTuple& MaxType, HTuple* MatrixMaxID)

HMatrix HMatrix::MaxMatrix(const HString& MaxType) const

HMatrix HMatrix::MaxMatrix(const char* MaxType) const

void HOperatorSetX.MaxMatrix(
[in] VARIANT MatrixID, [in] VARIANT MaxType, [out] VARIANT* MatrixMaxID)

IHMatrixX* HMatrixX.MaxMatrix([in] BSTR MaxType)

static void HOperatorSet.MaxMatrix(HTuple matrixID, HTuple maxType, out HTuple matrixMaxID)

HMatrix HMatrix.MaxMatrix(string maxType)

Description

The operator max_matrixmax_matrixMaxMatrixmax_matrixMaxMatrixMaxMatrix returns the maximum values of the elements of the MatrixMatrixMatrixMatrixMatrixmatrix defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixMaxMatrixMaxMatrixMaxMatrixMaxMatrixMaxmatrixMax is generated with the result and the matrix handle MatrixMaxIDMatrixMaxIDMatrixMaxIDMatrixMaxIDMatrixMaxIDmatrixMaxID of this matrix is returned. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix.

The type of maximum determination of the matrix can be selected via the parameter MaxTypeMaxTypeMaxTypeMaxTypeMaxTypemaxType:

'columns'"columns""columns""columns""columns""columns":

The maximum is returned for each column of the MatrixMatrixMatrixMatrixMatrixmatrix separately. The resulting matrix MatrixMaxMatrixMaxMatrixMaxMatrixMaxMatrixMaxmatrixMax has one row and the identical number of columns as the input matrix.

Example:

'rows'"rows""rows""rows""rows""rows":

The maximum is returned for each row of the MatrixMatrixMatrixMatrixMatrixmatrix separately. The resulting matrix MatrixMaxMatrixMaxMatrixMaxMatrixMaxMatrixMaxmatrixMax has the identical number of rows as the input matrix and one column.

Example:

'full'"full""full""full""full""full":

The maximum is returned using all elements of the MatrixMatrixMatrixMatrixMatrixmatrix. The resulting matrix MatrixMaxMatrixMaxMatrixMaxMatrixMaxMatrixMaxmatrixMax has one row and one column.

Example:

Parallelization

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control)  matrix HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle of the input matrix.

MaxTypeMaxTypeMaxTypeMaxTypeMaxTypemaxType (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Type of maximum determination.

Default value: 'columns' "columns" "columns" "columns" "columns" "columns"

List of values: 'columns'"columns""columns""columns""columns""columns", 'full'"full""full""full""full""full", 'rows'"rows""rows""rows""rows""rows"

MatrixMaxIDMatrixMaxIDMatrixMaxIDMatrixMaxIDMatrixMaxIDmatrixMaxID (output_control)  matrix HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle with the maximum values of the input matrix.

Result

If the parameters are valid, the operator max_matrixmax_matrixMaxMatrixmax_matrixMaxMatrixMaxMatrix returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix

See also

min_matrixmin_matrixMinMatrixmin_matrixMinMatrixMinMatrix

Module

Foundation


ClassesClassesClassesClasses | | | | Operators