Skip to main content

DerivativeEncoder

Struct DerivativeEncoder 

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

Encodes based on the rate of change (derivative) of the input.

Fires an excitatory spike when the positive change exceeds a threshold, and an inhibitory spike when the negative change exceeds the threshold.

§Examples

use axon_encoder::prelude::*;
let mut enc = DerivativeEncoder::try_new(vec![0.2])?;
let _ = enc.encode_step(&[0.0]); // seed previous sample
let out = enc.encode_step(&[0.5]); // +0.5 change exceeds threshold
assert_eq!(out.spikes.len(), 1);
assert!(out.spikes[0].polarity);

Implementations§

Source§

impl DerivativeEncoder

Source

pub fn new(thresholds: Vec<f32>) -> Self

Creates a new DerivativeEncoder, panicking if configuration is invalid.

Prefer try_new for typed validation errors.

§Panics

Panics if any threshold is non-finite/negative or the channel count is too large.

Source

pub fn try_new(thresholds: Vec<f32>) -> Result<Self, EncoderError>

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

Each threshold must be finite and non-negative; channel count must fit u16 IDs.

Trait Implementations§

Source§

impl Clone for DerivativeEncoder

Source§

fn clone(&self) -> DerivativeEncoder

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 DerivativeEncoder

Source§

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

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

impl Encoder for DerivativeEncoder

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, current_values: &[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 PartialEq for DerivativeEncoder

Source§

fn eq(&self, other: &DerivativeEncoder) -> 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 DerivativeEncoder

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.