sum_matrixT_sum_matrixSumMatrixSumMatrixsum_matrix (Operator)

Name

sum_matrixT_sum_matrixSumMatrixSumMatrixsum_matrix — Returns the elementwise sum of a matrix.

Signature

sum_matrix( : : MatrixID, SumType : MatrixSumID)

Description

The operator sum_matrixsum_matrixSumMatrixSumMatrixSumMatrixsum_matrix returns the sum of the elements of the Matrix defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. A new matrix MatrixSum is generated with the result and the matrix handle MatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDmatrixSumIDmatrix_sum_id of this matrix is returned. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix.

The type of sum determination of the matrix can be selected via the parameter SumTypeSumTypeSumTypeSumTypesumTypesum_type:

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

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

Example:

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

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

Example:

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

The sum is returned using all elements of the Matrix. The resulting matrix MatrixSum 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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)

Matrix handle of the input matrix.

SumTypeSumTypeSumTypeSumTypesumTypesum_type (input_control) string → (string)

Type of summation.

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

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

MatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDmatrixSumIDmatrix_sum_id (output_control) matrix → (handle)

Matrix handle with the sum of the input matrix.

Result

If the parameters are valid, the operator sum_matrixsum_matrixSumMatrixSumMatrixSumMatrixsum_matrix returns the value TRUE. If necessary, an exception is raised.