min_matrixT_min_matrixMinMatrixMinMatrixmin_matrix (Operator)


min_matrixT_min_matrixMinMatrixMinMatrixmin_matrix — Returns the elementwise minimum of a matrix.


min_matrix( : : MatrixID, MinType : MatrixMinID)

Herror T_min_matrix(const Htuple MatrixID, const Htuple MinType, Htuple* MatrixMinID)

void MinMatrix(const HTuple& MatrixID, const HTuple& MinType, HTuple* MatrixMinID)

HMatrix HMatrix::MinMatrix(const HString& MinType) const

HMatrix HMatrix::MinMatrix(const char* MinType) const

HMatrix HMatrix::MinMatrix(const wchar_t* MinType) const   (Windows only)

static void HOperatorSet.MinMatrix(HTuple matrixID, HTuple minType, out HTuple matrixMinID)

HMatrix HMatrix.MinMatrix(string minType)

def min_matrix(matrix_id: HHandle, min_type: str) -> HHandle


The operator min_matrixmin_matrixMinMatrixMinMatrixMinMatrixmin_matrix returns the minimum values of the elements of the Matrix defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. A new matrix MatrixMin is generated with the result and the matrix handle MatrixMinIDMatrixMinIDMatrixMinIDMatrixMinIDmatrixMinIDmatrix_min_id of this matrix is returned. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix.

The type of minimum determination of the matrix can be selected via the parameter MinTypeMinTypeMinTypeMinTypeminTypemin_type:


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.


MinTypeMinTypeMinTypeMinTypeminTypemin_type = 'columns'"columns""columns""columns""columns""columns"


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.


MinTypeMinTypeMinTypeMinTypeminTypemin_type = 'rows'"rows""rows""rows""rows""rows" / -3.0 \ -> MatrixMin = \ -6.0 / \[ \to \qquad \texttt{MatrixMin} = \left[ \begin{array}{r} -3.0
-6.0 \end{array} \right] \]


The minimum is returned using all elements of the Matrix. The resulting matrix MatrixMin has one row and one column.


MinTypeMinTypeMinTypeMinTypeminTypemin_type = 'full'"full""full""full""full""full"

Execution Information


MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

MinTypeMinTypeMinTypeMinTypeminTypemin_type (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Type of minimum 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"

MatrixMinIDMatrixMinIDMatrixMinIDMatrixMinIDmatrixMinIDmatrix_min_id (output_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle with the minimum values of the input matrix.


If the parameters are valid, the operator min_matrixmin_matrixMinMatrixMinMatrixMinMatrixmin_matrix returns the value TRUE. If necessary, an exception is raised.

Possible Predecessors


Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

See also