Struct DeltaEncoder 

pub struct DeltaEncoder { /* private fields */ }

A simple delta-based encoder.

Fires a spike when the absolute difference between the current input and the last encoded value exceeds a threshold. This is useful for event-based encoding where only changes in the input signal are relevant.

Mathematical Model

delta = |current_value - last_value|
spike if delta > threshold

When to Use

• Event-based encoding where changes are more important than absolute values
• Sensor data where baseline can drift but changes are meaningful
• Reducing power consumption by only encoding when changes occur

Parameters

• threshold: Minimum change required to trigger a spike
• num_channels: Number of input channels to track

Examples

use axon_encoder::prelude::*;
let mut enc = DeltaEncoder::try_new(0.1, 2)?;
// Baseline starts at zeros; last_values update only when a spike fires.
// A jump of 0.5 from 0 exceeds threshold 0.1 on channel 0.
let out = enc.encode(&[0.5, 0.0]);
assert!(!out.spikes.is_empty());

Implementations

impl DeltaEncoder

pub fn new(threshold: f32, num_channels: usize) -> Self

Creates a new DeltaEncoder, panicking if configuration is invalid.

Prefer try_new for typed validation errors.

pub fn try_new( threshold: f32, num_channels: usize, ) -> Result<Self, EncoderError>

Creates a new DeltaEncoder, returning an EncoderError for invalid configuration.

threshold == 0.0 is valid and means any nonzero change fires a spike (delta > 0).

pub fn encode_with_modulators( &mut self, input: &[f32], modulators: &NeuroModulators, gain_curves: &NeuromodulatorGainCurves, ) -> EncodedOutput

Encodes input using neuromodulator-driven gain curves.

Inherent wrapper so callers need not import ModulatedEncoder.

pub fn encode_step_with_modulators( &mut self, input: &[f32], modulators: &NeuroModulators, gain_curves: &NeuromodulatorGainCurves, ) -> EncodedOutput

Step-wise variant of encode_with_modulators.

Trait Implementations

impl Clone for DeltaEncoder

fn clone(&self) -> DeltaEncoder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeltaEncoder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encoder for DeltaEncoder

fn encode(&mut self, input: &[f32]) -> EncodedOutput

Encodes a slice of analog values into spike events (batch mode).

fn encode_step(&mut self, input: &[f32]) -> EncodedOutput

Encodes a single step incrementally (streaming mode).

fn reset(&mut self)

Resets the encoder to its initial state

impl ModulatedEncoder for DeltaEncoder

fn encode_with_gains( &mut self, input: &[f32], gains: EncodingGains, ) -> EncodedOutput

Encodes input using already evaluated encoding gains.

fn encode_step_with_gains( &mut self, input: &[f32], gains: EncodingGains, ) -> EncodedOutput

Encodes one streaming step using already evaluated encoding gains.

fn encode_with_modulators( &mut self, input: &[f32], modulators: &NeuroModulators, gain_curves: &NeuromodulatorGainCurves, ) -> EncodedOutput

Encodes input using neuromodulator-driven gain curves.

fn encode_step_with_modulators( &mut self, input: &[f32], modulators: &NeuroModulators, gain_curves: &NeuromodulatorGainCurves, ) -> EncodedOutput

Encodes one streaming step using neuromodulator-driven gain curves.

impl PartialEq for DeltaEncoder

fn eq(&self, other: &DeltaEncoder) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DeltaEncoder