repeat_matrixT_repeat_matrixRepeatMatrixRepeatMatrixrepeat_matrix (Operator)

Name

repeat_matrixT_repeat_matrixRepeatMatrixRepeatMatrixrepeat_matrix — Repeat a matrix.

Signature

repeat_matrix( : : MatrixID, Rows, Columns : MatrixRepeatedID)

Herror T_repeat_matrix(const Htuple MatrixID, const Htuple Rows, const Htuple Columns, Htuple* MatrixRepeatedID)

void RepeatMatrix(const HTuple& MatrixID, const HTuple& Rows, const HTuple& Columns, HTuple* MatrixRepeatedID)

HMatrix HMatrix::RepeatMatrix(Hlong Rows, Hlong Columns) const

static void HOperatorSet.RepeatMatrix(HTuple matrixID, HTuple rows, HTuple columns, out HTuple matrixRepeatedID)

HMatrix HMatrix.RepeatMatrix(int rows, int columns)

def repeat_matrix(matrix_id: HHandle, rows: int, columns: int) -> HHandle

Description

The operator repeat_matrixrepeat_matrixRepeatMatrixRepeatMatrixRepeatMatrixrepeat_matrix creates the new matrix MatrixRepeated and copies all elements of the input Matrix n times to this new matrix, where n = RowsRowsRowsRowsrowsrows ColumnsColumnsColumnsColumnscolumnscolumns. The new matrix has dimensions RowsRowsRowsRowsrowsrows rows of the input Matrix and ColumnsColumnsColumnsColumnscolumnscolumns columns of the input Matrix. The input Matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The operator returns the matrix handle MatrixRepeatedIDMatrixRepeatedIDMatrixRepeatedIDMatrixRepeatedIDmatrixRepeatedIDmatrix_repeated_id of the matrix MatrixRepeated. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix.

Example:

RowsRowsRowsRowsrowsrows = 2, ColumnsColumnsColumnsColumnscolumnscolumns = 3

Execution Information

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

RowsRowsRowsRowsrowsrows (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of copies of input matrix in row direction.

Default value: 2

Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20

Restriction: Rows >= 1

ColumnsColumnsColumnsColumnscolumnscolumns (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of copies of input matrix in column direction.

Default value: 2

Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20

Restriction: Columns >= 1

MatrixRepeatedIDMatrixRepeatedIDMatrixRepeatedIDMatrixRepeatedIDmatrixRepeatedIDmatrix_repeated_id (output_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the repeated copied matrix.

Result

If the parameters are valid, the operator repeat_matrixrepeat_matrixRepeatMatrixRepeatMatrixRepeatMatrixrepeat_matrix returns the value 2 (H_MSG_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

See also

copy_matrixcopy_matrixCopyMatrixCopyMatrixCopyMatrixcopy_matrix

Module

Foundation