sum_matrixsum_matrixSumMatrixsum_matrixSumMatrixSumMatrix (Operator)

Name

sum_matrixsum_matrixSumMatrixsum_matrixSumMatrixSumMatrix — Returns the elementwise sum of a matrix.

Signature

Description

The operator sum_matrixsum_matrixSumMatrixsum_matrixSumMatrixSumMatrix returns the sum of the elements of the MatrixMatrixMatrixMatrixMatrixmatrix defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixSumMatrixSumMatrixSumMatrixSumMatrixSummatrixSum is generated with the result and the matrix handle MatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDMatrixSumIDmatrixSumID of this matrix is returned. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix.

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

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

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

Example:

           /   8.0   4.0  -3.0  \
  Matrix = \  -6.0   2.0   7.0  /      SumType = 'columns'

  ->    MatrixSum = [  2.0   6.0   4.0  ]
  

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

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

Example:

           /   8.0   4.0  -3.0  \
  Matrix = \  -6.0   2.0   7.0  /      SumType = 'rows'

                    / 9.0 \
  ->    MatrixSum = \ 3.0 /
  

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

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

Example:

           /   8.0   4.0  -3.0  \
  Matrix = \  -6.0   2.0   7.0  /      SumType = 'full'

  ->   MatrixSum = [ 12.0 ]
  

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix

See also

norm_matrixnorm_matrixNormMatrixnorm_matrixNormMatrixNormMatrix

Module

Foundation