Enum ScalarSource 

pub enum ScalarSource {
    Constant(f64),
    Uniform {
        low: f64,
        high: f64,
    },
    Histogram(Histogram),
}

Source distribution for a generated scalar value.

Variants

Constant(f64)

A deterministic value.

Uniform

A uniform distribution on [low, high).

Fields

low: f64

Lower source bound.

high: f64

Upper source bound.

Histogram(Histogram)

A piecewise-constant histogram distribution.

Implementations

impl ScalarSource

pub fn constant(value: f64) -> Self

Construct a constant scalar source.

pub fn uniform(low: f64, high: f64) -> Self

Construct a uniform scalar source.

pub fn histogram(histogram: Histogram) -> Self

Construct a histogram-backed scalar source.

pub fn support(&self) -> LadduPhysicsResult<(f64, f64)>

Validate the source and return the smallest and largest values in its support.

Errors

Returns LadduPhysicsError when a constant or bound is non-finite, a uniform interval is empty, or histogram weights are invalid.

Panics

Panics only if a histogram reports positive total weight without containing any positive-weight bin.

pub fn sample( &self, rng: &mut ProposalRng, ) -> LadduPhysicsResult<ScalarProposalResult>

Draw a value and inverse-density weight from the source.

Errors

Returns LadduPhysicsError when the source parameters or histogram weights are invalid, or a histogram sample cannot be assigned to a bin.

Trait Implementations

impl Clone for ScalarSource

fn clone(&self) -> ScalarSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScalarSource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScalarSource

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ScalarSource

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.