Struct necsim_core::cogs::coalescence_sampler::CoalescenceRngSample

pub struct CoalescenceRngSample(/* private fields */);

Implementations

impl CoalescenceRngSample

pub fn new<M: MathsCore, G: RngCore<M>>(rng: &mut G) -> Self

pub fn sample_coalescence_index<M: MathsCore>(self, length: u32) -> u32

Contracts

Post-condition - debug: samples U(0, length - 1)

• ret < length

Trait Implementations

impl Backup for CoalescenceRngSample

unsafe fn backup_unchecked(&self) -> Self

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

impl ComputeTypeSet for CoalescenceRngSample

type Output<__TypeSetRest: ExpandTypeSet> = <__TypeSetRest as ComputeSet>::Output<ClosedOpenUnitF64>

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

impl Debug for CoalescenceRngSample

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CoalescenceRngSample

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for CoalescenceRngSample

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CoalescenceRngSample

fn eq(&self, other: &CoalescenceRngSample) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CoalescenceRngSample

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CoalescenceRngSample

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypeLayout for CoalescenceRngSample

type Inhabited = <And<<ClosedOpenUnitF64 as TypeLayout>::Inhabited, Inhabited> 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.

impl Eq for CoalescenceRngSample

impl StructuralPartialEq for CoalescenceRngSample