Struct Network

Source

pub struct Network {
    pub spike_recorder: Option<SpikeRecorder>,
    pub voltage_recorder: Option<VoltageRecorder>,
    pub rate_recorder: Option<PopulationRateRecorder>,
    /* private fields */
}

Expand description

Neural network with multiple populations and projections.

Fields§

§spike_recorder: Option<SpikeRecorder>

Recorders

§voltage_recorder: Option<VoltageRecorder>§rate_recorder: Option<PopulationRateRecorder>

Implementations§

Source §

impl Network

Source

pub fn new(dt: f64) -> Result<Self>

Create a new empty network.

Source

pub fn add_population(&mut self, population: NeuralPopulation) -> usize

Add a population to the network.

Source

pub fn add_projection(&mut self, projection: Projection) -> usize

Add a projection between populations.

Source

pub fn add_stimulation( &mut self, pop_idx: usize, stim: Box<dyn Stimulation>, ) -> Result<()>

Add external stimulation to a population.

Source

pub fn enable_spike_recording(&mut self)

Enable spike recording.

Source

pub fn enable_voltage_recording(&mut self)

Enable voltage recording.

Source

pub fn enable_rate_recording(&mut self, window: f64)

Enable population rate recording.

Source

pub fn get_population(&self, idx: usize) -> Result<&NeuralPopulation>

Get a population by index.

Source

pub fn get_population_mut( &mut self, idx: usize, ) -> Result<&mut NeuralPopulation>

Get a mutable population by index.

Source

pub fn current_time(&self) -> f64

Get current simulation time.

Source

pub fn num_populations(&self) -> usize

Get number of populations.

Source

pub fn num_projections(&self) -> usize

Get number of projections.

Source

pub fn step(&mut self) -> Result<()>

Step the simulation forward by one time step.

Source

pub fn run(&mut self, duration: f64) -> Result<()>

Run simulation for a specified duration.

Source

pub fn reset(&mut self)

Reset the network to initial state.

Source

pub fn statistics(&self) -> NetworkStats

Get network statistics.

Auto Trait Implementations§

§

impl UnsafeUnpin for Network

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

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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 §