Skip to main content

BranchingProcess

Struct BranchingProcess 

Source
pub struct BranchingProcess {
    pub z0: usize,
    pub mean_offspring: f64,
    /* private fields */
}
Expand description

Galton-Watson branching process.

Each individual in generation n independently produces a random number of offspring in generation n+1 according to an offspring distribution.

Fields§

§z0: usize

Initial population Z(0).

§mean_offspring: f64

Mean offspring per individual.

Implementations§

Source§

impl BranchingProcess

Source

pub fn poisson(z0: usize, lambda: f64, seed: u64) -> Self

Creates a new Galton-Watson process with Poisson offspring.

Source

pub fn geometric(z0: usize, p: f64, seed: u64) -> Self

Creates a new process with Geometric offspring.

Source

pub fn bernoulli(z0: usize, p: f64, seed: u64) -> Self

Creates a new process with Bernoulli offspring.

Source

pub fn simulate(&self, n_generations: usize) -> Vec<usize>

Simulate the process for n_generations generations.

Returns population sizes Z(0), Z(1), …, Z(n_generations).

Source

pub fn extinction_probability(&self) -> f64

Theoretical extinction probability for Poisson offspring.

For Poisson(lambda) offspring:

  • If lambda <= 1: extinction probability = 1.
  • If lambda > 1: extinction probability = q where q = exp(lambda*(q-1)). Solved iteratively.
Source

pub fn mc_extinction_probability( &self, n_paths: usize, n_generations: usize, ) -> f64

Estimate extinction probability by Monte Carlo simulation.

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