Struct LatencyEncoder 

pub struct LatencyEncoder { /* private fields */ }

Encodes analog values into latency-coded spike times

Each input channel produces exactly one positive spike whose timestamp is determined by the input strength within the configured range. Stronger inputs fire earlier. Values below the range minimum map to the latest possible spike at max_latency, and values above the range maximum map to timestamp 0.

Examples

use axon_encoder::prelude::*;
let mut enc = LatencyEncoder::try_new(10, (0.0, 1.0))?;
let out = enc.encode(&[1.0, 0.0]); // strong → early, weak → late
assert_eq!(out.spikes.len(), 2);
assert!(out.spikes[0].timestamp <= out.spikes[1].timestamp);

Implementations

impl LatencyEncoder

pub fn new(max_latency: u64, range: (f32, f32)) -> Self

Creates a new LatencyEncoder, panicking if configuration is invalid.

Prefer try_new for typed validation errors.

Panics

Panics if range.0 >= range.1 or either bound is non-finite.

max_latency == 0 is valid and emits every spike at timestamp 0 (instantaneous response).

pub fn try_new( max_latency: u64, range: (f32, f32), ) -> Result<Self, EncoderError>

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

max_latency == 0 is accepted and maps every input to timestamp 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 LatencyEncoder

fn clone(&self) -> LatencyEncoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LatencyEncoder

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

Formats the value using the given formatter.

impl Encoder for LatencyEncoder

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 LatencyEncoder

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 LatencyEncoder

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LatencyEncoder