Skip to main content

AdvancedAmountSampler

Enum AdvancedAmountSampler 

Source
pub enum AdvancedAmountSampler {
    LogNormal(LogNormalMixtureSampler),
    Gaussian(GaussianMixtureSampler),
    Pareto(ParetoSampler),
}
Expand description

Advanced amount sampler wrapping one of the supported distribution families. Callers keep their existing legacy [AmountSampler](super:: AmountSampler) and only consult this wrapper when distributions.amounts.enabled (or another advanced sub-block like distributions.pareto.enabled) is true.

v3.4.4 added the Pareto variant for heavy-tailed monetary samples (capex, strategic contracts, fraud amounts).

Variants§

§

LogNormal(LogNormalMixtureSampler)

Log-normal mixture (preferred for positive monetary amounts).

§

Gaussian(GaussianMixtureSampler)

Gaussian mixture (useful for signed quantities like deltas).

§

Pareto(ParetoSampler)

Pareto heavy-tailed distribution (v3.4.4+).

Implementations§

Source§

impl AdvancedAmountSampler

Source

pub fn new_log_normal( seed: u64, config: LogNormalMixtureConfig, ) -> Result<Self, String>

Create a log-normal-mixture sampler.

Source

pub fn new_gaussian( seed: u64, config: GaussianMixtureConfig, ) -> Result<Self, String>

Create a Gaussian-mixture sampler.

Source

pub fn new_pareto(seed: u64, config: ParetoConfig) -> Result<Self, String>

Create a Pareto sampler (v3.4.4+).

Source

pub fn sample_decimal(&mut self) -> Decimal

Sample one amount as Decimal.

Source

pub fn reset(&mut self, seed: u64)

Reset the underlying RNG.

Source

pub fn ppf_decimal(&self, u: f64) -> Decimal

v4.1.6+ inverse CDF (quantile function) — returns the Decimal quantile at uniform u ∈ (0, 1) for whichever underlying sampler is active. Gaussian variant clamps negatives to zero (monetary-amount semantics).

Trait Implementations§

Source§

impl Clone for AdvancedAmountSampler

Source§

fn clone(&self) -> AdvancedAmountSampler

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

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more