ClassesClassesClassesClasses | | | | Operators

copy_matrixcopy_matrixCopyMatrixcopy_matrixCopyMatrixCopyMatrix (Operator)

Name

copy_matrixcopy_matrixCopyMatrixcopy_matrixCopyMatrixCopyMatrix — Copy a matrix.

Signature

copy_matrix( : : MatrixID : MatrixCopyID)

Herror copy_matrix(const Hlong MatrixID, Hlong* MatrixCopyID)

Herror T_copy_matrix(const Htuple MatrixID, Htuple* MatrixCopyID)

Herror copy_matrix(const HTuple& MatrixID, Hlong* MatrixCopyID)

HMatrix HMatrix::CopyMatrix() const

void CopyMatrix(const HTuple& MatrixID, HTuple* MatrixCopyID)

HMatrix HMatrix::CopyMatrix() const

void HOperatorSetX.CopyMatrix(
[in] VARIANT MatrixID, [out] VARIANT* MatrixCopyID)

IHMatrixX* HMatrixX.CopyMatrix()

static void HOperatorSet.CopyMatrix(HTuple matrixID, out HTuple matrixCopyID)

HMatrix HMatrix.CopyMatrix()

Description

The operator copy_matrixcopy_matrixCopyMatrixcopy_matrixCopyMatrixCopyMatrix creates the new matrix MatrixCopyMatrixCopyMatrixCopyMatrixCopyMatrixCopymatrixCopy and copies all elements of the input MatrixMatrixMatrixMatrixMatrixmatrix to this new matrix. The input MatrixMatrixMatrixMatrixMatrixmatrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The operator returns the matrix handle MatrixCopyIDMatrixCopyIDMatrixCopyIDMatrixCopyIDMatrixCopyIDmatrixCopyID of the matrix MatrixCopyMatrixCopyMatrixCopyMatrixCopyMatrixCopymatrixCopy. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix. With this operator a matrix can be saved before the matrix is modified by the operators set_value_matrixset_value_matrixSetValueMatrixset_value_matrixSetValueMatrixSetValueMatrix, set_full_matrixset_full_matrixSetFullMatrixset_full_matrixSetFullMatrixSetFullMatrix, set_sub_matrixset_sub_matrixSetSubMatrixset_sub_matrixSetSubMatrixSetSubMatrix, or set_diagonal_matrixset_diagonal_matrixSetDiagonalMatrixset_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrix.

Example:

Parallelization

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control)  matrix HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle of the input matrix.

MatrixCopyIDMatrixCopyIDMatrixCopyIDMatrixCopyIDMatrixCopyIDmatrixCopyID (output_control)  matrix HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle of the copied matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix

Alternatives

repeat_matrixrepeat_matrixRepeatMatrixrepeat_matrixRepeatMatrixRepeatMatrix

Module

Foundation


ClassesClassesClassesClasses | | | | Operators