Skip to content

max_matrixMaxMatrixMaxMatrixmax_matrixT_max_matrix🔗

Short description🔗

max_matrixMaxMatrixMaxMatrixmax_matrixT_max_matrix — Returns the elementwise maximum of a matrix.

Signature🔗

max_matrix( matrix MatrixID, string MaxType, out matrix MatrixMaxID )void MaxMatrix( const HTuple& MatrixID, const HTuple& MaxType, HTuple* MatrixMaxID )static void HOperatorSet.MaxMatrix( HTuple matrixID, HTuple maxType, out HTuple matrixMaxID )def max_matrix( matrix_id: HHandle, max_type: str ) -> HHandle

Herror T_max_matrix( const Htuple MatrixID, const Htuple MaxType, Htuple* MatrixMaxID )

HMatrix HMatrix::MaxMatrix( const HString& MaxType ) const

HMatrix HMatrix::MaxMatrix( const char* MaxType ) const

HMatrix HMatrix::MaxMatrix( const wchar_t* MaxType ) const (Windows only)

HMatrix HMatrix.MaxMatrix( string maxType )

Description🔗

The operator max_matrixMaxMatrix returns the maximum values of the elements of the Matrix defined by the matrix handle MatrixIDmatrixIDmatrix_id. A new matrix MatrixMax is generated with the result and the matrix handle MatrixMaxIDmatrixMaxIDmatrix_max_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 maximum determination of the matrix can be selected via the parameter MaxTypemaxTypemax_type:

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

    MaxTypemaxTypemax_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{MatrixMax} = \left[ \begin{array}{rrr} 8.0 & 4.0 & 7.0 \\ \end{array} \right] \end{eqnarray*}\]

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

    MaxTypemaxTypemax_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*}\]
    \[\begin{eqnarray*} \to \qquad \texttt{MatrixMax} = \left[ \begin{array}{r} 8.0 \\ 7.0 \end{array} \right] \end{eqnarray*}\]

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

    Example:

    MaxTypemaxTypemax_type = 'full'"full"

    \[\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{MatrixMax} = \left[ \begin{array}{r} 8.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.

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

Type of maximum determination.

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

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

Matrix handle with the maximum values of the input matrix.

Result🔗

If the parameters are valid, the operator max_matrixMaxMatrix 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

min_matrixMinMatrix

Module🔗

Foundation