Operator Reference

transpose_matrix_modT_transpose_matrix_modTransposeMatrixModTransposeMatrixModtranspose_matrix_mod (Operator)

transpose_matrix_modT_transpose_matrix_modTransposeMatrixModTransposeMatrixModtranspose_matrix_mod — Transpose a matrix.

Signature

transpose_matrix_mod( : : MatrixID : )

Herror T_transpose_matrix_mod(const Htuple MatrixID)

void TransposeMatrixMod(const HTuple& MatrixID)

void HMatrix::TransposeMatrixMod() const

static void HOperatorSet.TransposeMatrixMod(HTuple matrixID)

void HMatrix.TransposeMatrixMod()

def transpose_matrix_mod(matrix_id: HHandle) -> None

Description

The operator transpose_matrix_modtranspose_matrix_modTransposeMatrixModTransposeMatrixModtranspose_matrix_mod returns the transpose of the input Matrix. The input matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The input matrix is overwritten with the result. 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.

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

MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control, state is modified)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

Result

If the parameters are valid, the operator transpose_matrix_modtranspose_matrix_modTransposeMatrixModTransposeMatrixModtranspose_matrix_mod 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_matrixtranspose_matrixTransposeMatrixTransposeMatrixtranspose_matrix

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