Xilinx
HLS
Block Preview

Introduction

The Block Variance block chops the input stream into consecutive blocks of N samples and, at the end of each block, publishes the variance of that block:

$$ S_1 = \sum_{i=0}^{N-1} x_i , \qquad S_2 = \sum_{i=0}^{N-1} x_i^2 $$

$$ \mathrm{var} = \overline{x^2} - \mathrm{mean}^2 = \frac{S_2}{N} - \left(\frac{S_1}{N}\right)^{!2} $$

N is a runtime input, not a property. You drive the exponent on the EXP pin and the block size is $N = 2^{\mathrm{EXP}}$:

EXP N EXP N
4 16 12 4096
6 64 16 65536
8 256 20 1048576

Because N is a power of two, every division by N is an exact arithmetic shift. There is no divider and no reciprocal ROM, which is also why the block size can be changed while the design is running, for free.

What it is FOR

The variance is the spread of the block about its own mean, with the DC level removed - the standard stability, noise and pile-up indicator. A baseline that is quiet has a small variance; one sitting on a pulse, a glitch or an oscillation does not, however clean its mean looks.

It is also the cheapest of the three spread measures in this family, and the only exact one:

  • Block Variance (this block) - no square root, bit exact, one serial multiply in the tail.
  • Block Std Dev - this block plus a serial square root: same value in input units, one more serial engine, up to 1 LSB of error.
  • Block RMS - includes the DC level, so it is a different quantity, not a cheaper standard deviation.

If you only need to COMPARE or THRESHOLD spreads, stop here. The square root is monotone, so thresholding the variance against the SQUARE of your threshold gives exactly the same decisions as thresholding the standard deviation - with no root, no root guard bits and a much shorter tail.

When to use this instead of Block Statistics

The all-in-one Block Statistics block is not deprecated and computes this same variance among twenty other statistics. The rule is simple:

  • you want several statistics of the SAME block - variance and mean and min/max of the same N samples - use Block Statistics. They share one accumulator pair and one serial tail, so the second and third statistic are nearly free: the shift-add squarer this block runs alone is the same one the all-in-one block reuses for the standard deviation.
  • you want exactly one number - use this block. Then you synthesise only that number: the pin list, the two accumulators, the serial squarer and the tail are all that the variance needs, and nothing else reaches the synthesiser.

Two Block Statistics blocks side by side would duplicate the accumulators; two per-operator blocks side by side duplicate them too. One Block Statistics block never does.

Pin Description

IN Input IN_BitsInt + IN_BitsFract bit BIT VECTOR
Input samples, fixed point in the IN Q format. Accumulated into both $S_1$ and $S_2$ only on the clocks where IN_DV is high.
Default: Must be connected
IN_DV Input 1 bit BIT
Per-sample qualifier, active high, and the ONLY qualifier this block has. A sample is accumulated, and counts towards N, exactly on the clocks where this is high; the serial tail keeps running regardless. Unconnected defaults to '1'. (There is deliberately no CE pin - to stall the block, gate this.)
EXP Input 6 bit BIT VECTOR
Block size exponent, runtime programmable: the block is $N = 2^{\text{EXP}}$ samples long. 6 bits unsigned, accepted range 0 .. Max Block Exponent; larger values are clamped to Max Block Exponent. Sampled on the first accepted sample of a block and held for that whole block, so a change takes effect on the NEXT block. It also sets the LENGTH OF THE TAIL here (L = IN_SW + EXP + 3): must not be driven below the minimum usable exponent of the configuration, or that block’s result is dropped (see “Timing: the serial tail”). Unconnected defaults to 10 (N = 1024).
VARIANCE Output VARIANCE_BitsInt + VARIANCE_BitsFract bit BIT VECTOR
$(N S_2 - S_1^2)/N^2$ in the VARIANCE Q format - bit exact, the only rounding being the requantisation into that format. Non-negative by construction. Updated on the OUT_DV clock and on no other; it holds the previous block’s result until then.
OUT_DV Output 1 bit BIT
One-clock pulse marking a valid result. It fires when the serial tail COMPLETES, L clocks after the clock on which the N-th sample of the block was accepted, not when that sample arrives. VARIANCE is updated on this clock and on no other. BUSY is still high here and falls on the next clock.
CLK 1 bit
Clock.
RESET 1 bit
Synchronous reset: clears both accumulators, the block counter, the sample count and the serial tail.
BUSY 1 bit
High from the start of a block - its first accumulated sample - until its result is out: it covers the serial tail as well. Its last high clock is the OUT_DV pulse, and it falls on the clock after. On a continuous stream it simply stays high. Present on the symbol only when Enable BUSY = YES.
INTEGRATING 1 bit
High only while the block is accumulating: it rises on the clock after the first sample of a block is accepted and falls on the clock after the N-th, so it is low for the whole tail. On a continuous stream it dips for exactly one clock per block boundary, which makes it a free block marker. Present on the symbol only when Enable INTEGRATING = YES.
SAMPLE_COUNT 32 bit

How many samples have been accumulated so far in the current block: 1 after the first, N after the N-th. It is NOT cleared at the end of a block

  • it HOLDS the final count through the tail and past OUT_DV, until the first sample of the next block takes it back to 1, so on the OUT_DV clock it reads the length of the block being presented. Only RESET clears it to 0. Fixed 32 bits. Present on the symbol only when Enable SAMPLE_COUNT = YES.

Properties

Property window

IN Integer Bits IN_BitsInt

Number of INTEGER bits of the input sample (the sign, when present, uses one of them).

Integer bits of the input sample (the sign, when present, uses one of them). 1..64. Default 16.

Default: 16

Options: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64

IN Fractional Bits IN_BitsFract

Number of FRACTIONAL bits of the input sample, i.e. the bits to the right of the binary point. Total width = integer + fractional bits, and must not exceed 64.

Fractional bits of the input sample. 0..64. Total input width must be 2..64 bits. Default 0.

Default: 0

Options: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64

IN Sign IN_Sign

Select whether the input sample is signed (two’s complement) or unsigned.

SIGNED (two’s complement) or UNSIGNED input. Default SIGNED. An UNSIGNED input costs one extra bit internally, because a sample has to be promoted to signed before it can be accumulated - and that bit is one more clock of serial multiply, since the tail is IN_SW + EXP + 3 clocks long.

Default: SIGNED

Options: UNSIGNED SIGNED

Max Block Exponent MaxBlockExponent

Largest block-size exponent the accumulators are sized for: the block can be up to 2^MaxBlockExponent samples long. The EXP input is clamped to this value at run time. Raising it widens the internal accumulators, and ON THE BLOCKS WHOSE SERIAL ENGINES ARE SIZED FROM THOSE ACCUMULATORS (Coefficient of Variation, SNR, Skewness, Kurtosis, Correlation, Autocorrelation, Linear Regression) it also LENGTHENS THE SERIAL TAIL – even when the runtime EXP is small. Keep it at the largest block you actually use. The default of 20 covers blocks of up to 1048576 samples.

Largest block-size exponent the accumulators are sized for: the block can be up to $2^{\text{MaxBlockExponent}}$ samples long, and the EXP input is clamped to this value at run time. Raising it widens the internal sum and sum-of-squares registers by one bit per unit, and raises the WORST CASE tail (which is IN_SW + MaxBlockExponent + 3 clocks) - but it also raises the slack, so it never makes the configuration invalid. Keep it at the largest block you actually use. 1..31, default 20, i.e. blocks of up to 1048576 samples out of the box.

Default: 20

Options: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

VARIANCE Integer Bits VARIANCE_BitsInt

Number of INTEGER bits of the VARIANCE output (the sign, when present, uses one of them).

Integer bits of the VARIANCE output. 1..64, default 32. The variance is a SQUARE: allow about twice the integer bits of the input if you do not want it to saturate.

Default: 32

Options: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64

VARIANCE Fractional Bits VARIANCE_BitsFract

Number of FRACTIONAL bits of the VARIANCE output, i.e. the bits to the right of the binary point. Total width = integer + fractional bits, and must not exceed 64.

Fractional bits of the VARIANCE output. 0..64, total width 2..64 bits, default 0. Unlike the square-root blocks of this family, the width here does NOT lengthen the tail - there is no serial root in this block, so a wide variance format is paid for in registers only.

Default: 0

Options: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64

VARIANCE Sign VARIANCE_Sign

Select whether the VARIANCE output is signed (two’s complement) or unsigned.

SIGNED or UNSIGNED VARIANCE output. Default UNSIGNED - the exact integer identity guarantees a non-negative numerator, so UNSIGNED is safe and buys one bit of range for free.

Default: UNSIGNED

Options: UNSIGNED SIGNED

Enable BUSY EnableBusy

YES: the BUSY (high from the first sample of a block until its result is out – it COVERS THE SERIAL TAIL, and its last high clock IS the OUT_DV pulse) pin is present. NO: the pin AND all of its logic are removed BEFORE synthesis, so nothing is paid for it.

YES: the BUSY pin exists. It is high from the first sample of a block until its result is out, serial tail included, and its last high clock is the OUT_DV pulse. NO: the pin and its register are removed before synthesis. Default NO.

Default: NO

Options: NO YES

Enable INTEGRATING EnableIntegrating

YES: the INTEGRATING (high only while the block is ACCUMULATING; it drops as soon as the N-th sample has been taken and the tail starts, so BUSY-and-not-INTEGRATING means ‘computing’) pin is present. NO: the pin AND all of its logic are removed BEFORE synthesis, so nothing is paid for it.

YES: the INTEGRATING pin exists. It is high only while the block is accumulating, so BUSY high with INTEGRATING low means “the samples are all in, I am computing”. NO: the pin and its register are removed. Default NO.

Default: NO

Options: NO YES

Enable SAMPLE_COUNT EnableSampleCount

YES: the SAMPLE_COUNT (32 bit, how many samples have been accumulated so far in the current block: 1 after the first, N after the N-th. It is NOT cleared at the block end – it holds N until the NEXT block’s first accepted sample takes it back to 1. On a CONTINUOUS stream that happens DURING the serial tail, so at OUT_DV it reads how far into the next block the input has already got, NOT N. To capture the length of the block being presented, latch SAMPLE_COUNT on the clock INTEGRATING falls – that one always reads N) pin is present. NO: the pin AND all of its logic are removed BEFORE synthesis, so nothing is paid for it.

YES: the SAMPLE_COUNT pin exists - a fixed 32 bit count of the samples accumulated so far in the current block, holding the final count through the tail and past OUT_DV. NO: the pin and its counter are removed. Default NO.

Default: NO

Options: NO YES

Rounding Rounding

ROUND: round to nearest when a result has to be requantised into a coarser output format. TRUNCATE: drop the bits (cheaper, adds a negative bias).

ROUND: round to nearest when the exact result has to be requantised into a coarser output format. TRUNCATE: drop the bits (cheaper, adds a negative bias). Default ROUND. This is the ONLY rounding in the block.

Default: ROUND

Options: TRUNCATE ROUND

Saturation EnableSaturation

YES: clip to the largest representable value of each output format (symmetric for signed formats). NO: wrap around.

YES: clip to the largest representable value of the output format (symmetric bounds for signed formats). NO: wrap around. Default YES. Only matters when the VARIANCE format is too narrow for the value - which, for a square, is easy to get wrong: size the integer bits at about twice the input’s.

Default: YES

Options: NO YES

The design decision that makes it exact

The variance is not computed as $(S_2/N) - (S_1/N)^2$ from two truncated quotients. It is computed from the exact integer numerator:

$$ \mathrm{var_num} = N,S_2 - S_1^2 , \qquad \mathrm{variance} = \frac{\mathrm{var_num}}{N^2} $$

Both $S_1$ and $S_2$ are exact integer accumulators; $N S_2$ is a shift (N is a power of two); $S_1 \cdot S_1$ is an exact integer square computed serially; and the division by $N^2$ is a shift again. Two consequences follow, and they are the whole reason the block is built this way:

1. The result is BIT EXACT. The only rounding anywhere is the single final requantisation into the Q format you chose for the VARIANCE pin. That is not an aspiration: the host regression (tb/block-ops/run_tb.ps1) demands tolerance ZERO against a Python golden that evaluates the definition in exact rational arithmetic - not “within 1 LSB”, not “within a few counts”. Any deviation at all fails the build.

2. The variance can never come out negative. By Cauchy-Schwarz,

$$ N,S_2 - S_1^2 = \sum_{i<j} (x_i - x_j)^2 \ \ge\ 0 $$

always, so the classic “variance went slightly negative because two quotients were rounded independently” failure cannot happen here. That is what makes an UNSIGNED VARIANCE output format safe - which is the default - and what keeps a negative radicand out of Block Std Dev’s square root. The non-negative clamp is still present in the shared core and still load bearing, but no stimulus through the ports can reach it; it is unit tested directly with negative inputs instead.

If you ever see VARIANCE = 0 on a signal that is not constant, the value was simply smaller than one LSB of the format you chose.

Accumulation and IN_DV

IN_DV is the only qualifier. It says “this clock carries a sample”: a sample is added to $S_1$, squared into $S_2$, and counts towards N, exactly on the clocks where IN_DV is high. Clocks with IN_DV low are ignored completely - whatever sits on IN during them cannot corrupt the block - while the serial tail keeps running, which is what you want: the tail has nothing to do with the input stream.

Unconnected, IN_DV ties to '1' and EXP ties to 10 (N = 1024), so the block free-runs with nothing wired except IN.

There is deliberately no CE pin. On the all-in-one Block Statistics block an earlier revision had one, and it did not survive synthesis: with nothing but internal state gated by it, Vitis could reason the frozen path away and delete the port from the generated entity while SciCompiler’s wrapper still wired it, which failed a real Vivado build with [VRFC 10-718] formal port <ce> does not exist in entity. The whole per-operator family was built without one. To stall this block, gate its IN_DV - a block that only accumulates on IN_DV has no need to be frozen, and there is no reason to stall the tail.

When EXP changes

EXP is clamped to Max Block Exponent and then latched on the first accepted sample of a block, and held for that whole block. A change therefore takes effect on the NEXT block: a block in progress always finishes against the N it was started with, and a block is never emitted against a different N than the one it was accumulated with. Both the $N S_2$ shift and the final $N^2$ shift use that latched exponent, so the arithmetic of a block is always self-consistent.

Timing: the serial tail

Why it is serial

A block has a whole block period of slack after its N-th sample: the next result is not due for another $2^{\mathrm{EXP}}$ clocks. So there is no reason to build a parallel datapath for the post-accumulation arithmetic. II=1 is only needed while ACCUMULATING - one sample per clock, one multiply, two adds - and the tail has all the time in the world.

$S_1 \cdot S_1$ is therefore ONE reused shift-add stage stepped once per clock, consuming one bit of $|S_1|$ per clock. The cost is CLOCKS, not multipliers: the only multiplier in the whole block is the $x \cdot x$ during accumulation, and there is no DSP in the tail.

The latency contract

OUT_DV pulses for one clock when the tail COMPLETES, L clocks after the clock on which the N-th sample of the block was accepted - not when that sample arrives. VARIANCE is updated on that same clock and on no other. The state walk is IDLE -(go)-> MUL x (IN_SW + EXP) -> VAR -> FIN -> IDLE with OUT_DV registered, so

$$ L = 2 + (\mathrm{IN_SW} + \mathrm{EXP} + 1) $$

where $\mathrm{IN_SW}$ is the signed working width of a sample: the input width, +1 if the input is UNSIGNED (a sample has to be promoted to signed before it can be accumulated). $|S_1|$ is at most $\mathrm{IN_SW} - 1 + \mathrm{EXP}$ bits wide for a block of $2^{\mathrm{EXP}}$ samples, so $\mathrm{IN_SW} + \mathrm{EXP}$ shift-add steps always clear it.

Block Variance and Block Std Dev are the only blocks in the family whose latency depends on the RUNTIME exponent. A longer block makes $|S_1|$ wider and therefore costs more multiply steps. But a longer block also gives more slack: the block grows exponentially in EXP and the tail only linearly, so the $2^{\mathrm{EXP}} \ge L$ constraint gets easier as EXP grows, not harder. The output format does not enter the formula at all - widening VARIANCE costs nothing in clocks, because there is no square root here.

The 2^EXP >= L rule

The tail of one block must finish before the next block completes:

$$ 2^{\mathrm{EXP}} \ge L $$

If a block completes while the previous tail is still running, that block’s result is DROPPED. A completed block is only handed to the tail when the tail is IDLE, so: no OUT_DV for it, the accumulators are unaffected, later blocks come out correctly - and there is no error pin. A result is simply skipped.

Three things guard against it, and one hole remains:

  • the property validator refuses a configuration whose minimum exponent exceeds Max Block Exponent - here that is driven by the INPUT width, since $\mathrm{IN_SW} + \mathrm{EXP} + 3$ clocks have to hide inside $2^{\mathrm{EXP}}$ samples;
  • CompileHDL prints the tail length and the minimum usable EXP into the compilation log for every placement;
  • but EXP is a PIN. Nothing can stop a user driving it below the minimum at RUN TIME. If you make EXP runtime programmable from a register interface, clamp it in your own logic - the block will not complain, it will just stop emitting some results.

Worked numbers

Input IN_SW L minimum EXP
8 bit signed 8 11 + EXP 4 (N = 16)
8 bit unsigned 9 12 + EXP 4 (N = 16)
16 bit signed 16 19 + EXP 5 (N = 32)
32 bit signed 32 35 + EXP 6 (N = 64)

Take the first row in full. An 8 bit signed input gives $\mathrm{IN_SW} = 8$ and $L = 2 + 8 + \mathrm{EXP} + 1 = 11 + \mathrm{EXP}$ clocks. At $\mathrm{EXP} = 3$ that is $L = 14$ and $2^3 = 8 < 14$, so it does not fit; at $\mathrm{EXP} = 4$ it is $L = 15$ and $2^4 = 16 \ge 15$, so it does. The minimum usable EXP is 4, a block of 16 samples - and every larger exponent fits too, because $2^{\mathrm{EXP}}$ outruns $11 + \mathrm{EXP}$ from there on. With the default $\mathrm{EXP} = 10$ the tail is 21 clocks inside a 1024-sample block: over 98% idle.

Knowing where the block is: BUSY, INTEGRATING and SAMPLE_COUNT

Three optional status outputs, all defaulting to NO. They answer different questions:

INTEGRATING BUSY
accumulating the block 1 1
serial tail computing 0 1
idle 0 0

Every output of this block is a register, so each status bit is observed on the clock after the event that sets it:

  • INTEGRATING rises on the clock after the FIRST sample of a block is accepted and falls on the clock after the N-th - it is high exactly while the block is ACCUMULATING, and never during the tail.
  • BUSY covers the accumulation and the serial tail. It rises with INTEGRATING, stays high across the tail, and its LAST HIGH CLOCK IS THE OUT_DV PULSE; it falls on the clock after. BUSY high with INTEGRATING low therefore means “the samples are all in, I am computing”.
  • On a continuous stream the next block starts before the previous tail ends, so BUSY never drops and INTEGRATING dips for exactly one clock per block boundary - which makes it a free block marker. The two separate visibly only when the input pauses for longer than the tail.
  • SAMPLE_COUNT is a fixed 32 bits and reads 1 after the first accepted sample, N after the N-th. It is NOT cleared at the block end: it HOLDS the final count N through the whole tail and past OUT_DV, until the first sample of the next block takes it back to 1. So on the OUT_DV clock it reads the length of the block being presented - which is the useful thing to latch alongside the result. Only RESET clears it to 0.

Q formats

Both data ports carry their own fixed point format (integer bits, fractional bits, sign), the same convention as the Fixed P. family. The result is requantised into the VARIANCE format with the selected rounding (nearest / truncate) and overflow policy (saturate / wrap); saturation is symmetric for signed formats, as everywhere else in the toolchain.

Sizing: the variance is a SQUARE, so it needs about twice the integer bits of the input if you do not want it to saturate - which is why the default is 32 bits for a 16 bit input. It is never negative, so UNSIGNED is safe and buys one bit; that is the default too. Unlike Block RMS and Block Std Dev, the output width here costs nothing in clocks: there is no square root, so a wide VARIANCE format is paid for in registers only.

Cost

One multiplier for $x^2$ (unavoidable at one sample per clock), two accumulators ($S_1$ at $\mathrm{IN_SW} + $ Max Block Exponent bits, $S_2$ at $2,\mathrm{IN_SW} - 1 + $ Max Block Exponent), one shift-add stage with a product, an addend and a multiplier register, a barrel shifter for the two power-of-two shifts, and one requantiser. No divider, no second multiplier and no DSP in the tail.

Verification

The core is regression tested by a host-side csim harness (tb/block-ops/run_tb.ps1) that runs one simulated clock at a time and follows OUT_DV. The expected values come from tb/block-ops/gen_golden.py, which evaluates $\overline{x^2} - \mathrm{mean}^2$ in exact rational arithmetic and shares no algorithm with the core; the tolerance is 0. Variance coverage includes pseudo-random input, a constant block (variance exactly zero), an extremes pattern alternating maximum positive and maximum negative samples, a fractional output format, an EXP that alternates between blocks, and an unsigned input (which is the case that costs the extra IN_SW bit and therefore an extra tail clock). The status outputs are checked clock by clock against the contract above. A cross-check compiles this core and the all-in-one block_stats.cpp into the same binary, drives them with identical stimulus, and compares the two clock by clock; tb/block-ops/port_check.py preprocesses the real core to prove the symbol’s pin list matches the entity’s port list for every enable combination, and the harness #errors at COMPILE TIME if the tail formula in the .cpp, in the plugin and in the generator ever disagree.