Struct PhaseEncoder 

pub struct PhaseEncoder { /* private fields */ }

Encodes analog values as phase-locked spikes within a repeating oscillation cycle

Each input channel produces at most one positive spike per call, with the spike timestamp positioned relative to the current background phase according to the normalized input value. Higher values map to later phase bins

Timestamps are computed as current_phase + phase_offset, which keeps ordering stable within a single encode call (higher-value channels get later timestamps) Ordering across calls is not globally guaranteed, since phase_offset can exceed the per-call phase advance. Cycle-relative phase is recoverable as timestamp % cycle_steps.

Examples

use axon_encoder::prelude::*;
let mut enc = PhaseEncoder::try_new(16, (0.0, 1.0))?;
let out = enc.encode(&[0.0, 1.0]);
assert_eq!(out.spikes.len(), 2);

Implementations

impl PhaseEncoder

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

Creates a new PhaseEncoder, panicking if configuration is invalid.

Prefer try_new for typed validation errors.

Panics

Panics if cycle_steps == 0 or if range bounds are non-finite or range.0 >= range.1.

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

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

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 PhaseEncoder

fn clone(&self) -> PhaseEncoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PhaseEncoder

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

Formats the value using the given formatter.

impl Encoder for PhaseEncoder

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 PhaseEncoder

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 PhaseEncoder

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PhaseEncoder