Struct BirthDeath 

pub struct BirthDeath<T: FloatExt = f64, X: RealExt = T> { /* private fields */ }

Birth-death process.

Mathematical Formulation

A birth-death process tracks a population whose state increases by one at birth events and decreases by one at death events.

Implementations

impl<T: FloatExt, X: RealExt> BirthDeath<T, X>

pub fn new(lambda: T, mu: T) -> XResult<Self>

Create a new BirthDeath

Arguments

• lambda - The rate of birth.
• mu - The rate of death.

Example

use diffusionx::simulation::point::BirthDeath;

let birth_death = BirthDeath::new(1.0, 1.0).unwrap();

pub fn get_lambda(&self) -> T

Get the rate of birth

pub fn get_mu(&self) -> T

Get the rate of death

Trait Implementations

impl<T: Clone + FloatExt, X: Clone + RealExt> Clone for BirthDeath<T, X>

fn clone(&self) -> BirthDeath<T, X>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + FloatExt, X: Debug + RealExt> Debug for BirthDeath<T, X>

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

Formats the value using the given formatter.

impl<T: FloatExt, X: RealExt + Neg<Output = X>> PointProcess<T, X> for BirthDeath<T, X>

where Exp1: Distribution<T>,

fn simulate_with_step(&self, num_step: usize) -> XResult<(Vec<T>, Vec<X>)>

Simulate the birth-death process with a given number of events.

Arguments

• num_step - The number of birth or death events.

Example

use diffusionx::simulation::{point::BirthDeath, prelude::*};

let birth_death = BirthDeath::new(1.0, 1.0).unwrap();
let (t, x) = birth_death.simulate_with_step(100).unwrap();

fn start(&self) -> X

Get the starting position.

fn end(&self, duration: T) -> XResult<X>

Get the ending position at the requested duration.

fn displacement(&self, duration: T) -> XResult<X>

Get the displacement of the point process.

fn simulate_with_duration(&self, duration: T) -> XResult<(Vec<T>, Vec<X>)>

where Self: Sized,

Simulate the point process up to a fixed duration.

fn mean(&self, duration: T, particles: usize) -> XResult<f64>

where Self: Sized + Clone + PointTrajectoryTrait<T, X>,

Get the mean of the point process

fn msd(&self, duration: T, particles: usize) -> XResult<f64>

where Self: Sized + Clone + PointTrajectoryTrait<T, X>,

Get the mean square displacement of the point process

fn raw_moment(&self, duration: T, order: i32, particles: usize) -> XResult<f64>

where Self: Sized + Clone + PointTrajectoryTrait<T, X>,

Get the raw moment of the point process

fn central_moment( &self, duration: T, order: i32, particles: usize, ) -> XResult<f64>

where Self: Sized + Clone + PointTrajectoryTrait<T, X>,

Get the central moment of the point process

fn frac_raw_moment( &self, duration: T, order: f64, particles: usize, ) -> XResult<f64>

where Self: Sized + Clone + PointTrajectoryTrait<T, X>,

Get the fractional raw moment of the point process

fn frac_central_moment( &self, duration: T, order: f64, particles: usize, ) -> XResult<f64>

where Self: Sized + Clone + PointTrajectoryTrait<T, X>,

Get the fractional central moment of the point process

fn fpt(&self, domain: (X, X), max_duration: T) -> XResult<Option<T>>

where Self: Sized + Clone,

Get the first passage time of the point process

fn occupation_time(&self, domain: (X, X), duration: T) -> XResult<T>

where Self: Sized + Clone,

Get the occupation time of the point process