Skip to main content

WeightedSampler

Struct WeightedSampler 

Source
pub struct WeightedSampler { /* private fields */ }
Expand description

Pre-computed weighted sampler for O(log n) repeated sampling.

Builds a cumulative distribution table from weights, then uses binary search for each sample.

§Algorithm

CDF-based weighted sampling with binary search.

§Complexity

  • Construction: O(n)
  • Sampling: O(log n)

§Examples

use u_numflow::random::{create_rng, WeightedSampler};
let weights = vec![1.0, 2.0, 3.0, 4.0];
let sampler = WeightedSampler::new(&weights).unwrap();
let mut rng = create_rng(42);
let idx = sampler.sample(&mut rng);
assert!(idx < 4);

Implementations§

Source§

impl WeightedSampler

Source

pub fn new(weights: &[f64]) -> Option<Self>

Creates a new weighted sampler from the given weights.

§Returns
  • None if weights is empty or all weights are zero/negative.
Source

pub fn sample<R: Rng>(&self, rng: &mut R) -> usize

Samples a random index according to the weights.

§Complexity

O(log n) via binary search.

Source

pub fn len(&self) -> usize

Returns the number of categories.

Source

pub fn is_empty(&self) -> bool

Returns true if there are no categories.

Source

pub fn total_weight(&self) -> f64

Returns the total weight.

Auto Trait Implementations§

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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

Source§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V