SpikingNeuralClusterer

Struct SpikingNeuralClusterer 

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

Spiking neural network clusterer

This clusterer uses a network of spiking neurons with STDP learning to perform unsupervised clustering of spatial data. Input points are encoded as spike trains and presented to the network, which learns to respond selectively to different input patterns through competitive dynamics.

§Features

  • Rate coding for spatial data encoding
  • STDP learning for adaptive weights
  • Lateral inhibition for competitive dynamics
  • Configurable network architecture
  • Spike timing analysis

§Example

use scirs2_core::ndarray::Array2;
use scirs2_spatial::neuromorphic::algorithms::SpikingNeuralClusterer;

let points = Array2::from_shape_vec((4, 2), vec![
    0.0, 0.0, 1.0, 0.0, 0.0, 1.0, 1.0, 1.0
]).unwrap();

let mut clusterer = SpikingNeuralClusterer::new(2)
    .with_spike_threshold(0.8)
    .with_stdp_learning(true)
    .with_lateral_inhibition(true);

let (assignments, spike_events) = clusterer.fit(&points.view()).unwrap();
println!("Cluster assignments: {:?}", assignments);

Implementations§

Source§

impl SpikingNeuralClusterer

Source

pub fn new(num_clusters: usize) -> Self

Create new spiking neural clusterer

§Arguments
  • num_clusters - Number of clusters to discover
§Returns

A new SpikingNeuralClusterer with default parameters

Source

pub fn with_spike_threshold(self, threshold: f64) -> Self

Configure spike threshold

§Arguments
  • threshold - Spike threshold for neurons
Source

pub fn with_stdp_learning(self, enabled: bool) -> Self

Enable/disable STDP learning

§Arguments
  • enabled - Whether to enable STDP learning
Source

pub fn with_lateral_inhibition(self, enabled: bool) -> Self

Enable/disable lateral inhibition

§Arguments
  • enabled - Whether to enable lateral inhibition
Source

pub fn with_training_params( self, max_epochs: usize, simulation_duration: f64, ) -> Self

Configure training parameters

§Arguments
  • max_epochs - Maximum number of training epochs
  • simulation_duration - Duration to simulate per data point
Source

pub fn with_time_step(self, dt: f64) -> Self

Configure simulation time step

§Arguments
  • dt - Time step for simulation
Source

pub fn fit( &mut self, points: &ArrayView2<'_, f64>, ) -> SpatialResult<(Array1<usize>, Vec<SpikeEvent>)>

Fit clustering to spatial data

Trains the spiking neural network on the provided spatial data using STDP learning and competitive dynamics to discover cluster structure.

§Arguments
  • points - Input points to cluster (n_points × n_dims)
§Returns

Tuple of (cluster assignments, spike events) where assignments maps each point to its cluster and spike_events contains the complete spike timing history.

Source

pub fn num_clusters(&self) -> usize

Get number of clusters

Source

pub fn spike_threshold(&self) -> f64

Get spike threshold

Source

pub fn is_stdp_enabled(&self) -> bool

Check if STDP learning is enabled

Source

pub fn is_lateral_inhibition_enabled(&self) -> bool

Check if lateral inhibition is enabled

Source

pub fn spike_history(&self) -> &[SpikeEvent]

Get current spike history

Source

pub fn network_stats(&self) -> NetworkStats

Get network statistics

Source

pub fn reset(&mut self)

Reset the network to initial state

Trait Implementations§

Source§

impl Clone for SpikingNeuralClusterer

Source§

fn clone(&self) -> SpikingNeuralClusterer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpikingNeuralClusterer

Source§

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

Formats the value using the given formatter. Read more

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V