Operators |
max_matrix — Returns the elementwise maximum of a matrix.
max_matrix( : : MatrixID, MaxType : MatrixMaxID)
The operator max_matrix returns the maximum values of the elements of the Matrix defined by the matrix handle MatrixID. A new matrix MatrixMax is generated with the result and the matrix handle MatrixMaxID of this matrix is returned. Access to the elements of the matrix is possible e.g. with the operator get_full_matrix.
The type of maximum determination of the matrix can be selected via the parameter MaxType:
The maximum is returned for each column of the Matrix separately. The resulting matrix MatrixMax has one row and the identical number of columns as the input matrix.
Example:
The maximum is returned for each row of the Matrix separately. The resulting matrix MatrixMax has the identical number of rows as the input matrix and one column.
Example:
The maximum is returned using all elements of the Matrix . The resulting matrix MatrixMax has one row and one column.
Example:
Matrix handle of the input matrix.
Type of maximum determination.
Default value: 'columns'
List of values: 'columns' , 'full' , 'rows'
Matrix handle with the maximum values of the input matrix.
If the parameters are valid, the operator max_matrix returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
get_full_matrix, get_value_matrix
Foundation
Operators |