Skip to main content

MATNeuron

sc_neurocore_engine::neurons::trivial::mat

Struct MATNeuron 

Source 
pub struct MATNeuron {
Show 13 fields
    pub v: f64,
    pub theta1: f64,
    pub theta2: f64,
    pub refractory_remaining: f64,
    pub omega: f64,
    pub tau_m: f64,
    pub tau_1: f64,
    pub tau_2: f64,
    pub alpha_1: f64,
    pub alpha_2: f64,
    pub resistance: f64,
    pub refractory_period: f64,
    pub dt: f64,

}
Expand description

Complete MAT* dynamic state and configuration.

Voltage is relative to rest and is never reset. Units are millivolts, milliseconds, nanoamps, and megaohms. The defaults are the regular-spiking example in Kobayashi, Tsubo, and Shinomoto (2009), not a universal cell fit.

Fields§

§v: f64

Membrane voltage relative to rest, in mV.

§theta1: f64

Fast spike-history threshold contribution, in mV.

§theta2: f64

Slow spike-history threshold contribution, in mV.

§refractory_remaining: f64

Remaining absolute refractory interval, in ms.

§omega: f64

Baseline threshold omega, in mV.

§tau_m: f64

Membrane time constant, in ms.

§tau_1: f64

Fast threshold-history time constant, in ms.

§tau_2: f64

Slow threshold-history time constant, in ms.

§alpha_1: f64

Fast post-spike threshold increment, in mV.

§alpha_2: f64

Slow post-spike threshold increment, in mV.

§resistance: f64

Membrane resistance, in megaohms.

§refractory_period: f64

Absolute refractory duration, in ms.

§dt: f64

Euler integration step, in ms.

Implementations§

Source§

impl MATNeuron

Source

pub fn new() -> Self

Construct the paper’s regular-spiking example profile.

Source

pub fn intrinsically_bursting() -> Self

Return the paper’s intrinsically-bursting example profile.

Source

pub fn fast_spiking() -> Self

Return the paper’s fast-spiking example profile.

Source

pub fn threshold(&self) -> f64

Return the instantaneous adaptive threshold, in mV.

Source

pub fn validate(&self) -> bool

Return whether all state and configuration invariants hold.

Source

pub fn try_step(&mut self, current: f64) -> Result<i32, &'static str>

Advance one atomic MAT* step.

Voltage uses forward Euler and both threshold-history terms use exact exponential decay. A spike never resets voltage. Invalid input or a candidate outside the safety envelope returns an error without mutation.

Source

pub fn step(&mut self, current: f64) -> i32

Advance one engine-adapter step; invalid state returns no event.

Source

pub fn reset(&mut self)

Reset dynamic state while preserving the configured profile.

Trait Implementations§

Source§

impl Clone for MATNeuron

Source§

fn clone(&self) -> Self

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 MATNeuron

Source§

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

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

impl Default for MATNeuron

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for MATNeuron

Source§

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

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.

§

impl<T, A> IntoAst<A> for T
where T: Into<A>, A: Ast,

§

fn into_ast(self, _a: &A) -> A

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

§

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

§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
§

impl<T> Ungil for T
where T: Send,

§

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

§

fn vzip(self) -> V