utility::TopScoreSelector< T, S > Class Template Reference

The TopScoreSelector keeps an in-place, sorted, singly-linked list of the N top-scoring objects and their scores that it encounters. In the case of ties, the first object(s) encountered are kept. Class T must have a default constructor, a copy constructor, and must be assignable. Class S must be assignable and comparable, both by a < operator and by a > operator. More...

#include <TopScoreSelector.hh>

Public Types
typedef platform::Size	Size

Public Member Functions
	TopScoreSelector ()
void	n_to_keep (Size setting)
Size	n_to_keep () const
void	low_is_better (bool setting)
bool	low_is_better () const
bool	better (S s1, S s2) const
void	insert (T const &obj, S score)
	Keep a particular element if it is better than the worst element, or if we have not yet stored n_to_keep_ elements. More...
Size	size () const
T const &	operator[] (Size ind) const
S	top_score (Size ind) const

Private Member Functions
void	add_to_set (T const &obj, S score)
void	sort_top_scores () const
	Copy the top_scorers_ data into the sorted_top_scorers_ array. More...

Private Attributes
Size	n_to_keep_
bool	low_is_better_
Size	worst_ind_
vector1< std::pair< T, S > >	top_scorers_
vector1< Size >	next_ptr_
bool	is_sorted_
vector1< std::pair< T, S > >	sorted_top_scorers_

Detailed Description

template<class T, class S>
class utility::TopScoreSelector< T, S >

The TopScoreSelector keeps an in-place, sorted, singly-linked list of the N top-scoring objects and their scores that it encounters. In the case of ties, the first object(s) encountered are kept. Class T must have a default constructor, a copy constructor, and must be assignable. Class S must be assignable and comparable, both by a < operator and by a > operator.

Member Typedef Documentation

template<class T , class S >

typedef platform::Size utility::TopScoreSelector< T, S >::Size

Constructor & Destructor Documentation

template<class T , class S >

utility::TopScoreSelector< T, S >::TopScoreSelector ( )

inline

Member Function Documentation

template<class T , class S >

void utility::TopScoreSelector< T, S >::add_to_set ( T const &  obj, S  score  )

inlineprivate

References utility::TopScoreSelector< T, S >::better(), utility::TopScoreSelector< T, S >::is_sorted_, utility::TopScoreSelector< T, S >::n_to_keep_, utility::TopScoreSelector< T, S >::next_ptr_, basic::options::OptionKeys::AnchoredDesign::filters::score, utility::TopScoreSelector< T, S >::top_scorers_, and utility::TopScoreSelector< T, S >::worst_ind_.

Referenced by utility::TopScoreSelector< T, S >::insert().

template<class T , class S >

bool utility::TopScoreSelector< T, S >::better ( S  s1, S  s2  ) const

inline

References utility::TopScoreSelector< T, S >::low_is_better_, and basic::options::OptionKeys::stepwise::s2.

Referenced by utility::TopScoreSelector< T, S >::add_to_set(), and utility::TopScoreSelector< T, S >::insert().

template<class T , class S >

void utility::TopScoreSelector< T, S >::insert ( T const &  obj, S  score  )

inline

Keep a particular element if it is better than the worst element, or if we have not yet stored n_to_keep_ elements.

References utility::TopScoreSelector< T, S >::add_to_set(), utility::TopScoreSelector< T, S >::better(), utility::TopScoreSelector< T, S >::n_to_keep_, utility::TopScoreSelector< T, S >::top_scorers_, and utility::TopScoreSelector< T, S >::worst_ind_.

template<class T , class S >

void utility::TopScoreSelector< T, S >::low_is_better ( bool  setting )

inline

References utility::TopScoreSelector< T, S >::low_is_better_.

template<class T , class S >

bool utility::TopScoreSelector< T, S >::low_is_better ( ) const

inline

References utility::TopScoreSelector< T, S >::low_is_better_.

template<class T , class S >

void utility::TopScoreSelector< T, S >::n_to_keep ( Size  setting )

inline

References utility::TopScoreSelector< T, S >::n_to_keep_, utility::TopScoreSelector< T, S >::next_ptr_, and utility::TopScoreSelector< T, S >::top_scorers_.

template<class T , class S >

Size utility::TopScoreSelector< T, S >::n_to_keep ( ) const

inline

References utility::TopScoreSelector< T, S >::n_to_keep_.

template<class T , class S >

T const& utility::TopScoreSelector< T, S >::operator[] ( Size  ind ) const

inline

References utility::TopScoreSelector< T, S >::is_sorted_, utility::TopScoreSelector< T, S >::sort_top_scores(), and utility::TopScoreSelector< T, S >::sorted_top_scorers_.

template<class T , class S >

Size utility::TopScoreSelector< T, S >::size ( ) const

inline

References utility::TopScoreSelector< T, S >::top_scorers_.

template<class T , class S >

void utility::TopScoreSelector< T, S >::sort_top_scores ( ) const

inlineprivate

Copy the top_scorers_ data into the sorted_top_scorers_ array.

References utility::TopScoreSelector< T, S >::is_sorted_, utility::TopScoreSelector< T, S >::next_ptr_, utility::TopScoreSelector< T, S >::sorted_top_scorers_, utility::TopScoreSelector< T, S >::top_scorers_, and utility::TopScoreSelector< T, S >::worst_ind_.

Referenced by utility::TopScoreSelector< T, S >::operator[](), and utility::TopScoreSelector< T, S >::top_score().

template<class T , class S >

S utility::TopScoreSelector< T, S >::top_score ( Size  ind ) const

inline

References utility::TopScoreSelector< T, S >::is_sorted_, utility::TopScoreSelector< T, S >::sort_top_scores(), and utility::TopScoreSelector< T, S >::sorted_top_scorers_.

Member Data Documentation

template<class T , class S >

bool utility::TopScoreSelector< T, S >::is_sorted_

mutableprivate

Referenced by utility::TopScoreSelector< T, S >::add_to_set(), utility::TopScoreSelector< T, S >::operator[](), utility::TopScoreSelector< T, S >::sort_top_scores(), and utility::TopScoreSelector< T, S >::top_score().

template<class T , class S >

bool utility::TopScoreSelector< T, S >::low_is_better_

private

Referenced by utility::TopScoreSelector< T, S >::better(), and utility::TopScoreSelector< T, S >::low_is_better().

template<class T , class S >

Size utility::TopScoreSelector< T, S >::n_to_keep_

private

Referenced by utility::TopScoreSelector< T, S >::add_to_set(), utility::TopScoreSelector< T, S >::insert(), and utility::TopScoreSelector< T, S >::n_to_keep().

template<class T , class S >

vector1< Size > utility::TopScoreSelector< T, S >::next_ptr_

private

Referenced by utility::TopScoreSelector< T, S >::add_to_set(), utility::TopScoreSelector< T, S >::n_to_keep(), and utility::TopScoreSelector< T, S >::sort_top_scores().

template<class T , class S >

vector1< std::pair< T, S > > utility::TopScoreSelector< T, S >::sorted_top_scorers_

mutableprivate

Referenced by utility::TopScoreSelector< T, S >::operator[](), utility::TopScoreSelector< T, S >::sort_top_scores(), and utility::TopScoreSelector< T, S >::top_score().

template<class T , class S >

vector1< std::pair< T, S > > utility::TopScoreSelector< T, S >::top_scorers_

private

Referenced by utility::TopScoreSelector< T, S >::add_to_set(), utility::TopScoreSelector< T, S >::insert(), utility::TopScoreSelector< T, S >::n_to_keep(), utility::TopScoreSelector< T, S >::size(), and utility::TopScoreSelector< T, S >::sort_top_scores().

template<class T , class S >

Size utility::TopScoreSelector< T, S >::worst_ind_

private

Referenced by utility::TopScoreSelector< T, S >::add_to_set(), utility::TopScoreSelector< T, S >::insert(), and utility::TopScoreSelector< T, S >::sort_top_scores().

---

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

• src/utility/TopScoreSelector.fwd.hh
• src/utility/TopScoreSelector.hh