Trait Settings 

pub trait Settings:
    Sealed
    + Clone
    + Copy
    + Default
    + Sync
    + Send
    + Serialize
    + DeserializeOwned
    + 'static {
    type Chain<M: Math>: Chain<M>;

    // Required methods
    fn new_chain<M: Math, R: Rng + ?Sized>(
        &self,
        chain: u64,
        math: M,
        rng: &mut R,
    ) -> Self::Chain<M>;
    fn hint_num_tune(&self) -> usize;
    fn hint_num_draws(&self) -> usize;
    fn num_chains(&self) -> usize;
    fn seed(&self) -> u64;
    fn stats_options<M: Math>(
        &self,
    ) -> <Self::Chain<M> as SamplerStats<M>>::StatsOptions;
    fn sampler_name(&self) -> &'static str;
    fn adaptation_name(&self) -> &'static str;

    // Provided methods
    fn stat_names<M: Math>(&self, math: &M) -> Vec<String> { ... }
    fn data_names<M: Math>(&self, math: &M) -> Vec<String> { ... }
    fn stat_types<M: Math>(&self, math: &M) -> Vec<(String, ItemType)> { ... }
    fn stat_type<M: Math>(&self, math: &M, name: &str) -> ItemType { ... }
    fn data_types<M: Math>(&self, math: &M) -> Vec<(String, ItemType)> { ... }
    fn data_type<M: Math>(&self, math: &M, name: &str) -> ItemType { ... }
    fn stat_dims_all<M: Math>(&self, math: &M) -> Vec<(String, Vec<String>)> { ... }
    fn stat_dims<M: Math>(&self, math: &M, name: &str) -> Vec<String> { ... }
    fn stat_dim_sizes<M: Math>(&self, math: &M) -> HashMap<String, u64> { ... }
    fn data_dims_all<M: Math>(&self, math: &M) -> Vec<(String, Vec<String>)> { ... }
    fn data_dims<M: Math>(&self, math: &M, name: &str) -> Vec<String> { ... }
    fn stat_coords<M: Math>(&self, math: &M) -> HashMap<String, Value> { ... }
    fn stat_event_dims<M: Math>(
        &self,
        math: &M,
    ) -> Vec<(String, Option<String>)> { ... }
}

All sampler configurations implement this trait

Required Associated Types

type Chain<M: Math>: Chain<M>

Required Methods

fn new_chain<M: Math, R: Rng + ?Sized>( &self, chain: u64, math: M, rng: &mut R, ) -> Self::Chain<M>

fn hint_num_tune(&self) -> usize

fn hint_num_draws(&self) -> usize

fn num_chains(&self) -> usize

fn seed(&self) -> u64

fn stats_options<M: Math>( &self, ) -> <Self::Chain<M> as SamplerStats<M>>::StatsOptions

fn sampler_name(&self) -> &'static str

fn adaptation_name(&self) -> &'static str

Provided Methods

fn stat_names<M: Math>(&self, math: &M) -> Vec<String>

fn data_names<M: Math>(&self, math: &M) -> Vec<String>

fn stat_types<M: Math>(&self, math: &M) -> Vec<(String, ItemType)>

fn stat_type<M: Math>(&self, math: &M, name: &str) -> ItemType

fn data_types<M: Math>(&self, math: &M) -> Vec<(String, ItemType)>

fn data_type<M: Math>(&self, math: &M, name: &str) -> ItemType

fn stat_dims_all<M: Math>(&self, math: &M) -> Vec<(String, Vec<String>)>

fn stat_dims<M: Math>(&self, math: &M, name: &str) -> Vec<String>

fn stat_dim_sizes<M: Math>(&self, math: &M) -> HashMap<String, u64>

fn data_dims_all<M: Math>(&self, math: &M) -> Vec<(String, Vec<String>)>

fn data_dims<M: Math>(&self, math: &M, name: &str) -> Vec<String>

fn stat_coords<M: Math>(&self, math: &M) -> HashMap<String, Value>

fn stat_event_dims<M: Math>(&self, math: &M) -> Vec<(String, Option<String>)>

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Settings for DiagMclmcSettings

type Chain<M: Math> = MclmcChain<M, ChaCha8Rng, GlobalStrategy<M, Strategy<M>>, DiagMassMatrix<M>>

impl Settings for DiagNutsSettings

type Chain<M: Math> = NutsChain<M, ChaCha8Rng, GlobalStrategy<M, Strategy<M>>>

impl Settings for FlowMclmcSettings

type Chain<M: Math> = MclmcChain<M, ChaCha8Rng, ExternalTransformAdaptation, ExternalTransformation<M>>

impl Settings for FlowNutsSettings

type Chain<M: Math> = NutsChain<M, ChaCha8Rng, ExternalTransformAdaptation>

impl Settings for LowRankMclmcSettings

type Chain<M: Math> = MclmcChain<M, ChaCha8Rng, GlobalStrategy<M, LowRankMassMatrixStrategy>, LowRankMassMatrix<M>>

impl Settings for LowRankNutsSettings

type Chain<M: Math> = NutsChain<M, ChaCha8Rng, GlobalStrategy<M, LowRankMassMatrixStrategy>>