Struct genevo::random::WeightedDistribution

source · [−]

pub struct WeightedDistribution<'a, T> where
    T: 'a + AsScalar,  { /* private fields */ }

Expand description

The WeightedDistribution is used to select values proportional to their weighted values.

The values in a WeightedDistribution must have a scalar representation. Thus their types must implement the genetic::AsScalar trait. The weights of the values are calculated from their scalar representation.

Implementations

source

impl<'a, T> WeightedDistribution<'a, T> where
T: 'a + AsScalar,

source

pub fn from_scalar_values(values: &'a [T]) -> Self

Constructs a new instance of WeightedDistribution for the given slice of values.

source

pub fn select(&self, pointer: f64) -> usize

Selects a value proportional to its weight and returns its index.

The pointer must be a float between 0 und the sum of the weights of all values. Usually the pointer is chosen uniformly at random.

source

pub fn sum(&self) -> f64

Returns the sum of the weights of all values in this WeightedDistribution instance.

The sum is calculated from the scalar values of the slice that was used to create this WeightedDistribution instance.

source

pub fn value(&self, index: usize) -> &T

Returns a reference to the value at the given index.

Trait Implementations

source

impl<'a, T: Clone> Clone for WeightedDistribution<'a, T> where
T: 'a + AsScalar,

source

fn clone(&self) -> WeightedDistribution<'a, T>

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

source

impl<'a, T: Debug> Debug for WeightedDistribution<'a, T> where
T: 'a + AsScalar,

source

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

Formats the value using the given formatter. Read more

source

impl<'a, T: PartialEq> PartialEq<WeightedDistribution<'a, T>> for WeightedDistribution<'a, T> where
T: 'a + AsScalar,

source

fn eq(&self, other: &WeightedDistribution<'a, T>) -> bool

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

source

fn ne(&self, other: &WeightedDistribution<'a, T>) -> bool

This method tests for !=.

source

impl<'a, T> StructuralPartialEq for WeightedDistribution<'a, T> where
T: 'a + AsScalar,

Auto Trait Implementations

impl<'a, T> RefUnwindSafe for WeightedDistribution<'a, T> where
T: RefUnwindSafe,

impl<'a, T> Send for WeightedDistribution<'a, T> where
T: Sync,

impl<'a, T> Sync for WeightedDistribution<'a, T> where
T: Sync,

impl<'a, T> Unpin for WeightedDistribution<'a, T>

impl<'a, T> UnwindSafe for WeightedDistribution<'a, T> where
T: RefUnwindSafe,

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct genevo::random::WeightedDistribution

Implementations

impl<'a, T> WeightedDistribution<'a, T> where T: 'a + AsScalar,

pub fn from_scalar_values(values: &'a [T]) -> Self

pub fn select(&self, pointer: f64) -> usize

pub fn sum(&self) -> f64

pub fn value(&self, index: usize) -> &T

Trait Implementations

impl<'a, T: Clone> Clone for WeightedDistribution<'a, T> where T: 'a + AsScalar,

fn clone(&self) -> WeightedDistribution<'a, T>

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

impl<'a, T: Debug> Debug for WeightedDistribution<'a, T> where T: 'a + AsScalar,

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

impl<'a, T: PartialEq> PartialEq<WeightedDistribution<'a, T>> for WeightedDistribution<'a, T> where T: 'a + AsScalar,

fn eq(&self, other: &WeightedDistribution<'a, T>) -> bool

fn ne(&self, other: &WeightedDistribution<'a, T>) -> bool

impl<'a, T> StructuralPartialEq for WeightedDistribution<'a, T> where T: 'a + AsScalar,

Auto Trait Implementations

impl<'a, T> RefUnwindSafe for WeightedDistribution<'a, T> where T: RefUnwindSafe,

impl<'a, T> Send for WeightedDistribution<'a, T> where T: Sync,

impl<'a, T> Sync for WeightedDistribution<'a, T> where T: Sync,

impl<'a, T> Unpin for WeightedDistribution<'a, T>

impl<'a, T> UnwindSafe for WeightedDistribution<'a, T> where T: RefUnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

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

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<'a, T> WeightedDistribution<'a, T> where
T: 'a + AsScalar,

impl<'a, T: Clone> Clone for WeightedDistribution<'a, T> where
T: 'a + AsScalar,

impl<'a, T: Debug> Debug for WeightedDistribution<'a, T> where
T: 'a + AsScalar,

impl<'a, T: PartialEq> PartialEq<WeightedDistribution<'a, T>> for WeightedDistribution<'a, T> where
T: 'a + AsScalar,

impl<'a, T> StructuralPartialEq for WeightedDistribution<'a, T> where
T: 'a + AsScalar,

impl<'a, T> RefUnwindSafe for WeightedDistribution<'a, T> where
T: RefUnwindSafe,

impl<'a, T> Send for WeightedDistribution<'a, T> where
T: Sync,

impl<'a, T> Sync for WeightedDistribution<'a, T> where
T: Sync,

impl<'a, T> UnwindSafe for WeightedDistribution<'a, T> where
T: RefUnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

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

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,