Документация Engee

Submatrix

Выбор подмножества элементов (подматрицы) из входной матрицы.

submatrix

Описание

Блок Submatrix извлекает из входной матрицы u размером M на N подматрицу y.

Подробнее о выборе строк и столбцов для извлечения см. в разделе Параметры задания диапазона.

Порты

Вход

Port_1 — входная матрица
скаляр | вектор | матрица

Исходная матрица.

Типы данных: Float16, Float32, Float64, Int8, Int16, Int32, Int64, Int128, UInt8, UInt16, UInt32, UInt64, UInt128, Fixed, Bool

Поддержка комплексных чисел: Да

Выход

Port_1 — подматрица
матрица

Подматрица, извлеченная из входного сигнала. Тип данных на выходе такой же, как и на входе.

Типы данных: Float16, Float32, Float64, Int8, Int16, Int32, Int64, Int128, UInt8, UInt16, UInt32, UInt64, UInt128, Fixed, Bool

Поддержка комплексных чисел: Да

Параметры

Row span — диапазон строк
All rows (по умолчанию) | One row | Range of rows

Диапазон входных строк, который будет сохранен в выходной матрице.

Row — первая (единственная) строка выходной подматрицы
First (по умолчанию) | Index | Offset from last | Last | Offset from middle | Middle

Входная строка, которая будет использоваться в качестве первой и единственной строки выходной подматрицы.

Зависимости

Чтобы использовать этот параметр, установите для параметра Row span значение One row.

Starting row — первая строка выходной подматрицы
First (по умолчанию) | Index | Offset from last | Last | Offset from middle | Middle

Метод задания строки в исходной матрице, которая будет использоваться в качестве первой строки выходной подматрицы.

Зависимости

Чтобы использовать этот параметр, установите для параметра Row span значение Range of rows.

Row index — индекс первой (единственной) строки
1 (по умолчанию) | целое положительное число

Индекс входной строки, которая будет использоваться в качестве первой и единственной строки выходной подматрицы, задается в виде целого числа, большего или равного единице.

Зависимости

Чтобы использовать этот параметр, установите для параметра Row span значение One row и для параметра RowIndex.

Starting row index — индекс первой строки
1 (по умолчанию) | целое положительное число

Индекс входной строки, которая будет использоваться в качестве первой строки выходной подматрицы, задается в виде целого числа, большего или равного единице.

Зависимости

Чтобы использовать этот параметр, установите для параметра Row span значение Range of rows и для параметра Starting rowIndex.

Row offset — смещение первой (единственной) строки
1 (по умолчанию) | целое число

Смещение входной строки, которая будет использоваться в качестве первой и единственной строки выходной подматрицы, задается в виде целого числа. Знак числа определяет направление смещения.

Зависимости

Чтобы использовать этот параметр, установите для параметра Row span значение One row и для параметра Row значение Offset from last или Offset from middle.

Starting row offset — смещение первой строки
1 (по умолчанию) | целое число

Смещение входной строки, которая будет использоваться в качестве первой строки выходной подматрицы, задается в виде целого числа. Знак числа определяет направление смещения.

Зависимости

Чтобы использовать этот параметр, установите для параметра Row span значение Range of rows и для параметра Starting rowOffset from last или Offset from middle.

Ending row — последняя строка выходной подматрицы
Last (по умолчанию) | Index | Offset from last | Offset from middle | Middle

Метод задания строки в исходной матрице, которая будет использоваться в качестве последней строки выходной подматрицы.

Зависимости

Чтобы использовать этот параметр, установите для параметра Row span значение Range of rows и для параметра Starting row любое значение, кроме Last.

Ending row index — индекс последней строки
1 (по умолчанию) | целое положительное число

Индекс входной строки, которая будет использоваться в качестве последней строки выходной подматрицы, задается в виде целого числа, большего или равного единице.

Зависимости

Чтобы использовать этот параметр, установите Ending row в значение Index.

Ending row offset — смещение последней строки
1 (по умолчанию) | целое число

Смещение входной строки, которая будет использоваться в качестве последней строки выходной подматрицы, задается в виде целого числа. Знак числа определяет направление смещения.

Зависимости

Чтобы использовать этот параметр, установите для параметра Ending row значение Offset from middle или Offset from last.

Column span — диапазон входных столбцов
All columns (по умолчанию) | One column | Range of columns

Диапазон входных столбцов, который будет сохранен в выходной матрице.

Column — первый (единственный) столбец
First (по умолчанию) | Index | Offset from last | Last | Offset from middle | Middle

Входной столбец, который будет использоваться в качестве первого и единственного столбца выходной подматрицы.

Зависимости

Чтобы использовать этот параметр, установите для параметра Column span значение One column.

Starting column — первый столбец выходной подматрицы
First (по умолчанию) | Index | Offset from last | Last | Offset from middle | Middle

Метод задания столбца в исходной матрице, который будет использоваться в качестве первого столбца выходной подматрицы.

Зависимости

Чтобы использовать этот параметр, установите для параметра Column span значение Range of columns.

Starting column index — индекс первого столбца
1 (по умолчанию) | целое положительное число

Индекс входного столбца, который будет использоваться в качестве первого столбца выходной подматрицы, заданный в виде целого числа, большего или равного единице.

Зависимости

Чтобы использовать этот параметр, установите для параметра Column span значение Range of columns, а для параметра Starting column — значение Index.

Column index — индекс первого (единственного) столбца
1 (по умолчанию) | целое положительное число

Индекс входного столбца, который будет использоваться в качестве первого и единственного столбца выходной подматрицы, задается в виде целого числа, большего или равного единице.

Зависимости

Чтобы использовать этот параметр, установите для параметра Column span значение One column и для параметра Column — значение Index.

Column offset — смещение первого (единственного) столбца
1 (по умолчанию) | целое число

Смещение входного столбца, который будет использоваться в качестве первого и единственного столбца выходной подматрицы, задается в виде целого числа. Знак числа определяет направление смещения.

Зависимости

Чтобы использовать этот параметр, установите для параметра Column span значение One column и для параметра Column значение Offset from last или Offset from middle.

Starting column offset — смещение первого столбца
1 (по умолчанию) | целое число

Смещение входного столбца, который будет использоваться в качестве первого столбца выходной подматрицы, задается в виде целого числа. Знак числа определяет направление смещения.

Зависимости

Чтобы использовать этот параметр, установите для параметра Column span значение Range of columns, а для параметра Starting column — значение Offset from last или Offset from middle.

Ending column — последний столбец
Last (по умолчанию) | Index | Offset from last | Offset from middle | Middle

Метод задания столбца в исходной матрице, который будет использоваться в качестве последнего столбца выходной подматрицы.

Зависимости

Чтобы использовать этот параметр, установите для параметра Column span значение Range of columns и установите для параметра Starting column любое значение, кроме Last.

Ending column index — индекс последнего столбца
1 (по умолчанию) | целое положительное число

Индекс входного столбца, который будет использоваться в качестве последнего столбца выходной подматрицы, задается в виде целого числа, большего или равного единице.

Зависимости

Чтобы использовать этот параметр, установите для параметра Ending column значение Index.

Ending column offset — смещение последнего столбца
1 (по умолчанию) | целое число

Смещение входного столбца, который будет использоваться в качестве последнего столбца выходной подматрицы, задается в виде целого числа. Знак числа определяет направление смещения.

Зависимости

Чтобы использовать этот параметр, установите для параметра Ending column значение Offset from middle или Offset from last.

Подробнее

Параметры задания диапазона

Блок принимает входной неориентированный вектор длины M как матрицу M на 1. Параметр Row span предоставляет три варианта задания диапазона строк во входной матрице u, которые должны быть сохранены в выходной подматрице y:

  • All rows — указывает, что выходная подматрица y содержит все M строк входной матрицы u.

  • One row — указывает, что выходная подматрица y содержит только одну строку из входной матрицы u. При выборе значения One row становится доступен к использованию параметр Row, позволяющий выбрать нужную строку.

  • Range of rows — указывает, что выходная подматрица y содержит диапазон строк из входной матрицы u. При выборе значения Range of rows становятся доступны для использования параметры Starting row и Ending row которые позволяют выбрать нужный диапазон строк.

Параметр Column span содержит соответствующий набор из трех вариантов для указания диапазона столбцов во входной матрице u, которые должны быть сохранены в выходной подматрице y: All columns, One column, или Range of columns. Выбор значения One column включает параметр Column, а значение Range of columns включает параметры Starting column и Ending column.

При выборе значения One row или Range of rows в параметре Row span указывается нужная строка или диапазон строк в параметрах Row, Starting row и Ending row. Аналогично, при выборе значений One column или Range of columns для параметра Column span указывается нужный столбец или диапазон столбцов в параметрах Column, Starting column и Ending column.

Значения параметров Row, Column, Starting row или Starting column могут быть заданы шестью способами:

  • First — для строк определяет, что первая строка входной матрицы u должна использоваться в качестве первой строки выходной подматрицы y. Если необходимо включить все столбцы, то это эквивалентно .

    Для столбцов это означает, что первый столбец входной матрицы u должен использоваться в качестве первого столбца выходной подматрицы y. При включении всех строк это эквивалентно .

  • Index — для строк указывает, что в качестве первой строки выходной подматрицы y должна использоваться строка входной матрицы u, firstrow, проиндексированная параметром Row index или параметром Starting row index. При включении всех столбцов это эквивалентно .

    Для столбцов это указывает, что в качестве первого столбца выходной подматрицы y должен использоваться столбец входной матрицы u, firstcol проиндексированный параметром Column index или параметром Starting column index. Если необходимо включить все строки, это эквивалентно .

  • Offset from last — для строк указывает, что в качестве первой строки выходной подматрицы y должна использоваться строка входной матрицы u, смещенная относительно строки M параметром Row offset или Starting row offset, firstrow. Если все столбцы должны быть включены, то это эквивалентно .

    Для столбцов этот параметр указывает, что в качестве первого столбца выходной подматрицы y должен использоваться столбец входной матрицы u, смещенный относительно столбца N параметром Column offset или Starting column offset, firstcol. Если необходимо включить все строки, то это эквивалентно .

  • Last — для строк это указывает, что последняя строка входной матрицы u должна использоваться в качестве единственной строки выходной подматрицы y. Если в строку включаются все столбцы, то это эквивалентно .

    Для столбцов это указывает, что последний столбец входной матрицы u должен использоваться в качестве единственного столбца выходной подматрицы y. При включении всех строк это эквивалентно .

  • Offset from middle — при выборе этой опции блок выбирает первую строку или столбец выходной подматрицы y путем добавления указанного смещения к средней строке или столбцу входной матрицы u. Если количество входных строк или столбцов X четное, то блок определяет середину как . Если количество входных строк или столбцов нечетное, то блок определяет середину как .

    Если необходимо включить все столбцы, то следующий код определяет начальную строку: , где Offset — значение параметра Row offset или Starting row offset. Если необходимо включить все строки, то начальный столбец определяется следующим кодом: , где Offset — значение параметра Column offset или Starting column offset.

  • Middle — при выборе этого параметра блок использует среднюю строку или столбец входной матрицы u в качестве первой строки или столбца выходной подматрицы y. Если количество входных строк или столбцов X четное, то блок определяет середину как . Если количество входных строк или столбцов нечетное, то блок определяет середину как .

    Если необходимо включить все столбцы, то следующий код определяет начальную строку: . При включении всех строк начальный столбец определяется следующим кодом: .

Конечная строка или конечный столбец аналогичным образом могут быть заданы пятью способами:

  • Index — для строк указывает, что в качестве последней строки выходной подматрицы y должна использоваться строка входной матрицы u, проиндексированная вперед по параметру Ending row index lastrow. Если необходимо включить все столбцы, то это эквивалентно .

    Для столбцов это указывает, что в качестве последнего столбца выходной подматрицы y должен использоваться столбец входной матрицы u, проиндексированный вперед по параметру Ending column index, lastcol. При включении всех строк это эквивалентно .

  • Offset from last — для строк указывает, что в качестве последней строки выходной подматрицы y должна использоваться строка входной матрицы u, смещенная относительно строки M на величину параметра смещения конечной строки lastrow. При включении всех столбцов это эквивалентно .

    Для столбцов этот параметр указывает, что в качестве последнего столбца выходной подматрицы y должен использоваться столбец входной матрицы u, смещенный относительно столбца N параметром Ending column offset, lastcol. При включении всех строк это эквивалентно .

  • Last — для строк определяет, что последняя строка входной матрицы u должна использоваться в качестве последней строки выходной подматрицы y. Если все столбцы должны быть включены, то это эквивалентно .

    Для столбцов это указывает, что последний столбец входной матрицы u должен быть использован в качестве последнего столбца выходной подматрицы y. Когда все строки должны быть включены, это эквивалентно .

  • Offset from middle — при выборе этой опции блок выбирает последнюю строку или столбец выходной подматрицы y, добавляя указанное смещение к средней строке или столбцу входной матрицы u. Если количество входных строк или столбцов X четное, то блок определяет середину как . Если количество входных строк или столбцов нечетное, то блок определяет середину как .

    Если необходимо включить все столбцы, то следующий код определяет конечную строку: , где Offset — значение параметра Ending row offset. Если необходимо включить все строки, то следующий код определяет конечный столбец: , где Offset — значение параметра Ending column offset.

  • Middle — при выборе этой опции блок использует среднюю строку или столбец входной матрицы u в качестве последней строки или столбца выходной подматрицы y. Если количество входных строк или столбцов X четное, то блок определяет середину как . При нечетном количестве входных строк или столбцов блок определяет середину как .

    Если необходимо включить все столбцы, то следующий код определяет конечную строку: . Если все строки должны быть включены, то следующий код определяет конечный столбец: .