Skip to main content

BendaHerzNeuron

sc_neurocore_engine::neurons::simple_spiking

Struct BendaHerzNeuron

pub struct BendaHerzNeuron {
    pub a: f64,
    pub phase: f64,
    pub onset_gain: f64,
    pub rheobase: f64,
    pub adaptation_slope: f64,
    pub tau_a: f64,
    pub dt: f64,
}

Expand description

Deterministic Benda–Herz universal rate-adaptation neuron.

Fields§

§a: f64

Adaptation variable.

§phase: f64

Phase of the deterministic spike generator in [0, 1).

§onset_gain: f64

Gain of f0(x) = onset_gain * sqrt(max(x-rheobase, 0)).

§rheobase: f64

Onset-current offset.

§adaptation_slope: f64

Slope in A_inf(f) = adaptation_slope * f.

§tau_a: f64

Adaptation time constant in milliseconds.

§dt: f64

Sample interval in milliseconds.

Implementations§

impl BendaHerzNeuron

pub fn new() -> Self

Construct the paper-example specialization at rest.

fn rate(&self, current: f64, a: f64) -> f64

fn rhs(&self, current: f64, a: f64) -> (f64, f64)

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

Advance one sample, returning -1 if validation fails atomically.

pub fn reset(&mut self)

Reset both source state variables.

pub fn valid(&self) -> bool

Validate parameters and state.

Trait Implementations§

impl Clone for BendaHerzNeuron

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

impl Debug for BendaHerzNeuron

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

Formats the value using the given formatter. Read more

impl Default for BendaHerzNeuron

fn default() -> Self

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

Auto Trait Implementations§

impl Freeze for BendaHerzNeuron

impl RefUnwindSafe for BendaHerzNeuron

impl Send for BendaHerzNeuron

impl Sync for BendaHerzNeuron

impl Unpin for BendaHerzNeuron

impl UnsafeUnpin for BendaHerzNeuron

impl UnwindSafe for BendaHerzNeuron

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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

impl<T> IntoEither for T

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

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

impl<T> Same for T

type Output = T

Should always be Self

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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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