Operator Reference
transpose_matrix_mod (Operator)
transpose_matrix_mod — Transpose a matrix.
Signature
transpose_matrix_mod( : : MatrixID : )
Description
The operator transpose_matrix_mod returns the transpose of
the input Matrix. The input matrix is defined by the
matrix handle MatrixID. The input matrix is overwritten
with the result. Access to the elements of the matrix is possible
e.g., with the operator get_full_matrix.
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.
This operator modifies the state of the following input parameter:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
MatrixID (input_control, state is modified) matrix → (handle)
Matrix handle of the input matrix.
Result
If the parameters are valid, the operator transpose_matrix_mod
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
invert_matrix,
invert_matrix_mod
References
David Poole: “Linear Algebra: A Modern Introduction”; Thomson;
Belmont; 2006.
Gene H. Golub, Charles F. van Loan: “Matrix Computations”; The
Johns Hopkins University Press; Baltimore and London; 1996.
Module
Foundation