Operator Reference
transpose_matrix (Operator)
transpose_matrix
— Transpose a matrix.
Signature
transpose_matrix( : : MatrixID : MatrixTransposedID)
Description
The operator transpose_matrix
returns the transpose of the
input Matrix
. The input matrix is defined by the matrix
handle MatrixID
. A new matrix MatrixTransposed
is generated with the result and the matrix handle
MatrixTransposedID
of this matrix is returned. 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.
Parameters
MatrixID
(input_control) matrix →
(handle)
Matrix handle of the input matrix.
MatrixTransposedID
(output_control) matrix →
(handle)
Matrix handle with the transpose of the input matrix.
Result
If the parameters are valid, the operator transpose_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
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