Skip to main content

McConvergence

Struct McConvergence 

Source
pub struct McConvergence {
    pub level: ConfidenceLevel,
    pub target_half_width: f64,
    pub min_samples: u64,
    pub max_samples: u64,
    pub batch_size: u64,
}
Expand description

How precise the hit probability has to get, and how much sampling may be spent getting there.

Default reproduces the legacy fixed-count run’s sample size as the floor (min_samples: 1_000, which is MonteCarloParams::default’s num_simulations) and then keeps going, in batches, until the interval is tight enough or the ceiling is hit.

Fields§

§level: ConfidenceLevel

Confidence level of the reported interval.

§target_half_width: f64

Stop once the confidence sequence’s half-width is at or below this, in probability units. 0.02 means “the hit probability is known to about +-2 percentage points”.

§min_samples: u64

Never stop before this many trials, even if the interval is already tight. Guards against an early run of all-hits or all-misses producing a narrow interval off a handful of trials.

§max_samples: u64

Never run more than this many trials, even if the interval is still wide. This is what bounds the wall time of an unreachable target_half_width.

§batch_size: u64

How many trials to run between convergence checks. Larger batches check less often (a bounds() call is two 200-step bisections); smaller batches can stop sooner.

Implementations§

Source§

impl McConvergence

Source

pub fn validate(&self) -> Result<(), String>

Rejects a configuration that cannot produce a meaningful run, naming the offending field.

Checked once up front rather than defended against inside the loop: a zero batch_size would spin forever making no progress, and a non-positive or NaN target_half_width can never be met, so both would surface as a hang or a silent max-samples cap instead of an error the caller can read. NaN is caught by the is_finite test – NaN <= 0.0 is false, so a bare comparison would let it through.

Trait Implementations§

Source§

impl Clone for McConvergence

Source§

fn clone(&self) -> McConvergence

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 McConvergence

Source§

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

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

impl Default for McConvergence

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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