Skip to main content

Reservoir

Struct Reservoir 

Source
pub struct Reservoir<T> { /* private fields */ }
Expand description

Reservoir sampler using Algorithm R.

Maintains a fixed-size sample of items seen so far, with each item having equal probability of being in the sample.

Implementations§

Source§

impl<T> Reservoir<T>

Source

pub fn new(capacity: usize, rng: StdRng) -> Self

Create a new reservoir with the given capacity

Source

pub fn consider(&mut self, item: T)

Consider an item for inclusion in the reservoir

Source

pub fn total_seen(&self) -> usize

Get the number of items seen so far

Source

pub fn len(&self) -> usize

Get the current size of the reservoir

Source

pub fn is_empty(&self) -> bool

Check if the reservoir is empty

Source

pub fn capacity(&self) -> usize

Get the capacity of the reservoir

Source

pub fn into_items(self) -> Vec<T>

Consume the reservoir and return the sampled items

Source

pub fn items(&self) -> &[T]

Get a reference to the current items

Trait Implementations§

Source§

impl<T: Debug> Debug for Reservoir<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Reservoir<T>

§

impl<T> RefUnwindSafe for Reservoir<T>
where T: RefUnwindSafe,

§

impl<T> Send for Reservoir<T>
where T: Send,

§

impl<T> Sync for Reservoir<T>
where T: Sync,

§

impl<T> Unpin for Reservoir<T>
where T: Unpin,

§

impl<T> UnwindSafe for Reservoir<T>
where T: 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> Fake for T

Source§

fn fake<U>(&self) -> U
where Self: FakeBase<U>,

Source§

fn fake_with_rng<U, R>(&self, rng: &mut R) -> U
where R: Rng + ?Sized, Self: FakeBase<U>,

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,