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

Подматрица

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

Тип: Submatrix

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

/Basic/Matrix Operations/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

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

Да

Параметры

Основные

# Диапазон строк — диапазон строк
Все строки | Одна строка | Диапазон строк

Details

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

Значения

All rows | One row | Range of rows

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

Range of rows

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

RowSpan

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

Нет

Вычисляемый

Нет

# Строка — первая (единственная) строка выходной подматрицы
Первая | Индекс | Смещение от последней | Последняя | Смещение от середины | Центральная

Details

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

Зависимости

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

Значения

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

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

First

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

OneRowStartMode

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

Нет

Вычисляемый

Нет

# Индекс строки — индекс первой (единственной) строки
Целое число

Details

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

Зависимости

Чтобы использовать этот параметр, установите для параметра Диапазон строк значение Одна строка и для параметра СтрокаИндекс.

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

1

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

OneRowStartIndex

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

Нет

Вычисляемый

Да

# Смещение строки — смещение первой (единственной) строки
Целое число

Details

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

Зависимости

Чтобы использовать этот параметр, установите для параметра Диапазон строк значение Одна строка и для параметра Строка значение Смещение от последней или Смещение от середины.

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

1

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

OneRowStartOffset

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

Нет

Вычисляемый

Да

# Начальная строка — первая строка выходной подматрицы
Первая | Индекс | Смещение от последней | Последняя | Смещение от середины | Центральная

Details

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

Зависимости

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

Значения

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

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

First

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

RowStartMode

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

Нет

Вычисляемый

Нет

# Индекс начальной строки — индекс первой строки
Целое число

Details

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

Зависимости

Чтобы использовать этот параметр, установите для параметра Диапазон строк значение Диапазон строк и для параметра Начальная строкаИндекс.

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

1

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

RowStartIndex

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

Нет

Вычисляемый

Да

# Смещение начальной строки — смещение первой строки
Целое число

Details

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

Зависимости

Чтобы использовать этот параметр, установите для параметра Диапазон строк значение Диапазон строк и для параметра Начальная строкаСмещение от последней или Смещение от середины.

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

1

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

RowStartOffset

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

Нет

Вычисляемый

Да

# Конечная строка — последняя строка выходной подматрицы
Индекс | Смещение от последней | Последняя | Смещение от середины | Центральная

Details

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

Зависимости

Чтобы использовать этот параметр, установите для параметра Диапазон строк значение Диапазон строк и для параметра Начальная строка любое значение, кроме Последняя.

Значения

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

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

Last

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

RowEndMode

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

Нет

Вычисляемый

Нет

# Индекс конечной строки — индекс последней строки
Целое число

Details

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

Зависимости

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

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

1

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

RowEndIndex

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

Нет

Вычисляемый

Да

# Смещение конечной строки — смещение последней строки
Целое число

Details

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

Зависимости

Чтобы использовать этот параметр, установите для параметра Конечная строка значение Смещение от середины или Смещение от последней.

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

1

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

RowEndOffset

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

Нет

Вычисляемый

Да

# Диапазон столбцов — диапазон входных столбцов
Все столбцы | Один столбец | Диапазон столбцов

Details

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

Значения

All columns | One column | Range of columns

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

Range of columns

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

ColSpan

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

Нет

Вычисляемый

Нет

# Столбец — первый (единственный) столбец
Первый | Индекс | Смещение от последнего | Последний | Смещение от центрального | Центральный

Details

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

Зависимости

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

Значения

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

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

First

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

OneColStartMode

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

Нет

Вычисляемый

Нет

# Индекс столбца — индекс первого (единственного) столбца
Целое число

Details

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

Зависимости

Чтобы использовать этот параметр, установите для параметра Диапазон столбцов значение Один столбец и для параметра Столбец — значение Индекс.

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

1

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

OneColStartIndex

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

Нет

Вычисляемый

Да

# Смещение столбца — смещение первого (единственного) столбца
Целое число

Details

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

Зависимости

Чтобы использовать этот параметр, установите для параметра Диапазон столбцов значение Один столбец и для параметра Столбец значение Смещение от последнего или Смещение от центрального.

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

1

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

OneColStartOffset

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

Нет

Вычисляемый

Да

# Начальный столбец — первый столбец выходной подматрицы
Первый | Индекс | Смещение от последнего | Последний | Смещение от центрального | Центральный

Details

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

Зависимости

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

Значения

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

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

First

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

ColStartMode

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

Нет

Вычисляемый

Нет

# Индекс начального столбца — индекс первого столбца
Целое число

Details

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

Зависимости

Чтобы использовать этот параметр, установите для параметра Диапазон столбцов значение Диапазон столбцов, а для параметра Начальный столбец — значение Индекс.

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

1

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

ColStartIndex

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

Нет

Вычисляемый

Да

# Смещение начального столбца — смещение первого столбца
Целое число

Details

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

Зависимости

Чтобы использовать этот параметр, установите для параметра Диапазон столбцов значение Диапазон столбцов, а для параметра Начальный столбец — значение Смещение от последнего или Смещение от центрального.

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

1

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

ColStartOffset

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

Нет

Вычисляемый

Да

# Конечный столбец — последний столбец
Индекс | Смещение от последнего | Последний | Смещение от центрального | Центральный

Details

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

Зависимости

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

Значения

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

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

Last

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

ColEndMode

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

Нет

Вычисляемый

Нет

# Индекс конечного столбца — индекс последнего столбца
Целое число

Details

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

Зависимости

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

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

1

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

ColEndIndex

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

Нет

Вычисляемый

Да

# Смещение конечного столбца — смещение последнего столбца
Целое число

Details

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

Зависимости

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

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

1

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

ColEndOffset

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

Нет

Вычисляемый

Да

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

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

Details

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

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

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

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

Параметр Диапазон столбцов содержит соответствующий набор из трех вариантов для указания диапазона столбцов во входной матрице , которые должны быть сохранены в выходной подматрице : Все столбцы, Один столбец, или Диапазон столбцов. Выбор значения Один столбец включает параметр Столбец, а значение Диапазон столбцов включает параметры Начальный столбец и Конечный столбец.

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

Значения параметров Строка, Столбец, Начальная строка или Начальный столбец могут быть заданы шестью способами:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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