Struct necsim_impls_no_std::alias::AliasMethodSampler

source · 
pub struct AliasMethodSampler<E: Copy + PartialEq> { /* private fields */ }

Implementations§

source§

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

source

pub fn new(event_weights: &[(E, NonNegativeF64)]) -> Self

§Contracts

Pre-condition - debug: event_weights is non-empty

  • ! event_weights.is_empty()

Post-condition - debug: stores exactly the input events

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

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

  • ret.Us.iter().zip(ret.Es.iter()).zip(ret.Ks.iter()).all(|((u, e), k)| { let full_bucket = *u == ClosedUnitF64::one(); !full_bucket || (e == k) })
source

pub fn sample_event<M: MathsCore, G: RngCore<M>>(&self, rng: &mut G) -> E

§Contracts

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

  • self.Es.contains(&ret)

Trait Implementations§

source§

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

source§

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

Returns a copy 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§

§

impl<E> Freeze for AliasMethodSampler<E>

§

impl<E> RefUnwindSafe for AliasMethodSampler<E>
where E: RefUnwindSafe,

§

impl<E> Send for AliasMethodSampler<E>
where E: Send,

§

impl<E> Sync for AliasMethodSampler<E>
where E: Sync,

§

impl<E> Unpin for AliasMethodSampler<E>
where E: Unpin,

§

impl<E> UnwindSafe for AliasMethodSampler<E>
where E: UnwindSafe,

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
§

impl<T> Backup for T
where T: Clone,

§

default unsafe fn backup_unchecked(&self) -> T

§

default unsafe fn __contracts_impl_backup_unchecked(&self) -> T

§

fn backup(&self) -> BackedUp<Self>

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
§

impl<T> ExtractDiscriminant for T

§

type Discriminant = <T as ExtractDiscriminantSpec<<T as DiscriminantKind>::Discriminant>>::Ty

The type of the discriminant, which must satisfy the trait bounds required by core::mem::Discriminant. 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> ToOwned for T
where T: Clone,

§

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

§

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

§

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<T> Data for T
where T: Send + Clone,

§

impl<T> Erased for T