Skip to content

min_matrixMinMatrixMinMatrixmin_matrixT_min_matrix🔗

Short description🔗

min_matrixMinMatrixMinMatrixmin_matrixT_min_matrix — Returns the elementwise minimum of a matrix.

Signature🔗

min_matrix( matrix MatrixID, string MinType, out matrix MatrixMinID )void MinMatrix( const HTuple& MatrixID, const HTuple& MinType, HTuple* MatrixMinID )static void HOperatorSet.MinMatrix( HTuple matrixID, HTuple minType, out HTuple matrixMinID )def min_matrix( matrix_id: HHandle, min_type: str ) -> HHandle

Herror T_min_matrix( 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)

HMatrix HMatrix.MinMatrix( string minType )

Description🔗

The operator min_matrixMinMatrix returns the minimum values of the elements of the Matrix defined by the matrix handle MatrixIDmatrixIDmatrix_id. A new matrix MatrixMin is generated with the result and the matrix handle MatrixMinIDmatrixMinIDmatrix_min_id of this matrix is returned. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixGetFullMatrix.

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

  • 'columns'"columns": 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.

    Example:

    MinTypeminTypemin_type = 'columns'"columns"

    \[\begin{eqnarray*} \texttt{Matrix} = \left[ \begin{array}{rrr} 8.0 & 4.0 & -3.0 \\ -6.0 & 2.0 & 7.0 \end{array} \right] \end{eqnarray*}\]
    \[\begin{eqnarray*} \to \qquad \texttt{MatrixMin} = \left[ \begin{array}{rrr} -6.0 & 2.0 & -3.0 \\ \end{array} \right] \end{eqnarray*}\]

  • 'rows'"rows": 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.

    Example:

    MinTypeminTypemin_type = 'rows'"rows"

    \[\begin{eqnarray*} \texttt{Matrix} = \left[ \begin{array}{rrr} 8.0 & 4.0 & -3.0 \\ -6.0 & 2.0 & 7.0 \end{array} \right] \end{eqnarray*}\]

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

  • 'full'"full": The minimum is returned using all elements of the Matrix. The resulting matrix MatrixMin has one row and one column.

    Example:

    MinTypeminTypemin_type = 'full'"full"

    \[\begin{eqnarray*} \texttt{MatrixA} = \left[ \begin{array}{rrr} 8.0 & 4.0 & -3.0 \\ -6.0 & 2.0 & 7.0 \end{array} \right] \end{eqnarray*}\]
    \[\begin{eqnarray*} \to \qquad \texttt{MatrixMin} = \left[ \begin{array}{r} -6.0 \\ \end{array} \right] \end{eqnarray*}\]

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

MatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)

Matrix handle of the input matrix.

MinTypeminTypemin_type (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Type of minimum determination.

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

MatrixMinIDmatrixMinIDmatrix_min_id (output_control) matrix → (handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)

Matrix handle with the minimum values of the input matrix.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_matrixCreateMatrix

Possible successors

get_full_matrixGetFullMatrix, get_value_matrixGetValueMatrix

See also

max_matrixMaxMatrix

Module🔗

Foundation