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

Примеры тривиальных и родовых выходных выражений

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

Этот фрагмент кода показывает код, сгенерированный из блока Unit Delay в этой блок-схеме. Три корневых выхода непосредственно назначаются из состояния блока Unit Delay, который хранится в поле глобальных данных структуры rtDWork. Поскольку назначение является прямым, без выражений, нет никакого штрафа эффективности, связанного с использованием тривиального выражения для нескольких адресатов.

void MdlOutputs(int_T tid)
{
   ...
  /* Outport: <Root>/Out1 incorporates:

   *   UnitDelay: <Root>/Unit Delay */
  rtY.Out1 = rtDWork.Unit_Delay_DSTATE;

  /* Outport: <Root>/Out2 incorporates:
   *   UnitDelay: <Root>/Unit Delay */
  rtY.Out2 = rtDWork.Unit_Delay_DSTATE;

  /* Outport: <Root>/Out3 incorporates:
   *   UnitDelay: <Root>/Unit Delay */
  rtY.Out3 = rtDWork.Unit_Delay_DSTATE;

   ...
}

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

С другой стороны, рассмотрим блоки Sum в этой модели:

Верхний блок Sum в модели генерирует сигнал, маркированный non_triv. Расчет этого выходного сигнала включает два умножения и сложение. Если бы выходам блока Sum было разрешено генерировать выражение, даже когда блок имел бы несколько адресатов, операции блока были бы дублированы в сгенерированном коде. В этом случае сгенерированные выражения будут расширяться до четырех умножений и двух сложений. Это приведет к снижению эффективности программы. Соответственно, выход блока Sum не может быть выражением, потому что он имеет несколько адресатов.

Механизм Simulink не позволяет, чтобы выход верхнего блока Sum был выражением, потому что сигнал non_triv маршрутизируется по двум выходным адресатам. Вместо этого результат операций умножения и сложения сохранен во временной переменной (rtb_non_triv) это ссылка дважды в следующих операторах, как видно из выдержки из кода ниже.

Напротив, нижний блок Sum, который имеет только один выходной пункт назначения (Out2), генерирует выражение.

void MdlOutputs(int_T tid)
{
  /* local block i/o variables */
  real_T rtb_non_triv;
  real_T rtb_Sine_Wave;

  /* Sum: <Root>/Sum incorporates:
   *   Gain: <Root>/Gain
   *   Inport: <Root>/u1
   *   Gain: <Root>/Gain1
   *   Inport: <Root>/u2
   *
   * Regarding <Root>/Gain:
   *   Gain value: rtP.Gain_Gain
   *
   * Regarding <Root>/Gain1:
   *   Gain value: rtP.Gain1_Gain
   */
  rtb_non_triv = (rtP.Gain_Gain * rtU.u1) + (rtP.Gain1_Gain * 
rtU.u2);

  /* Outport: <Root>/Out1 */
  rtY.Out1 = rtb_non_triv;

  /* Sin Block: <Root>/Sine Wave */

  rtb_Sine_Wave = rtP.Sine_Wave_Amp *
	sin(rtP.Sine_Wave_Freq * rtmGetT(rtM_model) + 
	rtP.Sine_Wave_Phase) + rtP.Sine_Wave_Bias;

  /* Outport: <Root>/Out2 incorporates:
   *   Sum: <Root>/Sum1
   */
  rtY.Out2 = (rtb_non_triv + rtb_Sine_Wave);
}

Задайте категорию выходного выражения

S-Function API предоставляет макросы, которые позволяют вам объявить, должен ли выход блока быть выражением, и если да, то задать категорию выражения. Эта таблица задает, когда объявить выход блока постоянным, тривиальным или общим выходным выражением.

Вы должны объявить выходы как выражения в mdlSetWorkWidths функция с использованием макросов, определенных в S-Function API. Макросы имеют следующие аргументы:

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

Следующие макросы доступны для запроса состояния, установленного предыдущими вызовами макросов выше:

Набор родовых выражений является наложением множества тривиальных выражений, а набор тривиальных выражений является наложением множества постоянных выражений.

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

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

S-Function API для задания принятия входного выражения

S-Function API предоставляет макросы, которые позволяют вам:

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

Вы должны вызвать макросы в своем mdlSetWorkWidths функция. Макросы имеют следующие аргументы:

Макрос, доступный для определения, должен ли вход блока принимать неконстантное выражение, является:

void ssSetInputPortAcceptExprInRTW(SimStruct *S, int portIdx, bool value)

Соответствующий макрос, доступный для запроса состояния, установленного любыми предыдущими вызовами ssSetInputPortAcceptExprInRTW является:

bool ssGetInputPortAcceptExprInRTW(SimStruct *S, int portIdx)

Отклонение запросов блоков для вывода выражений

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

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

Складывание выражений Податливости

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

Чтобы зарегистрировать податливость выражения свертыванию, вызовите функцию библиотеки TLC LibBlockSetIsExpressionCompliant(block), который определен в matlabroot/ rtw/c/tlc/lib/utillib.tlc. Для примера:

%% Function: BlockInstanceSetup ===========================================
%%
%function BlockInstanceSetup(block, system) void
  %%
  %<LibBlockSetIsExpressionCompliant(block)>
  %%
%endfunction

Можно условно отключить складывание выражений на входах и выходах блока, сделав вызов этой функции условно.

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

Выходные выражения

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

%function BlockOutputSignal(block,system,portIdx,ucv,lcv,idx,retType) void

Аргументы в адрес BlockOutputSignal являются ли следующие:

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

%% Function: BlockOutputSignal =================================================
%% Abstract:
%%      Return the reference to the parameter.  This function *may*
%%      be used by Simulink when optimizing the Block IO data structure.
%%
%function BlockOutputSignal(block,system,portIdx,ucv,lcv,idx,retType) void
  %switch retType
    %case "Signal"
      %return LibBlockParameter(Value,ucv,lcv,idx)
    %case "SignalAddr"
      %return LibBlockParameterAddr(Value,ucv,lcv,idx)
    %default
      %assign errTxt = "Unsupported return type: %<retType>"
      %<LibBlockReportError(block,errTxt)>
  %endswitch
%endfunction

Код, реализующий BlockOutputSignal функция для блока Relational Operator:

%% Function: BlockOutputSignal =================================================
%% Abstract:
%%      Return an output expression.  This function *may*
%%      be used by Simulink when optimizing the Block IO data structure.
%%
%function BlockOutputSignal(block,system,portIdx,ucv,lcv,idx,retType) void
%switch retType
%case "Signal"
%assign logicOperator = ParamSettings.Operator
 %if ISEQUAL(logicOperator, "~=")
 %assign op = "!="
elseif ISEQUAL(logicOperator, "==") %assign op = "=="
  %else
%assign op = logicOperator
%endif
 %assign u0 = LibBlockInputSignal(0, ucv, lcv, idx)
%assign u1 = LibBlockInputSignal(1, ucv, lcv, idx)
  %return "(%<u0> %<op> %<u1>)"
 %default
 %assign errTxt = "Unsupported return type: %<retType>"
 %<LibBlockReportError(block,errTxt)>
%endswitch
%endfunction

Складывание выражений для блоков с несколькими выходами

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

Если блок имеет несколько выходов, Outputs функция вызывается, если любой выходной порт не является выражением. Outputs функция должна защищать от генерации кода для выходных портов, которые являются выражениями. Это достигается путем защиты разделов кода, соответствующих отдельным выходным портам, с вызовами на LibBlockOutputSignalIsExpr().

Например, рассмотрим S-Функцию с двумя входами и двумя выходами, где

Outputs и BlockOutputSignal функции для S-функции показаны в этом фрагменте кода:

%% Function: BlockOutputSignal =================================================
%% Abstract:
%%      Return an output expression.  This function *may*
%%      be used by Simulink when optimizing the Block IO data structure.
%%
%function BlockOutputSignal(block,system,portIdx,ucv,lcv,idx,retType) void
%switch retType
%case "Signal"
   %assign u = LibBlockInputSignal(portIdx, ucv, lcv, idx)
 %case "Signal"
 %if portIdx == 0
  %return "(2 * %<u>)"
%elseif portIdx == 1
 %return "(4 * %<u>)"
%endif
%default
%assign errTxt = "Unsupported return type: %<retType>"
 %<LibBlockReportError(block,errTxt)>
%endswitch
%endfunction  
%%
%% Function: Outputs =================================================
%% Abstract:
%%      Compute output signals of block
%%
%function Outputs(block,system) Output
%assign rollVars = ["U", "Y"]
%roll sigIdx = RollRegions, lcv = RollThreshold, block, "Roller", rollVars 
%assign u0 = LibBlockInputSignal(0, "", lcv, sigIdx)
 %assign u1 = LibBlockInputSignal(1, "", lcv, sigIdx)
 %assign y0 = LibBlockOutputSignal(0, "", lcv, sigIdx)
 %assign y1 = LibBlockOutputSignal(1, "", lcv, sigIdx)
%if !LibBlockOutputSignalIsExpr(0)
%<y0> = 2 * %<u0>;
%endif
%if !LibBlockOutputSignalIsExpr(1)
 %<y1> = 4 * %<u1>;
%endif
%endroll
%endfunction

Комментарии для блоков, которые совместимы с выражением-складыванием-

В прошлом блоки предшествовали коду выходов с комментариями формы

/* %<Type> Block: %<Name> */

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

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

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

%openfile commentBuf
  $c(*) Gain value: %<LibBlockParameterForComment(Gain)>
  %closefile commentBuf
  %<LibCacheBlockComment(block, commentBuf)>