pub struct ParetoSampler { /* private fields */ }Expand description
Pareto distribution sampler.
Implementations§
Source§impl ParetoSampler
impl ParetoSampler
Sourcepub fn new(seed: u64, config: ParetoConfig) -> Result<Self, String>
pub fn new(seed: u64, config: ParetoConfig) -> Result<Self, String>
Create a new Pareto sampler.
Sourcepub fn sample_decimal(&mut self) -> Decimal
pub fn sample_decimal(&mut self) -> Decimal
Sample a value as Decimal.
Sourcepub fn ppf(&self, u: f64) -> f64
pub fn ppf(&self, u: f64) -> f64
v4.1.6+: inverse CDF (quantile function). Given u ∈ (0, 1)
returns the Pareto quantile x_min * (1-u)^(-1/α) clamped by
max_value and rounded to decimal_places. Used by the
copula-correlation path to turn a copula’s uniform draws into
rank-preserving amount samples.
Sourcepub fn ppf_decimal(&self, u: f64) -> Decimal
pub fn ppf_decimal(&self, u: f64) -> Decimal
v4.1.6+: inverse CDF as Decimal.
Sourcepub fn config(&self) -> &ParetoConfig
pub fn config(&self) -> &ParetoConfig
Get the configuration.
Trait Implementations§
Source§impl Clone for ParetoSampler
impl Clone for ParetoSampler
Source§fn clone(&self) -> ParetoSampler
fn clone(&self) -> ParetoSampler
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for ParetoSampler
impl RefUnwindSafe for ParetoSampler
impl Send for ParetoSampler
impl Sync for ParetoSampler
impl Unpin for ParetoSampler
impl UnsafeUnpin for ParetoSampler
impl UnwindSafe for ParetoSampler
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.