transpose_matrixtranspose_matrixTransposeMatrixTransposeMatrix (Operator)

Name

transpose_matrixtranspose_matrixTransposeMatrixTransposeMatrix — Transpose a matrix.

Signature

transpose_matrix( : : MatrixID : MatrixTransposedID)

The operator transpose_matrixtranspose_matrixTransposeMatrixTransposeMatrixTransposeMatrix returns the transpose of the input MatrixMatrixMatrixMatrixmatrix. The input matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixTransposedMatrixTransposedMatrixTransposedMatrixTransposedmatrixTransposed is generated with the result and the matrix handle MatrixTransposedIDMatrixTransposedIDMatrixTransposedIDMatrixTransposedIDmatrixTransposedID of this matrix is returned. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix.

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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (integer)

Matrix handle of the input matrix.

MatrixTransposedIDMatrixTransposedIDMatrixTransposedIDMatrixTransposedIDmatrixTransposedID (output_control) matrix → (integer)

Matrix handle with the transpose of the input matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrix

Alternatives

transpose_matrix_modtranspose_matrix_modTransposeMatrixModTransposeMatrixModTransposeMatrixMod

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

Operators