Struct necsim_impls_no_std::alias::packed::AliasMethodSamplerAtom

#[repr(C)]
pub struct AliasMethodSamplerAtom<E: Copy + PartialEq> { /* private fields */ }

Implementations

impl<E: Copy + PartialEq> AliasMethodSamplerAtom<E>

pub fn u(&self) -> ClosedUnitF64

pub fn e(&self) -> E

pub fn k(&self) -> E

pub fn flip(&mut self)

pub fn create( event_weights: &[(E, NonNegativeF64)] ) -> Vec<AliasMethodSamplerAtom<E>>

Contracts

Pre-condition - debug: event_weights is non-empty

• ! event_weights.is_empty()

Pre-condition - debug: all event weights are non-negative

• event_weights.iter().all(|(_e, p)| *p >= 0.0_f64)

Post-condition - debug: stores exactly the input events

• ret.iter().map(|s| &s.e).eq(old(event_weights).iter().map(|(e, _p)| e))

Post-condition - debug: full buckets sample the same event just in case

• ret.iter().all(|s| { let full_bucket = s.u == ClosedUnitF64::one(); !full_bucket || (s.e == s.k) })

pub fn sample_event<M: MathsCore, G: RngCore<M>>( alias_samplers: &[AliasMethodSamplerAtom<E>], rng: &mut G ) -> E

pub fn sample_event_with_cdf_limit<M: MathsCore, G: RngCore<M>>( alias_samplers: &[AliasMethodSamplerAtom<E>], rng: &mut G, limit: ClosedUnitF64 ) -> E

Contracts

Pre-condition - debug: alias_samplers is non-empty

• ! alias_samplers.is_empty()

Post-condition - debug: returns one of the weighted events

• old(alias_samplers).iter().map(|s| s.e).any(|e| e == ret)

Trait Implementations

impl<E: Clone + Copy + PartialEq> Clone for AliasMethodSamplerAtom<E>

fn clone(&self) -> AliasMethodSamplerAtom<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E> ComputeTypeSet for AliasMethodSamplerAtom<E>

where E: ComputeTypeSet + Copy + PartialEq,

type Output<__TypeSetRest: ExpandTypeSet> = <<<__TypeSetRest as ComputeSet>::Output<E> as ComputeSet>::Output<E> as ComputeSet>::Output<ClosedUnitF64>

Extend the set T into a (larger) set containing also the types this type links to.

impl<E: Debug + Copy + PartialEq> Debug for AliasMethodSamplerAtom<E>

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

Formats the value using the given formatter.

impl<E> TypeLayout for AliasMethodSamplerAtom<E>

where E: TypeLayout + Copy + PartialEq,

type Inhabited = <And<<ClosedUnitF64 as TypeLayout>::Inhabited, <And<<E as TypeLayout>::Inhabited, <And<<E as TypeLayout>::Inhabited, Inhabited> as ComputeInhabited>::Output> as ComputeInhabited>::Output> as ComputeInhabited>::Output

Marker type for whether the type is inhabited or uninhabited. The associated type must be either [inhabited::Inhabited] or [inhabited::Uninhabited].

const TYPE_LAYOUT: TypeLayoutInfo<'static> = _

Shallow layout of the type.