get_sub_matrixT_get_sub_matrixGetSubMatrixGetSubMatrixget_sub_matrix (Operator)

Name

get_sub_matrixT_get_sub_matrixGetSubMatrixGetSubMatrixget_sub_matrix — Get a sub-matrix of a matrix.

Signature

get_sub_matrix( : : MatrixID, Row, Column, RowsSub, ColumnsSub : MatrixSubID)

Description

The operator get_sub_matrixget_sub_matrixGetSubMatrixGetSubMatrixGetSubMatrixget_sub_matrix generates a new matrix MatrixSub and copies to this matrix a part of the input Matrix defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The part of the Matrix is determined by the upper left corner (RowRowRowRowrowrow,ColumnColumnColumnColumncolumncolumn) and the sub-matrix dimensions (RowsSubRowsSubRowsSubRowsSubrowsSubrows_sub, ColumnsSubColumnsSubColumnsSubColumnsSubcolumnsSubcolumns_sub). The operator returns the matrix handle MatrixSubIDMatrixSubIDMatrixSubIDMatrixSubIDmatrixSubIDmatrix_sub_id of the matrix MatrixSub. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix.

Example:

Attention

The conditions 0 <= RowRowRowRowrowrow < size of Matrix in row direction, RowRowRowRowrowrow + RowsSubRowsSubRowsSubRowsSubrowsSubrows_sub <= size of Matrix in the row direction, 0 <= ColumnColumnColumnColumncolumncolumn < size of Matrix in the column direction, and ColumnColumnColumnColumncolumncolumn + ColumnsSubColumnsSubColumnsSubColumnsSubcolumnsSubcolumns_sub <= size of matrix Matrix in the column direction must be satisfied.

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.

RowRowRowRowrowrow (input_control) integer → (integer)

Upper row position of the sub-matrix in the input matrix.

Default value: 0

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

Restriction: Row >= 0

ColumnColumnColumnColumncolumncolumn (input_control) integer → (integer)

Left column position of the sub-matrix in the input matrix.

Default value: 0

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

Restriction: Column >= 0

RowsSubRowsSubRowsSubRowsSubrowsSubrows_sub (input_control) integer → (integer)

Number of rows of the sub-matrix.

Default value: 1

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

Restriction: RowsSub >= 1

ColumnsSubColumnsSubColumnsSubColumnsSubcolumnsSubcolumns_sub (input_control) integer → (integer)

Number of columns of the sub-matrix.

Default value: 1

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

Restriction: ColumnsSub >= 1

MatrixSubIDMatrixSubIDMatrixSubIDMatrixSubIDmatrixSubIDmatrix_sub_id (output_control) matrix → (handle)

Matrix handle of the sub-matrix.

Result

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

Module

Foundation

Operators