Keeps the N best fragments candidates for the final selection. More...
#include <BoundedCollector.hh>
Public Types | |
| typedef utility::pointer::shared_ptr< BoundedCollector< StrictWeakOrdering > > | BoundedCollectorOP |
| typedef utility::pointer::shared_ptr< BoundedCollector< StrictWeakOrdering > const > | BoundedCollectorCOP |
Public Member Functions | |
| BoundedCollector (core::Size query_size, core::Size max_frags_per_pos, StrictWeakOrdering fragment_comparator, core::Size n_score_terms, core::Size buffer_factor=5) | |
| create a collector for a given size of a query sequence More... | |
| bool | add (ScoredCandidate new_canditate) override |
| Insert a fragment candidate to the container. More... | |
| core::Size | count_candidates (core::Size seq_pos) const override |
| Check how many candidates have been already collected for a given position APL Note: you cannot have inlined virtual functions. More... | |
| core::Size | count_candidates () const override |
| Check how many candidates have been already collected for all positions APL Note: you cannot have inlined virtual functions. More... | |
| core::Size | query_length () const override |
| Check the size of query sequence that this object knows. This is mainly to be able to check if it is the same as in the other parts of fragment picking machinery. More... | |
| void | insert (core::Size pos, CandidatesCollectorOP collector) override |
| Inserts candidates from another Collector for a give position in the query Candidates may or may not get inserted depending on the candidate. More... | |
| ScoredCandidatesVector1 & | get_candidates (core::Size position_in_query) override |
| returns all stored fragment candidates that begins at a given position in a query More... | |
| void | clear () override |
| removes all candidates from the container More... | |
| void | print_report (std::ostream &out, scores::FragmentScoreManagerOP scoring) const override |
| prints how many candidates have been collected for each position and how good they are More... | |
Private Attributes | |
| utility::vector1< LazySortedVector1< std::pair< FragmentCandidateOP, scores::FragmentScoreMapOP >, StrictWeakOrdering > > | storage_ |
Detailed Description
template<class StrictWeakOrdering>
class protocols::frag_picker::BoundedCollector< StrictWeakOrdering >
Keeps the N best fragments candidates for the final selection.
The purpose of a collector is to keep the best fragment candidates to the end of vall processing. In particular, the capacity of this collector may be larger than the number of fragments one wants to get
Member Typedef Documentation
◆ BoundedCollectorCOP
| typedef utility::pointer::shared_ptr< BoundedCollector< StrictWeakOrdering > const> protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::BoundedCollectorCOP |
◆ BoundedCollectorOP
| typedef utility::pointer::shared_ptr< BoundedCollector< StrictWeakOrdering > > protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::BoundedCollectorOP |
Constructor & Destructor Documentation
◆ BoundedCollector()
|
inline |
create a collector for a given size of a query sequence
References core::scoring::pair, and protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::storage_.
Member Function Documentation
◆ add()
|
inlineoverridevirtual |
Insert a fragment candidate to the container.
Implements protocols::frag_picker::CandidatesCollector.
References protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::storage_.
◆ clear()
|
inlineoverridevirtual |
removes all candidates from the container
Implements protocols::frag_picker::CandidatesCollector.
References protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::storage_.
◆ count_candidates() [1/2]
|
inlineoverridevirtual |
Check how many candidates have been already collected for all positions APL Note: you cannot have inlined virtual functions.
Implements protocols::frag_picker::CandidatesCollector.
References protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::storage_.
◆ count_candidates() [2/2]
|
inlineoverridevirtual |
Check how many candidates have been already collected for a given position APL Note: you cannot have inlined virtual functions.
Implements protocols::frag_picker::CandidatesCollector.
References protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::storage_.
◆ get_candidates()
|
inlineoverridevirtual |
returns all stored fragment candidates that begins at a given position in a query
Implements protocols::frag_picker::CandidatesCollector.
References protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::storage_.
◆ insert()
|
inlineoverridevirtual |
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 protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::storage_.
◆ print_report()
|
inlineoverridevirtual |
prints how many candidates have been collected for each position and how good they are
Implements protocols::frag_picker::CandidatesCollector.
References core::chemical::element::F, core::chemical::element::I, core::conformation::membrane::out, and protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::storage_.
◆ query_length()
|
inlineoverridevirtual |
Check the size of query sequence that this object knows. This is mainly to be able to check if it is the same as in the other parts of fragment picking machinery.
Implements protocols::frag_picker::CandidatesCollector.
References protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::storage_.
Member Data Documentation
◆ storage_
|
private |
Referenced by protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::add(), protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::BoundedCollector(), protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::clear(), protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::count_candidates(), protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::get_candidates(), protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::insert(), protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::print_report(), and protocols::frag_picker::BoundedCollector< StrictWeakOrdering >::query_length().
The documentation for this class was generated from the following files:
- src/protocols/frag_picker/BoundedCollector.fwd.hh
- src/protocols/frag_picker/BoundedCollector.hh
