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 ()
void	add_value (T val)
numeric::Size	n_vals () const
numeric::Size	n_wanted () const
numeric::Size	n_seen () const
utility::vector1< T >	values () const

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.

Detailed: 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

template<typename T >

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

inline

template<typename T >

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

inline

Member Function Documentation

template<typename T >

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

inline

References 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_.

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().

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().

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().

template<typename T >

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

inline

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

Member Data Documentation

template<typename T >

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

private

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

template<typename T >

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

private

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

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:

• symlinks/rosetta/src/numeric/random/reservoir_sample.hh