NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
NBestPlacement Class Reference

Search Toolkit Book for NBestPlacement

#include <algo/align/util/best_placement.hpp>

Public Types

using score_fn_t = std::function< int(const objects::CSeq_align &)>
 

Public Member Functions

 NBestPlacement ()=delete
 
 ~NBestPlacement ()=delete
 

Static Public Member Functions

static void Rank (objects::CSeq_align_set &sas, score_fn_t score_fn=&NBestPlacement::GetScore)
 Adds the following scores: `best_placement_score` as computed by score_fn `rank` - all top scoring alignments will have rank=1 `rank1_index`, `rank1_count` if more than one top-scoring alignment. More...
 
static int GetScore (const objects::CSeq_align &aln)
 

Detailed Description

Definition at line 40 of file best_placement.hpp.

Member Typedef Documentation

◆ score_fn_t

using NBestPlacement::score_fn_t = std::function<int(const objects::CSeq_align&)>

Definition at line 46 of file best_placement.hpp.

Constructor & Destructor Documentation

◆ NBestPlacement()

NBestPlacement::NBestPlacement ( )
delete

◆ ~NBestPlacement()

NBestPlacement::~NBestPlacement ( )
delete

Member Function Documentation

◆ GetScore()

int NBestPlacement::GetScore ( const objects::CSeq_align &  aln)
static

Definition at line 600 of file best_placement.cpp.

◆ Rank()

void NBestPlacement::Rank ( objects::CSeq_align_set &  sas,
score_fn_t  score_fn = &NBestPlacement::GetScore 
)
static

Adds the following scores: `best_placement_score` as computed by score_fn `rank` - all top scoring alignments will have rank=1 `rank1_index`, `rank1_count` if more than one top-scoring alignment.

Input seq-align-set shall contain alignments for the same query

Definition at line 608 of file best_placement.cpp.

References _ASSERT, a, b, CSeq_align_set_Base::Get(), and CSeq_align_set_Base::Set().

Referenced by CAdvancedAlignCleanup::BestPlacement().


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:01 2024 by modify_doxy.py rev. 669887