Skip to main content

SirRun

Struct SirRun 

Source
pub struct SirRun {
    pub times: Vec<f64>,
    pub susceptible: Vec<i64>,
    pub infected: Vec<i64>,
    pub recovered: Vec<i64>,
}
Expand description

The outcome of one run of the SIR epidemic model (the owned counterpart of igraph_sir_t), as returned by Graph::sir.

The four vectors have the same length: entry k describes the state of the population right after the k-th event (an infection or a recovery). Entry 0 is the initial state, at time 0, with a single infected individual; the last entry is the moment the last infected individual recovers. At every step susceptible + infected + recovered equals the number of vertices of the graph.

Fields§

§times: Vec<f64>

The (continuous) times of the events, starting at 0.0, non-decreasing.

§susceptible: Vec<i64>

Number of susceptible individuals after each event.

§infected: Vec<i64>

Number of infected individuals after each event.

§recovered: Vec<i64>

Number of recovered individuals after each event.

Implementations§

Source§

impl SirRun

Source

pub fn len(&self) -> usize

Number of recorded states (events plus the initial state).

Source

pub fn is_empty(&self) -> bool

Whether no state was recorded (never the case for runs produced by igraph).

Source

pub fn duration(&self) -> f64

The time at which the epidemic died out (the time of the last event).

Source

pub fn final_size(&self) -> i64

The final size of the epidemic: how many individuals were ever infected (they have all recovered at the end).

Source

pub fn peak_infected(&self) -> i64

The largest number of simultaneously infected individuals.

Source

pub fn states(&self) -> impl Iterator<Item = (f64, i64, i64, i64)> + '_

Iterates over (time, susceptible, infected, recovered) tuples.

Trait Implementations§

Source§

impl Clone for SirRun

Source§

fn clone(&self) -> SirRun

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 SirRun

Source§

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

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

impl From<igraph_sir_t> for SirRun

Source§

fn from(sir: igraph_sir_t) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for SirRun

Source§

fn eq(&self, other: &SirRun) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SirRun

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.

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