Struct EncodingGains 

pub struct EncodingGains {
    pub threshold_scale: f32,
    pub sensitivity_scale: f32,
    pub firing_rate_scale: f32,
    pub latency_scale: f32,
}

Scales produced by neuromodulator gain curves for each encoder component.

Zero-gain semantics

The meaning of a 0.0 gain depends on the component:

• threshold_scale = 0.0 → effective threshold is 0 → every input spikes (maximum sensitivity)
• sensitivity_scale = 0.0 → output is suppressed (no spikes for PopulationEncoder)
• firing_rate_scale = 0.0 → firing rate is 0 → no spikes (silence)
• latency_scale = 0.0 → max_latency is 0 → all spikes at timestamp 0 (instant response)

This asymmetry is intentional and reflects the physical semantics of each component.

Examples

use axon_encoder::prelude::*;

let gains = EncodingGains {
    firing_rate_scale: 0.0, // silence rate-based paths
    ..EncodingGains::identity()
}
.sanitize();
assert_eq!(gains.firing_rate_scale, 0.0);

Fields

threshold_scale: f32

sensitivity_scale: f32

firing_rate_scale: f32

latency_scale: f32

Implementations

impl EncodingGains

pub fn identity() -> Self

pub fn sanitize(self) -> Self

Clamps non-finite and out-of-range gain components to safe defaults.

Trait Implementations

impl Clone for EncodingGains

fn clone(&self) -> EncodingGains

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EncodingGains

impl Debug for EncodingGains

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

Formats the value using the given formatter.

impl Default for EncodingGains

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for EncodingGains

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EncodingGains