Struct NutsSettings

Source

pub struct NutsSettings<A: Debug + Copy + Default> {
    pub num_tune: u64,
    pub num_draws: u64,
    pub maxdepth: u64,
    pub store_gradient: bool,
    pub store_unconstrained: bool,
    pub max_energy_error: f64,
    pub store_divergences: bool,
    pub adapt_options: A,
    pub check_turning: bool,
    pub num_chains: usize,
    pub seed: u64,
}

Expand description

Settings for the NUTS sampler

Fields§

§num_tune: u64

The number of tuning steps, where we fit the step size and mass matrix.

§num_draws: u64

The number of draws after tuning

§maxdepth: u64

The maximum tree depth during sampling. The number of leapfrog steps is smaller than 2 ^ maxdepth.

§store_gradient: bool

Store the gradient in the SampleStats

§store_unconstrained: bool

Store each unconstrained parameter vector in the sampler stats

§max_energy_error: f64

If the energy error is larger than this threshold we treat the leapfrog step as a divergence.

§store_divergences: bool

Store detailed information about each divergence in the sampler stats

§adapt_options: A

Settings for mass matrix adaptation.

§check_turning: bool§num_chains: usize§seed: u64

Trait Implementations§

Source §

impl<A: Clone + Debug + Copy + Default> Clone for NutsSettings<A>

Source §

fn clone(&self) -> NutsSettings<A>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<A: Debug + Debug + Copy + Default> Debug for NutsSettings<A>

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<A: Copy + Debug + Copy + Default> Copy for NutsSettings<A>

Auto Trait Implementations§

§

impl<A> UnwindSafe for NutsSettings<A>
where A: UnwindSafe,

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> ByRef<T> for T

Source §

fn by_ref(&self) -> &T

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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §