Submatrix
Select subset of elements (submatrix) from matrix input
- Library:
DSP System Toolbox / Signal Management / Indexing
DSP System Toolbox / Math Functions / Matrices and Linear Algebra / Matrix Operations
Description
The Submatrix block extracts a contiguous submatrix, y,
from the M-by-N input matrix u.
For more information about selecting the rows and columns to extract, see Range Specification Options.
Ports
Input
Port_1 — Input signal
vector | matrix
Input signal, from which the block extracts the specified submatrix.
This block supports Simulink® virtual buses.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | Boolean | fixed point | enumerated
Output
Port_1 — Selected submatrix
vector | matrix
Submatrix selected from the input signal. The data type of the output is the same as the input.
This block supports Simulink virtual buses.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | Boolean | fixed point | enumerated
Parameters
For more information about selecting the subset of elements to form the submatrix, see Range Specification Options.
Row span — Range of rows
All rows (default) | One row | Range of rows
The range of input rows to be retained in the output.
Row — First row of output
First (default) | Index | Offset from last | Last | Offset from middle | Middle
The input row to be used as the first and only row of the output.
Dependencies
To enable this parameter, set Row span to
One row.
Starting row — First row of output
First (default) | Index | Offset from last | Last | Offset from middle | Middle
The input row to be used as the first row of the output.
Dependencies
To enable this parameter, set Row span to
Range of rows.
Row index — Index of first row
1 (default) | positive integer
The index of the input row to be used as the first and only row of the output, specified as an integer greater than or equal to one.
Dependencies
To enable this parameter, set Row span to
One row and Row to
Index.
Starting row index — Index of first row
1 (default) | positive integer
The index of the input row to be used as the first row of the output, specified as an integer greater than or equal to one.
Dependencies
To enable this parameter, set Row span to
Range of rows and Starting
row to Index.
Row offset — Offset of first row
1 (default) | positive integer
The offset of the input row to be used as the first and only row of the output, specified as an integer greater than or equal to one.
Dependencies
To enable this parameter, set Row span to
One row and Row to
Offset from last or Offset
from middle.
Starting row offset — Offset of first row
1 (default) | positive integer
The offset of the input row to be used as the first row of the output, specified as an integer greater than or equal to one.
Dependencies
To enable this parameter, set Row span to
Range of rows and Starting
row to Offset from last or
Offset from middle.
Ending row — Last row
Last (default) | Index | Offset from last | Offset from middle | Middle
The input row to be used as the last row of the output.
Dependencies
To enable this parameter, set Row span to
Range of rows and set Starting
row to any value except
Last.
Ending row index — Index of last row
1 (default) | positive integer
The index of the input row to be used as the last row of the output, specified as an integer greater than or equal to one.
Dependencies
To enable this parameter, set Ending row to
Index.
Ending row offset — Offset of last row
1 (default) | positive integer
The offset of the input row to be used as the last row of the output.
Dependencies
To enable this parameter, set Ending row to
Offset from middle or Offset
from last.
Column span — Range of input columns
All columns (default) | One column | Range of columns
The range of input columns to be retained in the output.
Column — First column
First (default) | Index | Offset from last | Last | Offset from middle | Middle
The input column to be used as the first and only column of the output.
Dependencies
To enable this parameter, set Column span to
One column.
Starting column — First column
First (default) | Index | Offset from last | Last | Offset from middle | Middle
The input column to be used as the first column of the output.
Dependencies
To enable this parameter, set Column span to
Range of columns.
Starting column index — Index of first column
1 (default) | positive integer
The index of the input column to be used as the first column of the output, specified as an integer greater than or equal to one.
Dependencies
To enable this parameter, set Column span to
Range of columns and Starting
column to Index.
Column index — Index of first column
1 (default) | positive integer
The index of the input column to be used as the first and only column of the output, specified as an integer greater than or equal to one.
Dependencies
To enable this parameter, set Column span to
One column and
Column to
Index.
Column offset — Offset of first column
1 (default) | positive integer
The offset of the input column to be used as the first and only column of the output, specified as an integer greater than or equal to one.
Dependencies
To enable this parameter, set Column span to
One column and
Column to Offset from
last or Offset from
middle.
Starting column offset — Offset of first column
1 (default) | positive integer
The offset of the input column to be used as the first column of the output, specified as an integer greater than or equal to one.
Dependencies
To enable this parameter, set Column span to
Range of columns and Starting
column to Offset from last or
Offset from middle.
Ending column — Last column
Last (default) | Index | Offset from last | Offset from middle | Middle
The input column to be used as the last column of the output.
Dependencies
To enable this parameter, set Column span to
Range of columns and set
Starting column to any value except
Last.
Ending column index — Index of last column
1 (default) | positive integer
The index of the input column to be used as the last column of the output, specified as an integer greater than or equal to one.
Dependencies
To enable this parameter, set Ending column to
Index.
Ending column offset — Offset of last column
1 (default) | positive integer
The offset of the input column to be used as the last column of the output.
Dependencies
To enable this parameter, set Ending column to
Offset from middle or Offset
from last.
Block Characteristics
Data Types |
|
Direct Feedthrough |
|
Multidimensional Signals |
|
Variable-Size Signals |
|
Zero-Crossing Detection |
|
More About
Range Specification Options
The block treats length-M unoriented vector input as an
M-by-1 matrix. The Row
span parameter provides three options for specifying the range of
rows in u to be retained in submatrix output
y:
All rowsSpecifies that
ycontains all M rows ofu.One rowSpecifies that
ycontains only one row fromu. SelectingOne rowenables the Row parameter to allow selection of the desired row.Range of rowsSpecifies that
ycontains a range of rows fromu. SelectingRange of rowsenables the Starting row and Ending row parameters to allow selection of the desired range of rows.
The Column span parameter contains a corresponding set of
three options for specifying the range of columns in u to be
retained in submatrix y: All columns,
One column, or Range of
columns. The One column option enables
the Column parameter, and Range of
columns options enable the Starting column
and Ending column parameters.
When you select One row or Range of
rows from the Row span parameter, you specify
the desired row or range of rows in the Row parameter, or the
Starting row and Ending row
parameters. Similarly, when you select One column or
Range of columns from the Column
span parameter, you specify the desired column or range of columns in
the Column parameter, or the Starting
column and Ending column parameters.
The Row, Column, Starting row, or Starting column can be specified in six ways:
FirstFor rows, this specifies that the first row of
ushould be used as the first row ofy. When all columns are to be included, this is equivalent toy(1,:) = u(1,:).For columns, this specifies that the first column of
ushould be used as the first column ofy. When all rows are to be included, this is equivalent toy(:,1) = u(:,1).IndexFor rows, this specifies that the row of
u,firstrow, forward-indexed by the Row index parameter or the Starting row index parameter, should be used as the first row ofy. When all columns are to be included, this is equivalent toy(1,:) = u(firstrow,:).For columns, this specifies that the column of
u, forward-indexed by the Column index parameter or the Starting column index parameter,firstcol, should be used as the first column ofy. When all rows are to be included, this is equivalent toy(:,1) = u(:,firstcol).Offset from lastFor rows, this specifies that the row of
uoffset from row M by the Row offset or Starting row offset parameter,firstrow, should be used as the first row ofy. When all columns are to be included, this is equivalent toy(1,:) = u(M-firstrow,:).For columns, this specifies that the column of
uoffset from column N by the Column offset or Starting column offset parameter,firstcol, should be used as the first column ofy. When all rows are to be included, this is equivalent toy(:,1) = u(:,N-firstcol).LastFor rows, this specifies that the last row of
ushould be used as the only row ofy. When all columns are to be included, this is equivalent toy = u(M,:).For columns, this specifies that the last column of
ushould be used as the only column ofy. When all rows are to be included, this is equivalent toy = u(:,N).Offset from middleWhen you select this option, the block selects the first row or column of the output
yby adding the specified offset to the middle row or column of the inputu. When the number, X, of input rows or columns is even, the block defines the middle as X/2 +1. When the number of input rows or columns is odd, the block defines the middle asceil(X/2).When all columns are to be included, the following code defines the starting row:
y(1,:) = u(MiddleRow+Offset,:), whereOffsetis the value of the Row offset or Starting row offset parameter. When all rows are to be included, the following code defines the starting column:y(1,:) = u(:,MiddleColumn+Offset), whereOffsetis the value of the Column offset or Starting column offset parameter.MiddleWhen you select this option, the block uses the middle row or column of the input
uas the first row or column of the outputy. When the number, X, of input rows or columns is even, the block defines the middle as X/2 +1. When the number of input rows or columns is odd, the block defines the middle asceil(X/2).When all columns are to be included, the following code defines the starting row:
y = u(MiddleRow,:). When all rows are to be included, the following code defines the starting column:y = u(:,MiddleColumn).
The Ending row or Ending column can similarly be specified in five ways:
IndexFor rows, this specifies that the row of
uforward-indexed by the Ending row index parameter,lastrow, should be used as the last row ofy. When all columns are to be included, this is equivalent toy(end,:) = u(lastrow,:).For columns, this specifies that the column of
uforward-indexed by the Ending column index parameter,lastcol, should be used as the last column ofy. When all rows are to be included, this is equivalent toy(:,end) = u(:,lastcol).Offset from lastFor rows, this specifies that the row of
uoffset from row M by the Ending row offset parameter,lastrow, should be used as the last row ofy. When all columns are to be included, this is equivalent toy(end,:) = u(M-lastrow,:).For columns, this specifies that the column of
uoffset from column N by the Ending column offset parameter,lastcol, should be used as the last column ofy. When all rows are to be included, this is equivalent toy(:,end) = u(:,N-lastcol).LastFor rows, this specifies that the last row of
ushould be used as the last row ofy. When all columns are to be included, this is equivalent toy(end,:) = u(M,:).For columns, this specifies that the last column of
ushould be used as the last column ofy. When all rows are to be included, this is equivalent toy(:,end) = u(:,N).Offset from middleWhen you select this option, the block selects the last row or column of the output
yby adding the specified offset to the middle row or column of the inputu. When the number, X, of input rows or columns is even, the block defines the middle as X/2 +1. When the number of input rows or columns is odd, the block defines the middle asceil(X/2).When all columns are to be included, the following code defines the ending row:
y(end,:) = u(MiddleRow+Offset,:), whereOffsetis the value of the Ending row offset parameter. When all rows are to be included, the following code defines the ending column:y(:,end) = u(:,MiddleColumn+Offset), whereOffsetis the value of the Ending column offset parameter.MiddleWhen you select this option, the block uses the middle row or column of the input
uas the last row or column of the outputy. When the number, X, of input rows or columns is even, the block defines the middle as X/2 +1. When the number of input rows or columns is odd, the block defines the middle asceil(X/2).When all columns are to be included, the following code defines the ending row:
y(end,:) = u(MiddleRow,:). When all rows are to be included, the following code defines the ending column:y(:,end) = u(:,MiddleColumn).
Extended Capabilities
C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.
Generated code relies on memcpy or
memset functions (string.h) under certain
conditions.