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

Submatrix

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

Тип: Submatrix

Путь в библиотеке:

/Basic/Matrix Operations/Submatrix

Описание

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

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

Порты

Вход

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

Details

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

Типы данных

Float16, Float32, Float64, Int8, Int16, Int32, Int64, Int128, UInt8, UInt16, UInt32, UInt64, UInt128, Fixed, Bool

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

Да

Выход

# OUT_1 — подматрица
матрица

Details

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

Типы данных

Float16, Float32, Float64, Int8, Int16, Int32, Int64, Int128, UInt8, UInt16, UInt32, UInt64, UInt128, Fixed, Bool

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

Да

Параметры

Основные

# Row span — диапазон строк
All rows | One row | Range of rows

Details

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

Значения

All rows | One row | Range of rows

Значение по умолчанию

Range of rows

Имя для программного использования

RowSpan

Настраиваемый

Нет

Вычисляемый

Нет

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

Details

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

Зависимости

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

Значения

First | Index | Offset from last | Last | Offset from middle | Middle

Значение по умолчанию

First

Имя для программного использования

OneRowStartMode

Настраиваемый

Нет

Вычисляемый

Нет

# Row index — индекс первой (единственной) строки
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

OneRowStartIndex

Настраиваемый

Нет

Вычисляемый

Да

# Row offset — смещение первой (единственной) строки
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

OneRowStartOffset

Настраиваемый

Нет

Вычисляемый

Да

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

Details

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

Зависимости

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

Значения

First | Index | Offset from last | Last | Offset from middle | Middle

Значение по умолчанию

First

Имя для программного использования

RowStartMode

Настраиваемый

Нет

Вычисляемый

Нет

# Starting row index — индекс первой строки
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

RowStartIndex

Настраиваемый

Нет

Вычисляемый

Да

# Starting row offset — смещение первой строки
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

RowStartOffset

Настраиваемый

Нет

Вычисляемый

Да

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

Details

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

Зависимости

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

Значения

Index | Offset from last | Last | Offset from middle | Middle

Значение по умолчанию

Last

Имя для программного использования

RowEndMode

Настраиваемый

Нет

Вычисляемый

Нет

# Ending row index — индекс последней строки
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

RowEndIndex

Настраиваемый

Нет

Вычисляемый

Да

# Ending row offset — смещение последней строки
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

RowEndOffset

Настраиваемый

Нет

Вычисляемый

Да

# Column span — диапазон входных столбцов
All columns | One column | Range of columns

Details

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

Значения

All columns | One column | Range of columns

Значение по умолчанию

Range of columns

Имя для программного использования

ColSpan

Настраиваемый

Нет

Вычисляемый

Нет

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

Details

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

Зависимости

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

Значения

First | Index | Offset from last | Last | Offset from middle | Middle

Значение по умолчанию

First

Имя для программного использования

OneColStartMode

Настраиваемый

Нет

Вычисляемый

Нет

# Column index — индекс первого (единственного) столбца
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

OneColStartIndex

Настраиваемый

Нет

Вычисляемый

Да

# Column offset — смещение первого (единственного) столбца
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

OneColStartOffset

Настраиваемый

Нет

Вычисляемый

Да

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

Details

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

Зависимости

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

Значения

First | Index | Offset from last | Last | Offset from middle | Middle

Значение по умолчанию

First

Имя для программного использования

ColStartMode

Настраиваемый

Нет

Вычисляемый

Нет

# Starting column index — индекс первого столбца
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

ColStartIndex

Настраиваемый

Нет

Вычисляемый

Да

# Starting column offset — смещение первого столбца
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

ColStartOffset

Настраиваемый

Нет

Вычисляемый

Да

# Ending column — последний столбец
Index | Offset from last | Last | Offset from middle | Middle

Details

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

Зависимости

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

Значения

Index | Offset from last | Last | Offset from middle | Middle

Значение по умолчанию

Last

Имя для программного использования

ColEndMode

Настраиваемый

Нет

Вычисляемый

Нет

# Ending column index — индекс последнего столбца
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

ColEndIndex

Настраиваемый

Нет

Вычисляемый

Да

# Ending column offset — смещение последнего столбца
Integer

Details

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

Зависимости

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

Значение по умолчанию

1

Имя для программного использования

ColEndOffset

Настраиваемый

Нет

Вычисляемый

Да

Дополнительно

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

Details

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

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

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

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

Параметр Column span содержит соответствующий набор из трех вариантов для указания диапазона столбцов во входной матрице , которые должны быть сохранены в выходной подматрице : 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 — для строк определяет, что первая строка входной матрицы должна использоваться в качестве первой строки выходной подматрицы . Если необходимо включить все столбцы, то это эквивалентно .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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