Skip to content

mean_matrixMeanMatrixMeanMatrixmean_matrixT_mean_matrix🔗

Short description🔗

mean_matrixMeanMatrixMeanMatrixmean_matrixT_mean_matrix — Returns the elementwise mean of a matrix.

Signature🔗

mean_matrix( matrix MatrixID, string MeanType, out matrix MatrixMeanID )void MeanMatrix( const HTuple& MatrixID, const HTuple& MeanType, HTuple* MatrixMeanID )static void HOperatorSet.MeanMatrix( HTuple matrixID, HTuple meanType, out HTuple matrixMeanID )def mean_matrix( matrix_id: HHandle, mean_type: str ) -> HHandle

Herror T_mean_matrix( const Htuple MatrixID, const Htuple MeanType, Htuple* MatrixMeanID )

HMatrix HMatrix::MeanMatrix( const HString& MeanType ) const

HMatrix HMatrix::MeanMatrix( const char* MeanType ) const

HMatrix HMatrix::MeanMatrix( const wchar_t* MeanType ) const (Windows only)

HMatrix HMatrix.MeanMatrix( string meanType )

Description🔗

The operator mean_matrixMeanMatrix returns the mean values of the elements of the Matrix defined by the matrix handle MatrixIDmatrixIDmatrix_id. A new matrix MatrixMean is generated with the result and the matrix handle MatrixMeanIDmatrixMeanIDmatrix_mean_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 mean determination of the matrix can be selected via the parameter MeanTypemeanTypemean_type:

  • 'columns'"columns": The mean is returned for each column of the Matrix separately. The resulting matrix MatrixMean has one row and the identical number of columns as the input matrix.

    Example:

    MeanTypemeanTypemean_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{MatrixMean} = \left[ \begin{array}{rrr} 1.0 & 3.0 & 2.0 \\ \end{array} \right] \end{eqnarray*}\]

  • 'rows'"rows": The mean is returned for each row of the Matrix separately. The resulting matrix MatrixMean has the identical number of rows as the input matrix and one column.

    Example:

    MeanTypemeanTypemean_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{MatrixMean} = \left[ \begin{array}{r} 3.0 \\ 1.0 \end{array} \right] \end{eqnarray*}\]

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

    Example:

    MeanTypemeanTypemean_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{MatrixMean} = \left[ \begin{array}{r} 2.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.

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

Type of mean determination.

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

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

Matrix handle with the mean values of the input matrix.

Result🔗

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

norm_matrixNormMatrix, sum_matrixSumMatrix

Module🔗

Foundation