Operator Reference
add_matrix (Operator)
add_matrix
— Add two matrices.
Signature
add_matrix( : : MatrixAID, MatrixBID : MatrixSumID)
Description
The operator add_matrix
computes the sum of the input
matrices MatrixA
and MatrixB
given by the matrix
handles MatrixAID
and MatrixBID
. Both matrices
must have identical dimensions. A new matrix
MatrixSum
is generated with the result. The operator
returns the matrix handle MatrixSumID
of the matrix
MatrixSum
. Access to the elements of the matrix is
possible e.g., with the operator get_full_matrix
. The
formula for the calculation of the result is:
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
MatrixAID
(input_control) matrix →
(handle)
Matrix handle of the input matrix A.
MatrixBID
(input_control) matrix →
(handle)
Matrix handle of the input matrix B.
MatrixSumID
(output_control) matrix →
(handle)
Matrix handle with the sum of the input matrices.
Result
If the parameters are valid, the operator add_matrix
returns
the value 2 (
H_MSG_TRUE)
. If necessary, an exception is raised.
Possible Predecessors
Possible Successors
get_full_matrix
,
get_value_matrix
Alternatives
See also
Module
Foundation