numeric::random::ReservoirSampler< T > Class Template Reference

Simple container for keeping K random values. More...

#include <reservoir_sample.hh>

Public Member Functions
	ReservoirSampler (numeric::Size const wanted)
	~ReservoirSampler ()=default
void	add_value (T const &val)
numeric::Size	n_vals () const
numeric::Size	n_wanted () const
numeric::Size	n_seen () const
utility::vector1< T > const &	values () const

Private Member Functions
	ReservoirSampler ()

Private Attributes
utility::vector1< T >	values_
numeric::Size	n_seen_
numeric::Size const	n_wanted_

Detailed Description

template<typename T>
class numeric::random::ReservoirSampler< T >

Simple container for keeping K random values.

Values are stochastically preserved so that the probability of any value existing is always 1 / N, where N is the number of values seen.

Constructor & Destructor Documentation

ReservoirSampler() [1/2]

template<typename T >

numeric::random::ReservoirSampler< T >::ReservoirSampler ( numeric::Size const  wanted )

inline

~ReservoirSampler()

template<typename T >

numeric::random::ReservoirSampler< T >::~ReservoirSampler ( )

default

ReservoirSampler() [2/2]

template<typename T >

numeric::random::ReservoirSampler< T >::ReservoirSampler ( )

private

Member Function Documentation

add_value()

template<typename T >

void numeric::random::ReservoirSampler< T >::add_value ( T const &  val )

inline

References kmeans_adaptive_kernel_density_bb_dependent_rotlib::idx, numeric::random::ReservoirSampler< T >::n_seen(), numeric::random::ReservoirSampler< T >::n_seen_, numeric::random::ReservoirSampler< T >::n_vals(), numeric::random::ReservoirSampler< T >::n_wanted(), numeric::random::random_range(), numeric::random::reservoir_sample_accept_prob(), numeric::random::uniform(), and numeric::random::ReservoirSampler< T >::values_.

n_seen()

template<typename T >

numeric::Size numeric::random::ReservoirSampler< T >::n_seen ( ) const

inline

References numeric::random::ReservoirSampler< T >::n_seen_.

Referenced by numeric::random::ReservoirSampler< T >::add_value().

n_vals()

template<typename T >

numeric::Size numeric::random::ReservoirSampler< T >::n_vals ( ) const

inline

References numeric::random::ReservoirSampler< T >::values_.

Referenced by numeric::random::ReservoirSampler< T >::add_value().

n_wanted()

template<typename T >

numeric::Size numeric::random::ReservoirSampler< T >::n_wanted ( ) const

inline

References numeric::random::ReservoirSampler< T >::n_wanted_.

Referenced by numeric::random::ReservoirSampler< T >::add_value().

values()

template<typename T >

utility::vector1< T > const& numeric::random::ReservoirSampler< T >::values ( ) const

inline

References numeric::random::ReservoirSampler< T >::values_.

Member Data Documentation

n_seen_

template<typename T >

numeric::Size numeric::random::ReservoirSampler< T >::n_seen_

private

Referenced by numeric::random::ReservoirSampler< T >::add_value(), and numeric::random::ReservoirSampler< T >::n_seen().

n_wanted_

template<typename T >

numeric::Size const numeric::random::ReservoirSampler< T >::n_wanted_

private

Referenced by numeric::random::ReservoirSampler< T >::n_wanted().

values_

template<typename T >

utility::vector1< T > numeric::random::ReservoirSampler< T >::values_

private

Referenced by numeric::random::ReservoirSampler< T >::add_value(), numeric::random::ReservoirSampler< T >::n_vals(), and numeric::random::ReservoirSampler< T >::values().

---

The documentation for this class was generated from the following file:

• src/numeric/random/reservoir_sample.hh