Struct CatCTBN 

pub struct CatCTBN { /* private fields */ }

A categorical continuous time Bayesian network.

Implementations

impl CatCTBN

pub fn name(&self) -> Option<&str>

Returns the name of the model, if any.

Returns

The name of the model, if it exists.

pub fn description(&self) -> Option<&str>

Returns the description of the model, if any.

Returns

The description of the model, if it exists.

pub const fn states(&self) -> &States

Returns the states of the variables.

Returns

A reference to the states of the variables.

Trait Implementations

impl AbsDiffEq for CatCTBN

type Epsilon = f64

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl CTBN for CatCTBN

type CIM = CatCIM

The type of the CIM.

type InitialDistribution = CatBN

The type of the initial distribution.

type Event = (f64, ArrayBase<OwnedRepr<u8>, Dim<[usize; 1]>>)

The type of the observed event.

type Trajectory = CatTrj

The type of the observed trajectory.

type Trajectories = CatTrjs

The type of a collection of trajectories.

fn new<I>(graph: DiGraph, cims: I) -> Self

where I: IntoIterator<Item = Self::CIM>,

Constructs a new CTBN.

fn initial_distribution(&self) -> &Self::InitialDistribution

Returns the initial distribution.

fn graph(&self) -> &DiGraph

Returns the underlying graph.

fn cims(&self) -> &Map<String, Self::CIM>

Returns the a map labels-distributions.

fn parameters_size(&self) -> usize

Returns the parameters size.

fn with_optionals<I>( name: Option<String>, description: Option<String>, initial_distribution: Self::InitialDistribution, graph: DiGraph, cims: I, ) -> Self

where I: IntoIterator<Item = Self::CIM>,

Creates a new categorical continuous-time Bayesian network with optional fields.

impl<R: Rng> CTBNSampler<CatCTBN> for ForwardSampler<'_, R, CatCTBN>

type Sample = <CatCTBN as CTBN>::Trajectory

The sample type.

type Samples = <CatCTBN as CTBN>::Trajectories

The samples type.

fn sample_by_length(&self, max_length: usize) -> Self::Sample

Sample a single trajectory with a given length from a CTBN.

fn sample_by_time(&self, max_time: f64) -> Self::Sample

Sample a single trajectory with a given time from a CTBN.

fn sample_by_length_or_time( &self, max_length: usize, max_time: f64, ) -> Self::Sample

Sample a single trajectory with a given length or time from a CTBN.

fn sample_n_by_length(&self, max_length: usize, n: usize) -> Self::Samples

Sample multiple trajectories with a given length from a CTBN.

fn sample_n_by_time(&self, max_time: f64, n: usize) -> Self::Samples

Sample multiple trajectories with a given time from a CTBN.

fn sample_n_by_length_or_time( &self, max_length: usize, max_time: f64, n: usize, ) -> Self::Samples

Sample multiple trajectories with a given length or time from a CTBN.

impl<R: Rng> CTBNSampler<CatCTBN> for ImportanceSampler<'_, R, CatCTBN, CatTrjEv>

type Sample = CatWtdTrj

The sample type.

type Samples = CatWtdTrjs

The samples type.

fn sample_by_length(&self, max_length: usize) -> Self::Sample

Sample a single trajectory with a given length from a CTBN.

fn sample_by_time(&self, max_time: f64) -> Self::Sample

Sample a single trajectory with a given time from a CTBN.

fn sample_by_length_or_time( &self, max_length: usize, max_time: f64, ) -> Self::Sample

Sample a single trajectory with a given length or time from a CTBN.

fn sample_n_by_length(&self, max_length: usize, n: usize) -> Self::Samples

Sample multiple trajectories with a given length from a CTBN.

fn sample_n_by_time(&self, max_time: f64, n: usize) -> Self::Samples

Sample multiple trajectories with a given time from a CTBN.

fn sample_n_by_length_or_time( &self, max_length: usize, max_time: f64, n: usize, ) -> Self::Samples

Sample multiple trajectories with a given length or time from a CTBN.

impl Clone for CatCTBN

fn clone(&self) -> CatCTBN

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CatCTBN

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CatCTBN

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonIO for CatCTBN

fn from_json(json: &str) -> Self

Create an instance of the type from a JSON string.

fn to_json(&self) -> String

Convert the instance to a JSON string.

fn read_json(path: &str) -> Self

Create an instance of the type from a JSON file.

fn write_json(&self, path: &str)

Write the instance to a JSON file.

impl Labelled for CatCTBN

fn labels(&self) -> &Labels

Returns the labels of the variables.

fn label_to_index(&self, x: &str) -> usize

Return the variable index for a given label.

fn index_to_label(&self, x: usize) -> &str

Return the label for a given variable index.

fn index_to(&self, x: usize, other: &Labels) -> usize

Maps an index from this model to another model with the same label.

fn indices_to(&self, x: &Set<usize>, other: &Labels) -> Set<usize>

Maps a set of indices from this model to another model with the same labels.

fn index_from(&self, x: usize, other: &Labels) -> usize

Maps an index from another model to this model with the same label.

fn indices_from(&self, x: &Set<usize>, other: &Labels) -> Set<usize>

Maps a set of indices from another model to this model with the same labels.

impl<R: Rng + SeedableRng> ParCTBNSampler<CatCTBN> for ForwardSampler<'_, R, CatCTBN>

type Samples = <CatCTBN as CTBN>::Trajectories

The samples type.

fn par_sample_n_by_length(&self, max_length: usize, n: usize) -> Self::Samples

Sample multiple trajectories with a given length from a CTBN in parallel.

fn par_sample_n_by_time(&self, max_time: f64, n: usize) -> Self::Samples

Sample multiple trajectories with a given time from a CTBN in parallel.

fn par_sample_n_by_length_or_time( &self, max_length: usize, max_time: f64, n: usize, ) -> Self::Samples

Sample multiple trajectories with a given length or time from a CTBN in parallel.

impl<R: Rng + SeedableRng> ParCTBNSampler<CatCTBN> for ImportanceSampler<'_, R, CatCTBN, CatTrjEv>

type Samples = CatWtdTrjs

The samples type.

fn par_sample_n_by_length(&self, max_length: usize, n: usize) -> Self::Samples

Sample multiple trajectories with a given length from a CTBN in parallel.

fn par_sample_n_by_time(&self, max_time: f64, n: usize) -> Self::Samples

Sample multiple trajectories with a given time from a CTBN in parallel.

fn par_sample_n_by_length_or_time( &self, max_length: usize, max_time: f64, n: usize, ) -> Self::Samples

Sample multiple trajectories with a given length or time from a CTBN in parallel.

impl PartialEq for CatCTBN

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RelativeEq for CatCTBN

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl Serialize for CatCTBN

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.