Transfer Fcn Real Zero — Control Systems/Discrete
Control_Systems/Discrete/Transfer_Fcn_Real_Zero · 1 input / 1 output port(s) at insert · exports to Python, MATLAB, Java, Rust, C, C++, VHDL, Verilog, SystemVerilog, PLC Structured Text
Description#
The block's own DESCRIPTION_HTML, rendered verbatim — the same text the config dialog's info panel and the library navigator show. Fix a wrong sentence in the block's .cpp (R-D9), never here.
Transfer Fcn Real Zero
Control Systems / Discrete
A single real zero given directly in the z plane, and effectively no pole:
H(z) = (z − Z) / z
realized as the one-line recursion y[k] = u[k] − Z·u[k−1]. The z in the denominator is only the one-sample delay that makes the zero causal – it contributes a unit of memory rather than a mode to the dynamics, and the recursion never feeds its own output back, which is why the block is described as having no pole. On the very first sample there is no previous input, so the configured initial condition stands in for it.
Ports
- Input – the signal u to filter, of any size [p,m].
- Output – the filtered signal y, the SAME size [p,m] as the input.
The zero is scalar, but it is applied independently to every entry of the input signal, each entry remembering its own previous value.
Parameters
- Zero (in Z Plane) – a scalar Z, the numerator's root. Defaults to 0.75, Simulink's own default. Z = 1 puts the zero on the unit circle at DC and makes the block a plain first difference; Z = 0 leaves a straight wire; a negative Z places the zero at half the sampling frequency. |Z| > 1 is a non-minimum-phase zero, which is accepted rather than rejected.
- Initial Condition (Previous Input) – a scalar standing in for u[−1] on the first sample, broadcast to every entry of the signal. Defaults to 0. Having no pole, the block forgets it completely after one sample: it affects the first output only.
- Sampling Time (s) – zero or less inherits the solver's rate; a positive value runs the block at that period.
Code export
All ten targets: Python, MATLAB, Java, Rust, C, C++, VHDL, Verilog, SystemVerilog and PLC Structured Text, all from the shared realization every linear Control Systems / Discrete block uses. The zero and the initial condition are baked into the generated core at export time rather than exposed as tunable parameters: the zero is folded into the C coefficient, and the initial condition seeds a state rather than scaling arithmetic.
Simulink bridge
Import and export, mapped to
simulink/Discrete/Transfer Fcn Real Zero. "Zero (in Z Plane)" to
ZeroZ, "Initial Condition (Previous Input)" to
ICPrevInput. Both cross as plain numbers, so the mapping is lossless
in either direction.
InputProcessing is always emitted as Elements as channels
(sample based), with no ICore config behind it, because that is what this block
does and the alternative would mean something else entirely: ICore treats every
entry of a [p,m] signal as its own independent channel, whereas Simulink's
frame-based setting would read the columns as one channel's samples over time. A
model importing with the other value is reported rather than quietly accepted.
"Sampling Time (s)" does not cross, unusually: Simulink's block is a
masked subsystem with no SampleTime parameter at all, so the
rate stays on the ICore side and a block configured with an explicit positive rate
reports that it did not carry over. In Simulink it simply inherits the rate of
whatever drives it.
Simulink's RndMeth and DoSatur are left at their
defaults and have no ICore counterpart: they select a rounding mode and an overflow
policy that only bite on fixed-point or integer signals, and ICore's signal path is
double precision throughout.
Notes
- Discrete only, and stateful: one past sample per entry. Being an FIR section, it has no feedback at all, so any transient dies within one sample.
- Being linear, the block is directly usable by the model reduction and linear-analysis commands.
- Real Zero vs. Difference. Difference is exactly this block at Z = 1: y[k] = u[k] − u[k−1]. Reach for Difference when you want the sample-to-sample change; reach for this one when the zero belongs somewhere else in the plane.
Code facts#
| Fact | Value |
|---|---|
| registered type | Control_Systems/Discrete/Transfer_Fcn_Real_Zero |
| family | Control_Systems/Discrete |
| solver environment class | ICoreBlock_0_Control_Systems_1_Discrete_2_Transfer_Fcn_Real_Zero |
| source | src/ICoreSDK/ICoreBlockLibrary/Blocks/Control_Systems/Discrete/Transfer_Fcn_Real_Zero/ICoreBlock_0_Control_Systems_1_Discrete_2_Transfer_Fcn_Real_Zero.cpp |
| header | src/ICoreSDK/ICoreBlockLibrary/Blocks/Control_Systems/Discrete/Transfer_Fcn_Real_Zero/ICoreBlock_0_Control_Systems_1_Discrete_2_Transfer_Fcn_Real_Zero.h |
| default size on canvas | 110 × 80 px |
| ports at insert | 1 in, 1 out |
| code generators implemented | Python, MATLAB, Java, Rust, C, C++, VHDL, Verilog, SystemVerilog, PLC Structured Text |
Ports#
| # | Direction | Signal type | Description label |
|---|---|---|---|
| 1 | in | ICoreDouble | — |
| 2 | out | ICoreDouble | — |
Ports the constructor creates. A block whose port list changes with its configuration adds or removes ports at load time; the count above is the one a freshly inserted block has.
Configuration variables#
| Config variable | Default | Simulink parameter |
|---|---|---|
Zero (in Z Plane) | 0.75 | ZeroZ |
Initial Condition (Previous Input) | 0 | ICPrevInput |
Every block also carries Sampling Time (s) from ICoreBlockSolverEnvironment: zero or less inherits the solver's rate, a positive value runs the block at that period.
Simulink bridge#
| support | Support::Both |
| Simulink path | simulink/Discrete/Transfer Fcn Real Zero |
| port-count rule | PortsParam::None |
SampleTime parameter | no — the counterpart defines none; the rate stays on the ICore side |
| always set | InputProcessing = Elements as channels (sample based) |
| ICore config | Simulink parameter | Value translation |
|---|---|---|
Zero (in Z Plane) | ZeroZ | passes through |
Initial Condition (Previous Input) | ICPrevInput | passes through |
Caveat (shown to the user): the sampling time does not cross: Simulink's Transfer Fcn Real Zero is a masked subsystem with no SampleTime parameter, and inherits the rate of whatever drives it
Catalog contract: src/ICoreSDK/ICoreCoder/ICoreCommandSystem/SimulinkBridge/ICoreSimulinkBlockCatalog.h
Description vs code#
The lists agree. check_block_descriptions.py finds no disagreement between the description's Ports, Parameters, Code export and Simulink bridge lists and the code's.
The verdict above is
tools/docs/check_block_descriptions.py(P7.1), which compares LISTS. It cannot read a sentence: "stateless" on a block with a state, an initial-value semantic the recursion does not implement, a "not synthesizable" caveat the HDL banner contradicts. That is the agent audit (P7.3) on BLOCK_DESCRIPTION_AUDIT.md, and this tool's green is not a substitute for one.
File banner (developer view)#
The top comment of the block's .cpp — the maths, the realization and the export strategy, addressed to whoever changes it. It must not contradict the description above (P7.5).
Transfer Fcn Real Zero block — y[k] = u[k] - Z*u[k-1], element-wise One state, and it IS the previous input, which is what makes Simulink's initial condition carry over without rescaling. Structurally this is Difference with the zero moved off 1. See the header for the A/B/C/D. Everything below the matrices comes from ICoreDiscreteLinearBlockBase.
Sample results#
The same rig also ran:
| Stimulus | What it is | Output range |
|---|---|---|
impulse | Impulse: one sample of 1 at k = 5, 0 elsewhere (Repeating Sequence Stair) | -0.75 … 1 |
ramp | Ramp: slope 1 from t = 0 | 0 … 1.525 |
sine | Sine Wave: amplitude 1, 2 rad/s, no phase, no bias | -0.304 … 0.3035 |
table | Repeating Sequence Stair: [-2 -1 -0.5 0 0.5 1 2 3], one entry per sample | -4.25 … 1.5 |
Plotted: step — Step: 0 -> 1 at t = 1 s
Category dynamic · sample time 0.1 · 60 steps · commit ccf005c8 · produced by docsSample --out <folder> --steps 60 · data docs/generated/samples/Control_Systems__Discrete__Transfer_Fcn_Real_Zero.json · the SVG is generated from those numbers by tools/docs/plot_svg.py, so it is a run and not a drawing (R-D10).