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

Коэффициент усиления

Умножает входной сигнал на константу.

gain

Описание

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

Коэффициент усиления задается параметром Коэффициент усиления. Параметр Умножение позволяет указать поэлементное или матричное умножение. Для матричного умножения этот параметр позволяет также указать порядок множителей.

При вычислении выходного сигнала блок Коэффициент усиления использует следующие правила:

  • Если входной сигнал действительного типа, а коэффициент усиления комплексный, то выходной сигнал будет комплексным.

  • Если тип входного сигнала отличается от типа коэффициента усиления, то Engee пытается выполнить приведение типа коэффициента усиления к типу входного сигнала. В том случае, если такое приведение невозможно, то расчет будет остановлен с выводом сообщения об ошибке. Такая ситуация может возникнуть, например, если входной сигнал — беззнаковое целое (Uint8), а параметр Коэффициент усиления задан отрицательным числом.

Порты

Вход

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

Details

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

Типы данных

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

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

Да

Выход

# OUT_1 — входной сигнал, умноженный на коэффициент усиления
скаляр | вектор | матрица

Details

Входной сигнал, умноженный на коэффициент усиления. Если входной сигнал блока Коэффициент усиления вещественный, а коэффициент усиления комплексный, то выходной сигнал будет комплексным.

Типы данных

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

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

Да

Параметры

Основные

# Коэффициент усиления — коэффициент, на который нужно умножить входной сигнал
Скаляр / массив вещественных и/или комплексных чисел

Details

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

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

1.0

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

Gain

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

Да

Вычисляемый

Да

# Умножение — режим умножения
Поэлементное(.*) | Матричное(K*u) | Матричное(u*K)

Details

Укажите один из этих режимов умножения:

  • Поэлементное(.*) — каждый элемент входного сигнала умножается на каждый элемент коэффициента усиления. При необходимости блок выполняет расширения, чтобы входные данные и коэффициент усиления имели одинаковые размеры.

  • Матричное(K*u) — входные данные и коэффициент усиления умножаются на матрицу с использованием входных данных в качестве второго операнда.

  • Матричное(u*K) — входные данные и коэффициент усиления умножаются на матрицу с использованием входных данных в качестве первого операнда.

Значения

Element-wise(K.*u) | Matrix(K*u) | Matrix(u*K)

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

Element-wise(K.*u)

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

Multiplication

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

Нет

Вычисляемый

Нет

Атрибуты сигнала

# Тип данных выхода — тип выходных данных
Наследовать автоматически | Наследовать от входа | Float64 | Float32 | Float16 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Фиксированная точка

Details

Задает тип выходных данных.

Значения

Inherit: auto | Same as input | Float64 | Float32 | Float16 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Fixed-point

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

Inherit: auto

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

OutDataTypeStr

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

Нет

Вычисляемый

Нет

# Тип выхода в фиксированной точке — тип выходных данных с фиксированной точкой
Тип данных

Details

Укажите тип выходных с фиксированной точкой.

Зависимости

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

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

fixdt(1, 16, 0)

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

OutDataTypeStrFixed

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

Нет

Вычисляемый

Да

# Метод округления до целого — режим округления для операций с фиксированной точкой
К большему | Конвергентный | К меньшему | К ближайшему | Математическое | К нулю

Details

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

  • К большему — округляет как положительные, так и отрицательные числа в меньшую сторону (в сторону отрицательной бесконечности).

  • К меньшему — округляет как положительные, так и отрицательные числа в большую сторону (в сторону положительной бесконечности).

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

  • К ближайшему — округляет число до ближайшего представимого значения. В случае если дробная часть числа оканчивается на 5, число округляется в большую сторону (в сторону положительной бесконечности).

  • Математическое — округляет число до ближайшего представимого значения. В случае если дробная часть числа оканчивается на 5, положительные числа округляются в большую сторону (в сторону положительной бесконечности), а отрицательные – в меньшую (в сторону отрицательной бесконечности).

  • К нулю — округляет число в сторону нуля.

Значения

Ceiling | Convergent | Floor | Nearest | Round | Zero

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

Floor

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

RndMeth

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

Нет

Вычисляемый

Нет

# Ограничить при переполнении целого — метод действия при переполнении
Логический тип

Details

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

Действие Причины для принятия этого решения Что происходит при переполнении Пример

Установите этот флажок.

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

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

Переполнение, связанное со знаковым 8-битным целым числом, может насытиться до -128 или 127.

Не устанавливайте этот флажок.

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

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

Число 130 не помещается в знаковое 8-битное целое число и сворачивается в -126

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

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

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

SaturateOnIntegerOverflow

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

Нет

Вычисляемый

Нет

Атрибуты параметра

# Тип данных параметра — тип данных параметра
Наследовать автоматически | Наследовать от входа | Float64 | Float32 | Float16 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Фиксированная точка

Details

Задает тип данных параметра.

Значения

Inherit: auto | Same as input | Float64 | Float32 | Float16 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Fixed-point

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

Inherit: auto

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

ParamDataTypeStr

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

Нет

Вычисляемый

Нет

# Тип параметра в фиксированной точке — тип данных параметра с фиксированной точкой
Тип данных

Details

Укажите тип данных параметра с фиксированной точкой.

Зависимости

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

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

fixdt(1, 16, 0)

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

ParamDataTypeStrFixed

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

Нет

Вычисляемый

Да

Дополнительные возможности

Генерация Си кода: Да

Примеры