min_matrixT_min_matrixMinMatrixMinMatrix (Operator)

Name

min_matrixT_min_matrixMinMatrixMinMatrix — Returns the elementwise minimum of a matrix.

Signature

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)

Description

The operator min_matrixmin_matrixMinMatrixMinMatrixMinMatrix returns the minimum values of the elements of the MatrixMatrixMatrixMatrixmatrix defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixMinMatrixMinMatrixMinMatrixMinmatrixMin is generated with the result and the matrix handle MatrixMinIDMatrixMinIDMatrixMinIDMatrixMinIDmatrixMinID of this matrix is returned. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix.

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

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

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

Example:

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

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

Example:

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

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

Example:

Execution Information

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control)  matrix HMatrix, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

MinTypeMinTypeMinTypeMinTypeminType (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Type of minimum determination.

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

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

MatrixMinIDMatrixMinIDMatrixMinIDMatrixMinIDmatrixMinID (output_control)  matrix HMatrix, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle with the minimum values of the input matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrix

See also

max_matrixmax_matrixMaxMatrixMaxMatrixMaxMatrix

Module

Foundation