copy_matrixT_copy_matrixCopyMatrixCopyMatrixcopy_matrix (Operator)

Name

copy_matrixT_copy_matrixCopyMatrixCopyMatrixcopy_matrix — Copy a matrix.

Signature

copy_matrix( : : MatrixID : MatrixCopyID)

Description

The operator copy_matrixcopy_matrixCopyMatrixCopyMatrixCopyMatrixcopy_matrix creates the new matrix MatrixCopyMatrixCopyMatrixCopyMatrixCopymatrixCopymatrix_copy and copies all elements of the input MatrixMatrixMatrixMatrixmatrixmatrix to this new matrix. The input MatrixMatrixMatrixMatrixmatrixmatrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The operator returns the matrix handle MatrixCopyIDMatrixCopyIDMatrixCopyIDMatrixCopyIDmatrixCopyIDmatrix_copy_id of the matrix MatrixCopyMatrixCopyMatrixCopyMatrixCopymatrixCopymatrix_copy. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix. With this operator a matrix can be saved before the matrix is modified by the operators set_value_matrixset_value_matrixSetValueMatrixSetValueMatrixSetValueMatrixset_value_matrix, set_full_matrixset_full_matrixSetFullMatrixSetFullMatrixSetFullMatrixset_full_matrix, set_sub_matrixset_sub_matrixSetSubMatrixSetSubMatrixSetSubMatrixset_sub_matrix, or set_diagonal_matrixset_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixSetDiagonalMatrixset_diagonal_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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)

Matrix handle of the input matrix.

MatrixCopyIDMatrixCopyIDMatrixCopyIDMatrixCopyIDmatrixCopyIDmatrix_copy_id (output_control) matrix → (handle)

Matrix handle of the copied matrix.

Result

If the parameters are valid, the operator copy_matrixcopy_matrixCopyMatrixCopyMatrixCopyMatrixcopy_matrix returns the value TRUE. If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

repeat_matrixrepeat_matrixRepeatMatrixRepeatMatrixRepeatMatrixrepeat_matrix

Module

Foundation

Operators