Rosetta 3.4
Public Member Functions
protocols::frag_picker::quota::SecondaryStructurePool Class Reference

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

#include <SecondaryStructurePool.hh>

Inheritance diagram for protocols::frag_picker::quota::SecondaryStructurePool:
Inheritance graph
[legend]
Collaboration diagram for protocols::frag_picker::quota::SecondaryStructurePool:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SecondaryStructurePool (Size, std::string, char, utility::vector1< Size > &, utility::vector1< Real > &, Real, Size, Size)
 Creates a pool of a given size and name.
char get_ss_type ()
virtual ~SecondaryStructurePool ()
virtual Size total_size ()
 Says how many fragments (in total) may fit into this pool.
virtual Size current_size ()
 Says how many fragments are currently in this pool.
virtual Size size_left ()
 Says how many fragments can still be inserted into this pool.
virtual bool could_be_accepted (ScoredCandidate)
virtual void push (ScoredCandidate candidate)
 Push a fragment candidate into the container.
virtual bool add (ScoredCandidate)
 Insert a fragment candidate to the container.
void clear ()
 removes all candidates from the container
Size count_candidates (Size)
 Check how many candidates have been already collected for a given position.
Size count_candidates ()
 Check how many candidates have been already collected for all positions.
Size query_length ()
 Check the size of query sequence that this object knows.
void insert (Size pos, CandidatesCollectorOP collector)
 Inserts candidates from another Collector for a give position in the query Candidates may or may not get inserted depending on the candidate.
ScoredCandidatesVector1get_candidates (Size)
 Returns all the candidate in this pool.
void resize (Size new_size)
void print_report (std::ostream &, scores::FragmentScoreManagerOP)
 Describes what has been collected.
virtual void set_fraction (Real new_fraction)
 Sets the fraction of this quota pool in the entire population of fragments.
virtual Real quota_score (ScoredCandidate candidate) const
 provides the score for a candidate that was used to sort a quota pool

Detailed Description

represents a single pool used by quota selector


Constructor & Destructor Documentation

protocols::frag_picker::quota::SecondaryStructurePool::SecondaryStructurePool ( Size  total_size,
std::string  pool_name,
char  ss_type,
utility::vector1< Size > &  which_components,
utility::vector1< Real > &  weights,
Real  fraction,
Size  n_scores,
Size  buffer_factor = 5 
)

Creates a pool of a given size and name.

Parameters:
size- total number of fragments from all the pools at a given position
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
ss_type- what is the type of secondary structur this pool is accepting
score_components_id- which scores will be used to sort this pool
weights- weights for the scores that in general may be different than these used for fragment picking
fraction- fraction of this pool in the entire population
total_size- how many fragments will be selected (in total in all pools)
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
ss_type- what is the type of secondary structur this pool is accepting
fraction- fraction of the total number of fragments that goes into this pool

References total_size(), and protocols::frag_picker::quota::trSecondaryStructurePool().

protocols::frag_picker::quota::SecondaryStructurePool::~SecondaryStructurePool ( ) [virtual]

Member Function Documentation

bool protocols::frag_picker::quota::SecondaryStructurePool::add ( ScoredCandidate  candidate) [virtual]

Insert a fragment candidate to the container.

Implements protocols::frag_picker::CandidatesCollector.

void protocols::frag_picker::quota::SecondaryStructurePool::clear ( ) [inline, virtual]

removes all candidates from the container

Implements protocols::frag_picker::quota::QuotaPool.

bool protocols::frag_picker::quota::SecondaryStructurePool::could_be_accepted ( ScoredCandidate  candidate) [virtual]
Size protocols::frag_picker::quota::SecondaryStructurePool::count_candidates ( Size  ) [inline, virtual]

Check how many candidates have been already collected for a given position.

Detailed: This is a very special case - collector will be used only for a given position.
Thus it returns the total number of inserted candidates, as count_candidates() does

Implements protocols::frag_picker::CandidatesCollector.

References current_size().

Size protocols::frag_picker::quota::SecondaryStructurePool::count_candidates ( ) [inline, virtual]

Check how many candidates have been already collected for all positions.

Implements protocols::frag_picker::quota::QuotaPool.

References current_size().

virtual Size protocols::frag_picker::quota::SecondaryStructurePool::current_size ( ) [inline, virtual]

Says how many fragments are currently in this pool.

Implements protocols::frag_picker::quota::QuotaPool.

Referenced by count_candidates(), print_report(), and size_left().

ScoredCandidatesVector1& protocols::frag_picker::quota::SecondaryStructurePool::get_candidates ( Size  ) [inline, virtual]

Returns all the candidate in this pool.

Implements protocols::frag_picker::CandidatesCollector.

Referenced by insert().

char protocols::frag_picker::quota::SecondaryStructurePool::get_ss_type ( ) [inline]
void protocols::frag_picker::quota::SecondaryStructurePool::insert ( Size  pos,
CandidatesCollectorOP  collector 
) [inline, virtual]

Inserts candidates from another Collector for a give position in the query Candidates may or may not get inserted depending on the candidate.

Implements protocols::frag_picker::CandidatesCollector.

References core::pack::dunbrack::c, and get_candidates().

void protocols::frag_picker::quota::SecondaryStructurePool::print_report ( std::ostream &  out,
scores::FragmentScoreManagerOP   
) [virtual]
virtual void protocols::frag_picker::quota::SecondaryStructurePool::push ( ScoredCandidate  candidate) [inline, virtual]

Push a fragment candidate into the container.

Implements protocols::frag_picker::quota::QuotaPool.

Size protocols::frag_picker::quota::SecondaryStructurePool::query_length ( ) [inline, virtual]

Check the size of query sequence that this object knows.

Detailed: This is a very special case - collector will be used only for a given position and it does NOT
know the tolal size. Thus it returns always 0

Implements protocols::frag_picker::CandidatesCollector.

virtual Real protocols::frag_picker::quota::SecondaryStructurePool::quota_score ( ScoredCandidate  candidate) const [inline, virtual]

provides the score for a candidate that was used to sort a quota pool

Detailed: This base class returns the most recent total score for a fragment

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

void protocols::frag_picker::quota::SecondaryStructurePool::resize ( Size  new_size) [inline]
virtual void protocols::frag_picker::quota::SecondaryStructurePool::set_fraction ( Real  new_fraction) [inline, virtual]

Sets the fraction of this quota pool in the entire population of fragments.

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

virtual Size protocols::frag_picker::quota::SecondaryStructurePool::size_left ( ) [inline, virtual]

Says how many fragments can still be inserted into this pool.

Implements protocols::frag_picker::quota::QuotaPool.

References current_size(), and total_size().

virtual Size protocols::frag_picker::quota::SecondaryStructurePool::total_size ( ) [inline, virtual]

Says how many fragments (in total) may fit into this pool.

Implements protocols::frag_picker::quota::QuotaPool.

Referenced by SecondaryStructurePool(), and size_left().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines