copy_matrixT_copy_matrixCopyMatrixCopyMatrix (Operator)

Name

copy_matrixT_copy_matrixCopyMatrixCopyMatrix — Copy a matrix.

Signature

Description

The operator copy_matrixcopy_matrixCopyMatrixCopyMatrixCopyMatrix creates the new matrix MatrixCopyMatrixCopyMatrixCopyMatrixCopymatrixCopy and copies all elements of the input MatrixMatrixMatrixMatrixmatrix to this new matrix. The input MatrixMatrixMatrixMatrixmatrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The operator returns the matrix handle MatrixCopyIDMatrixCopyIDMatrixCopyIDMatrixCopyIDmatrixCopyID of the matrix MatrixCopyMatrixCopyMatrixCopyMatrixCopymatrixCopy. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix. With this operator a matrix can be saved before the matrix is modified by the operators set_value_matrixset_value_matrixSetValueMatrixSetValueMatrixSetValueMatrix, set_full_matrixset_full_matrixSetFullMatrixSetFullMatrixSetFullMatrix, set_sub_matrixset_sub_matrixSetSubMatrixSetSubMatrixSetSubMatrix, or set_diagonal_matrixset_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixSetDiagonalMatrix.

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

Result

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

repeat_matrixrepeat_matrixRepeatMatrixRepeatMatrixRepeatMatrix

Module

Foundation