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

Permute Matrix

Перестановка строк или столбцов матрицы.

Тип: PermuteMatrix

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

/Basic/Matrix Operations/Permute Matrix

Описание

Блок Permute Matrix формирует новую матрицу из столбцов (строк) исходной матрицы путем их перестановки и/или копирования. Блок переупорядочивает строки или столбцы входной матрицы размером на в соответствии с номерами столбцов (строк), полученными со входа P.

Порты

Вход

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

Details

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

Типы данных

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

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

Да

# P — номера столбцов (строк) для перестановки
скаляр | вектор | матрица

Details

Номера столбцов (строк) матрицы , из которых будет формироваться новая матрица. Скаляр или вектор.

Типы данных

Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64

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

Да

Выход

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

Details

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

Типы данных

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

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

Да

Параметры

Основные

# Permute — метод перестановки
Columns | Rows

Details

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

Если параметр Permute имеет значение:

  • Rows — блок использует строки входной матрицы для создания матрицы, имеющей ту же размерность столбцов. Вход P — это вектор длины , элементы которого определяют, куда должна быть помещена каждая строка из входной матрицы в выходной матрице на .

    Для перестановки строк блок рассматривает неориентированный вектор длины , поступающий на порт A, как матрицу на .

  • Columns — блок использует столбцы входной матрицы для создания матрицы, имеющей ту же размерность строк. На вход P подается вектор длины , элементы которого определяют, куда должен быть помещен каждый столбец из входной матрицы в выходной матрице на .

    Для перестановки столбцов блок рассматривает неориентированный вектор длины , поступающий на порт A, как матрицу на .

Значения

Columns | Rows

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

Columns

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

mode

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

Нет

Вычисляемый

Нет

# Index Mode — режим индекса
One-based | Zero-based

Details

При установке значения One-based значение 1 в векторе перестановок относится к первой строке или столбцу входной матрицы . При установке Zero-based значение 0 в относится к первой строке или столбцу .

Значения

One-based | Zero-based

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

One-based

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

ZeroOneIdxMode

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

Нет

Вычисляемый

Нет

# Invalid permutation index — реакция на недопустимое значение индекса
Clip index | Clip and warn | Generate error

Details

Реакция на недопустимое значение индекса. Если значение индекса на входе P ссылается на несуществующую строку или столбец входной матрицы , блок реагирует так, как указано в этом параметре. Возможны следующие варианты:

  • Clip index — обрезать индекс до ближайшего допустимого значения (1 или для перестановки строк и 1 или для перестановки столбцов) и не выдавать предупреждение.

    Пример: Для входной матрицы 3 на 7 индекс столбца, равный 9, обрезается до 7, а индекс строки, равный −2, обрезается до 1.

  • Clip and warn — то же, что предыдущий вариант; в будущих релизах при выборе этого варианта в окно командной строки Engee будет выводиться предупреждающее сообщение.

  • Generate error — вывести диалоговое окно ошибки и прервать моделирование.

Значения

Clip index | Clip and warn | Generate error

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

Clip index

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

errmode

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

Нет

Вычисляемый

Нет

# Error when length of P is not equal to Permute dimension size — сообщение об ошибке для длины
Logical

Details

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

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

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

false (выключено)

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

checkDims

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

Нет

Вычисляемый

Нет