max_matrixmax_matrixmax_matrixMaxMatrixMaxMatrix (Operator)

Name

max_matrixmax_matrixmax_matrixMaxMatrixMaxMatrix — Returns the elementwise maximum of a matrix.

Signature

Description

The operator max_matrixmax_matrixmax_matrixMaxMatrixMaxMatrix returns the maximum values of the elements of the MatrixMatrixMatrixMatrixmatrix defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixMaxMatrixMaxMatrixMaxMatrixMaxmatrixMax is generated with the result and the matrix handle MatrixMaxIDMatrixMaxIDMatrixMaxIDMatrixMaxIDmatrixMaxID of this matrix is returned. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixget_full_matrixGetFullMatrixGetFullMatrix.

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

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

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

Example:

           /   8.0   4.0  -3.0  \
  Matrix = \  -6.0   2.0   7.0  /      MaxType = 'columns'

  ->   MatrixMax = [  8.0   4.0   7.0  ]
  

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

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

Example:

           /   8.0   4.0  -3.0  \
  Matrix = \  -6.0   2.0   7.0  /      MaxType = 'rows'

                   / 8.0 \
  ->   MatrixMax = \ 7.0 /
  

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

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

Example:

           /   8.0   4.0  -3.0  \
  Matrix = \  -6.0   2.0   7.0  /      MaxType = 'full'

  ->   MatrixMax = [ 8.0 ]
  

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

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

Possible Predecessors

create_matrixcreate_matrixcreate_matrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixget_full_matrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixget_value_matrixGetValueMatrixGetValueMatrix

See also

min_matrixmin_matrixmin_matrixMinMatrixMinMatrix

Module

Foundation