Skip to main content

PopulationEncoder

Struct PopulationEncoder 

Source
pub struct PopulationEncoder { /* private fields */ }
Expand description

Encodes a single analog value across a population of neurons

Each neuron in the population is “tuned” to a specific preferred value within the input range. The neuron fires based on a Gaussian-like tuning curve centered on its preferred value. This creates a distributed representation where multiple neurons contribute to encoding a single input value

§Mathematical Model

Uses a Gaussian tuning curve to determine each neuron’s firing rate:

preferred_value[i] = range_min + (i / num_neurons) * (range_max - range_min)
distance = |input - preferred_value[i]|
rate = exp(-distance² / (2 * tuning_width²))
spike if random() < rate

§When to Use

  • Encoding position or continuous values with distributed representation
  • When multiple neurons should contribute to representing a single value
  • Creating more robust encoding that doesn’t rely on a single neuron

§Parameters

  • num_neurons: Number of neurons in the population per input channel
  • input_range: Tuple of (min, max) input values
  • tuning_width: Controls how broadly neurons respond (larger = wider spread)

§Examples

use axon_encoder::prelude::*;
let mut enc = PopulationEncoder::try_new(8, (0.0, 1.0), 0.15)?;
// Population encoders take a single scalar in the first channel.
let out = enc.encode(&[0.5]);
assert!(out.spikes.len() <= 8);

Implementations§

Source§

impl PopulationEncoder

Source

pub fn new( num_neurons: usize, input_range: (f32, f32), tuning_width: f32, ) -> Self

Creates a new PopulationEncoder, panicking if configuration is invalid.

Prefer try_new for typed validation errors.

Source

pub fn try_new( num_neurons: usize, input_range: (f32, f32), tuning_width: f32, ) -> Result<Self, EncoderError>

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

Source

pub fn num_neurons(&self) -> usize

Returns the number of neurons in the population

Source

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.

Source

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§

Source§

impl Clone for PopulationEncoder

Source§

fn clone(&self) -> PopulationEncoder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PopulationEncoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Encoder for PopulationEncoder

Source§

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

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

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

Encodes a single step incrementally (streaming mode). Read more
Source§

fn reset(&mut self)

Resets the encoder to its initial state
Source§

impl ModulatedEncoder for PopulationEncoder

Source§

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

Encodes input using already evaluated encoding gains. Read more
Source§

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

Encodes one streaming step using already evaluated encoding gains. Read more
Source§

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

Encodes input using neuromodulator-driven gain curves.
Source§

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

Encodes one streaming step using neuromodulator-driven gain curves.
Source§

impl PartialEq for PopulationEncoder

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PopulationEncoder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.