vdj_pipe
pipeline for processing DNA sequence data
Public Types | Public Member Functions | Static Private Member Functions | Private Attributes | List of all members
vdj_pipe::Best_match_pair< ID, Score > Class Template Reference

#include <best_match_pair.hpp>

Public Types

typedef ID id_type
 
typedef Score score_type
 

Public Member Functions

 Best_match_pair ()
 
id_type const & id1 () const
 
id_type const & id2 () const
 
bool has_score () const
 
score_type score1 () const
 
score_type score2 () const
 
bool is_acceptable (const score_type min_score, const bool require_best) const
 
bool combine (id_type const &id, const score_type score)
 
bool combine (Best_match_pair const &bmp)
 

Static Private Member Functions

static Score default_score ()
 

Private Attributes

ID id1_
 
Score score1_
 
ID id2_
 
Score score2_
 

Member Typedef Documentation

template<class ID , class Score = int>
typedef ID vdj_pipe::Best_match_pair< ID, Score >::id_type
template<class ID , class Score = int>
typedef Score vdj_pipe::Best_match_pair< ID, Score >::score_type

Constructor & Destructor Documentation

template<class ID , class Score = int>
vdj_pipe::Best_match_pair< ID, Score >::Best_match_pair ( )
inline

Member Function Documentation

template<class ID , class Score = int>
bool vdj_pipe::Best_match_pair< ID, Score >::combine ( id_type const &  id,
const score_type  score 
)
inline

keep two best scores and corresponding id-s

Parameters
id
score
Returns
true if new best score was found
template<class ID , class Score = int>
bool vdj_pipe::Best_match_pair< ID, Score >::combine ( Best_match_pair< ID, Score > const &  bmp)
inline

keep two best scores and corresponding id-s

Parameters
bmpthe other best match pair
Returns
true if new best score was found
template<class ID , class Score = int>
static Score vdj_pipe::Best_match_pair< ID, Score >::default_score ( )
inlinestaticprivate
template<class ID , class Score = int>
bool vdj_pipe::Best_match_pair< ID, Score >::has_score ( ) const
inline
template<class ID , class Score = int>
id_type const& vdj_pipe::Best_match_pair< ID, Score >::id1 ( ) const
inline
template<class ID , class Score = int>
id_type const& vdj_pipe::Best_match_pair< ID, Score >::id2 ( ) const
inline
template<class ID , class Score = int>
bool vdj_pipe::Best_match_pair< ID, Score >::is_acceptable ( const score_type  min_score,
const bool  require_best 
) const
inline
template<class ID , class Score = int>
score_type vdj_pipe::Best_match_pair< ID, Score >::score1 ( ) const
inline
template<class ID , class Score = int>
score_type vdj_pipe::Best_match_pair< ID, Score >::score2 ( ) const
inline

Member Data Documentation

template<class ID , class Score = int>
ID vdj_pipe::Best_match_pair< ID, Score >::id1_
private
template<class ID , class Score = int>
ID vdj_pipe::Best_match_pair< ID, Score >::id2_
private
template<class ID , class Score = int>
Score vdj_pipe::Best_match_pair< ID, Score >::score1_
private
template<class ID , class Score = int>
Score vdj_pipe::Best_match_pair< ID, Score >::score2_
private
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.11