Struct Weighted

Source

pub struct Weighted<S, W = f64>(pub S, pub W);

Expand description

Represents a weighted sample.

Tuple Fields§

§0: S

The value.

§1: W

The weight.

Trait Implementations§

Source §

impl<S: Clone, W: Clone> Clone for Weighted<S, W>

Source §

fn clone(&self) -> Weighted<S, W>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<S: Copy, W: Copy> Copy for Weighted<S, W>

Source §

impl<S: Debug, W: Debug> Debug for Weighted<S, W>

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<S: Default, W: Default> Default for Weighted<S, W>

Source §

fn default() -> Weighted<S, W>

Returns the “default value” for a type. Read more

Source §

impl<S: Eq, W: Eq> Eq for Weighted<S, W>

Source §

impl<S: PartialEq, W: PartialEq> PartialEq for Weighted<S, W>

Source §

fn eq(&self, other: &Weighted<S, W>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 (const: unstable) · Source§

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

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

Source §

impl<S: PartialEq, W: PartialEq> StructuralPartialEq for Weighted<S, W>

Source §

impl<S: Sample, W: Sample + Add<Output = W>> Weighable for Weighted<S, W>

Source §

type Sample = S

The value-type that is being sampled.

Source §

type Weight = W

The weight-type of the samples.

Source §

type Error = NegativeWeight<W>

The error-type in case sampling fails.

Source §

fn sample<const M: usize>( self, rv: &RandomVariable<Self, M>, ) -> Result<(), Self::Error>
where CentralMoments<M>: Univariate,

Adds this value to the collection of values represented by the random variable.

Source §

fn weight<const M: usize>(rv: &RandomVariable<Self, M>) -> f64

Returns the weight of the random variable as a floating point number.

Source §

fn combine(weight: Self::Weight, other: Self::Weight) -> Self::Weight

Combines the weight of two random variables.

Auto Trait Implementations§

§

impl<S, W> Freeze for Weighted<S, W>
where S: Freeze, W: Freeze,

§

impl<S, W> RefUnwindSafe for Weighted<S, W>
where S: RefUnwindSafe, W: RefUnwindSafe,

§

impl<S, W> UnwindSafe for Weighted<S, W>
where S: UnwindSafe, W: 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

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

Source §

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

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source §

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §