Operator Reference

transpose_matrixT_transpose_matrixTransposeMatrixTransposeMatrixtranspose_matrix (Operator)

transpose_matrixT_transpose_matrixTransposeMatrixTransposeMatrixtranspose_matrix — Transpose a matrix.

Signature

transpose_matrix( : : MatrixID : MatrixTransposedID)

Herror T_transpose_matrix(const Htuple MatrixID, Htuple* MatrixTransposedID)

void TransposeMatrix(const HTuple& MatrixID, HTuple* MatrixTransposedID)

HMatrix HMatrix::TransposeMatrix() const

static void HOperatorSet.TransposeMatrix(HTuple matrixID, out HTuple matrixTransposedID)

HMatrix HMatrix.TransposeMatrix()

def transpose_matrix(matrix_id: HHandle) -> HHandle

Description

The operator transpose_matrixtranspose_matrixTransposeMatrixTransposeMatrixtranspose_matrix returns the transpose of the input Matrix. The input matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. A new matrix MatrixTransposed is generated with the result and the matrix handle MatrixTransposedIDMatrixTransposedIDMatrixTransposedIDmatrixTransposedIDmatrix_transposed_id of this matrix is returned. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_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

MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

MatrixTransposedIDMatrixTransposedIDMatrixTransposedIDmatrixTransposedIDmatrix_transposed_id (output_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle with the transpose of the input matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

transpose_matrix_modtranspose_matrix_modTransposeMatrixModTransposeMatrixModtranspose_matrix_mod

See also

invert_matrixinvert_matrixInvertMatrixInvertMatrixinvert_matrix, invert_matrix_modinvert_matrix_modInvertMatrixModInvertMatrixModinvert_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