transpose_matrix_modT_transpose_matrix_modTransposeMatrixModTransposeMatrixMod (Operator)

Name

transpose_matrix_modT_transpose_matrix_modTransposeMatrixModTransposeMatrixMod — 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()

Description

The operator transpose_matrix_modtranspose_matrix_modTransposeMatrixModTransposeMatrixModTransposeMatrixMod returns the transpose of the input MatrixMatrixMatrixMatrixmatrix. The input matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. 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_matrixGetFullMatrixGetFullMatrixGetFullMatrix.

Example:

Execution Information

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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control, state is modified)  matrix HMatrix, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

Result

If the parameters are valid, the operator transpose_matrix_modtranspose_matrix_modTransposeMatrixModTransposeMatrixModTransposeMatrixMod 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_matrixtranspose_matrixTransposeMatrixTransposeMatrixTransposeMatrix

See also

invert_matrixinvert_matrixInvertMatrixInvertMatrixInvertMatrix, invert_matrix_modinvert_matrix_modInvertMatrixModInvertMatrixModInvertMatrixMod

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