sum_matrixT_sum_matrixSumMatrixSumMatrix (Operator)

Name

sum_matrixT_sum_matrixSumMatrixSumMatrix — Returns the elementwise sum of a matrix.

Signature

sum_matrix( : : MatrixID, SumType : MatrixSumID)

Description

The operator sum_matrixsum_matrixSumMatrixSumMatrixSumMatrix returns the sum of the elements of the MatrixMatrixMatrixMatrixmatrix defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixSumMatrixSumMatrixSumMatrixSummatrixSum is generated with the result and the matrix handle MatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDmatrixSumID 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 sum determination of the matrix can be selected via the parameter SumTypeSumTypeSumTypeSumTypesumType:

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

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

Example:

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

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

Example:

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

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

Example:

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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (handle)

Matrix handle of the input matrix.

SumTypeSumTypeSumTypeSumTypesumType (input_control) string → (string)

Type of summation.

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"

MatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDmatrixSumID (output_control) matrix → (handle)

Matrix handle with the sum of the input matrix.

Result

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