Rosetta Protocols  2014.35
Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::frag_picker::quota::TorsionBinPool Class Reference

represents a single pool used by quota selector More...

#include <TorsionBinPool.hh>

Public Member Functions

 TorsionBinPool (Size size, std::string pool_name, core::fragment::SecondaryStructureOP prediction)
 Creates a pool of a given size and name. More...
 
virtual ~TorsionBinPool ()
 
void show_availability (std::ostream &) const
 prints information on which fragments can be accepted by this pool and how many of them More...
 
bool try_fragment (ScoredCandidate &candidate)
 try to insert a given fragment candidate into this pool More...
 
void restart (Size, Size)
 
- Public Member Functions inherited from protocols::frag_picker::quota::QuotaPool
 QuotaPool (std::string pool_name, Real quota_fraction)
 Creates a pool of a given size and name. More...
 
virtual ~QuotaPool ()
 
virtual bool could_be_accepted (ScoredCandidate) const =0
 
virtual Size total_size () const =0
 Says how many fragments (in total) may fit into this pool. More...
 
virtual Size current_size () const =0
 Says how many fragments are currently in this pool. More...
 
virtual Size size_left () const =0
 Says how many fragments can still be inserted into this pool. More...
 
virtual void clear ()=0
 Makes the pool empty by removing all candidates. More...
 
virtual void push (ScoredCandidate)=0
 Push a fragment candidate into the pool container. More...
 
virtual Size count_candidates () const =0
 Check how many candidates have been already collected for a given position. More...
 
std::string const & get_pool_name () const
 returns the name assigned to this quota pool More...
 
Real get_fraction () const
 returns the fraction of this quota pool in the entire population of fragments More...
 
virtual void set_fraction (Real new_fraction)
 Sets the fraction of this quota pool in the entire population of fragments. More...
 
virtual Real quota_score (ScoredCandidate candidate) const
 provides the score for a candidate that was used to sort a quota pool More...
 
- Public Member Functions inherited from protocols::frag_picker::CandidatesCollector
virtual bool add (ScoredCandidate)=0
 Insert a fragment candidate to the container. More...
 
virtual void insert (Size, CandidatesCollectorOP)=0
 inserts candidates from another collector Candidates may or may not get inserted depending on the candidate and type of storage More...
 
virtual Size count_candidates (Size) const =0
 Check how many candidates have been already collected for a given position. More...
 
virtual Size query_length () const =0
 Check the size of query sequence that this object knows. This is mainly to be ale to check if it is the same as in the other parts of fragment picking machinery. More...
 
virtual ScoredCandidatesVector1get_candidates (Size position_in_query)=0
 
virtual void print_report (std::ostream &output, scores::FragmentScoreManagerOP scoring) const =0
 Describes what has been collected. More...
 

Private Member Functions

Size round (Real x)
 

Private Attributes

core::fragment::SecondaryStructureOP prediction_
 
Size nh_
 
Size ne_
 
Size nl_
 
Size max_h_
 
Size max_l_
 
Size max_e_
 
Size frag_size_
 

Detailed Description

represents a single pool used by quota selector

Constructor & Destructor Documentation

protocols::frag_picker::quota::TorsionBinPool::TorsionBinPool ( Size  size,
std::string  pool_name,
core::fragment::SecondaryStructureOP  prediction 
)
inline

Creates a pool of a given size and name.

Parameters
size- how many fragments may fit into this pool
name- name assigned to this pool. This in general may be any string that later allows one control pool's behavior from a flag file

References prediction_.

virtual protocols::frag_picker::quota::TorsionBinPool::~TorsionBinPool ( )
virtual

Member Function Documentation

void protocols::frag_picker::quota::TorsionBinPool::restart ( Size  query_seq_pos,
Size  fragment_size 
)
Size protocols::frag_picker::quota::TorsionBinPool::round ( Real  x)
inlineprivate

Referenced by restart().

void protocols::frag_picker::quota::TorsionBinPool::show_availability ( std::ostream &  where) const
virtual

prints information on which fragments can be accepted by this pool and how many of them

Reimplemented from protocols::frag_picker::quota::QuotaPool.

References protocols::frag_picker::quota::QuotaPool::get_pool_name(), max_e_, max_h_, max_l_, ne_, nh_, and nl_.

bool protocols::frag_picker::quota::TorsionBinPool::try_fragment ( ScoredCandidate candidate)

try to insert a given fragment candidate into this pool

References max_e_, max_h_, max_l_, ne_, nh_, nl_, and ss.

Member Data Documentation

Size protocols::frag_picker::quota::TorsionBinPool::frag_size_
private

Referenced by restart().

Size protocols::frag_picker::quota::TorsionBinPool::max_e_
private
Size protocols::frag_picker::quota::TorsionBinPool::max_h_
private
Size protocols::frag_picker::quota::TorsionBinPool::max_l_
private
Size protocols::frag_picker::quota::TorsionBinPool::ne_
private
Size protocols::frag_picker::quota::TorsionBinPool::nh_
private
Size protocols::frag_picker::quota::TorsionBinPool::nl_
private
core::fragment::SecondaryStructureOP protocols::frag_picker::quota::TorsionBinPool::prediction_
private

Referenced by restart(), and TorsionBinPool().


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