Get Submatrix Function

Owning Palette: Matrix Functions

Requires: Base Development System

Returns a submatrix of matrix starting at (row 1, column 1) and ending at (row N, column N).

To retrieve elements that are not next to each other in matrix, use the Get Matrix Elements function.

The connector pane displays the default data types for this polymorphic function.

Details  

Add to the block diagram

Find on the palette

	matrix must be a 2D array of any numeric type or a real or complex matrix.
	row 1 must be an integer or real numeric. row 1 specifies the first row in matrix you want to appear in the output. The default is 0.
	row N must be an integer or real numeric. row N specifies the last row in matrix you want to appear in the output. The default is the index of the last row in matrix.
	column 1 must be an integer or real numeric. column 1 specifies the first column in matrix you want to appear in the output. The default is 0.
	column N must be an integer or real numeric. column N specifies the last column in matrix you want to appear in the output. The default is the index of the last column in matrix.
	submatrix is a matrix that contains the submatrix. If matrix is an empty matrix or array, submatrix returns matrix.

Get Submatrix Details

If you wire a matrix to matrix, submatrix returns a matrix with the same numeric type as matrix. If you wire a 2D array to matrix, submatrix returns a 2D array with the same numeric type as matrix.

If you wire matrix but you do not wire the other inputs, submatrix returns matrix. If you do not wire inputs to row 1 and column 1, submatrix starts with the first element of matrix. If you do not wire inputs to row N and column N, submatrix ends with the last element of matrix.

Wiring Empty Input Values

If row N is less than row 1 or if column N is less than column 1, submatrix returns an empty matrix or array with 0 for the row or column dimensions where appropriate.

Indexing Outside Input Values

If you wire a negative value to any of the row or column indexes, submatrix returns each row and column element outside matrix with an invalid operation value at each exterior location.

If you wire a value to row N or column N that is greater than or equal to the row or column dimensions of matrix, submatrix returns each row and column element outside matrix with an invalid operation value at each exterior location.