sum_matrix — Returns the elementwise sum of a matrix.
sum_matrix( : : MatrixID, SumType : MatrixSumID)
The operator sum_matrix returns the sum of the elements of the Matrix defined by the matrix handle MatrixID. A new matrix MatrixSum is generated with the result and the matrix handle MatrixSumID of this matrix is returned. Access to the elements of the matrix is possible e.g. with the operator get_full_matrix.
The type of sum determination of the matrix can be selected via the parameter SumType:
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.
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.
The sum is returned using all elements of the Matrix. The resulting matrix MatrixSum has one row and one column.
Matrix handle of the input matrix.
Type of summation.
Default value: 'columns'
List of values: 'columns', 'full', 'rows'
Matrix handle with the sum of the input matrix.
If the parameters are valid, the operator sum_matrix returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.