min_matrix — Returns the elementwise minimum of a matrix.
The operator min_matrix returns the minimum values of the elements of the Matrix defined by the matrix handle MatrixID. A new matrix MatrixMin is generated with the result and the matrix handle MatrixMinID 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 minimum determination of the matrix can be selected via the parameter MinType:
The minimum is returned for each column of the Matrix separately. The resulting matrix MatrixMin has one row and the identical number of columns as the input matrix.
/ 8.0 4.0 -3.0 \ Matrix = \ -6.0 2.0 7.0 / MinType = 'columns' -> MatrixMin = [ -6.0 2.0 -3.0 ]
The minimum is returned for each row of the Matrix separately. The resulting matrix MatrixMin has the identical number of rows as the input matrix and one column.
/ 8.0 4.0 -3.0 \ Matrix = \ -6.0 2.0 7.0 / MinType = 'rows' / -3.0 \ -> MatrixMin = \ -6.0 /
The minimum is returned using all elements of the Matrix. The resulting matrix MatrixMin has one row and one column.
/ 8.0 4.0 -3.0 \ Matrix = \ -6.0 2.0 7.0 / MinType = 'full' -> MatrixMin = [ -6.0 ]
Matrix handle of the input matrix.
Type of minimum determination.
Default value: 'columns'
List of values: 'columns', 'full', 'rows'
Matrix handle with the minimum values of the input matrix.
If the parameters are valid, the operator min_matrix returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.