NCBI C++ ToolKit
Public Member Functions | Public Attributes | List of all members
BlastKmerStats Struct Reference

Search Toolkit Book for BlastKmerStats

Structure for ancillary data on KMER search. More...

#include <algo/blast/proteinkmer/blastkmerutils.hpp>

Public Member Functions

 BlastKmerStats (int hit_count=0, int jd_count=0, int jd_oid_count=0, int oids_considered=0, int total_matches=0, int seqs=0)
 Constructor. More...
 

Public Attributes

int hit_count
 How many hits to the hash array were there? More...
 
int jd_count
 How often was the Jaccard distance calculated. More...
 
int jd_oid_count
 How many OIDs was the Jaccard distance calculated for. More...
 
int oids_considered
 How many OIDs were considered as candidates. More...
 
int total_matches
 How many matches returned. More...
 
int num_sequences
 Number of database sequences considered (in this volume) More...
 

Detailed Description

Structure for ancillary data on KMER search.

Describes how many hits were examined etc.

Definition at line 52 of file blastkmerutils.hpp.

Constructor & Destructor Documentation

◆ BlastKmerStats()

BlastKmerStats::BlastKmerStats ( int  hit_count = 0,
int  jd_count = 0,
int  jd_oid_count = 0,
int  oids_considered = 0,
int  total_matches = 0,
int  seqs = 0 
)
inline

Constructor.

Parameters
hit_countHow many hits to the hash array
jd_counthow often was Jaccard distance calculated.
jd_oid_counthow many OIDs for Jaccard distance.
oids_consideredNumber OIDs considered as candidates.
total_matchesNumber of matches returned.
seqsNumber of database sequences considered

Definition at line 60 of file blastkmerutils.hpp.

Member Data Documentation

◆ hit_count

int BlastKmerStats::hit_count

How many hits to the hash array were there?

Definition at line 75 of file blastkmerutils.hpp.

Referenced by BOOST_AUTO_TEST_CASE(), neighbor_query(), and CBlastKmer::x_SearchMultipleQueries().

◆ jd_count

int BlastKmerStats::jd_count

How often was the Jaccard distance calculated.

Definition at line 77 of file blastkmerutils.hpp.

Referenced by BOOST_AUTO_TEST_CASE(), neighbor_query(), and CBlastKmer::x_SearchMultipleQueries().

◆ jd_oid_count

int BlastKmerStats::jd_oid_count

How many OIDs was the Jaccard distance calculated for.

Definition at line 79 of file blastkmerutils.hpp.

Referenced by neighbor_query(), and CBlastKmer::x_SearchMultipleQueries().

◆ num_sequences

int BlastKmerStats::num_sequences

Number of database sequences considered (in this volume)

Definition at line 85 of file blastkmerutils.hpp.

Referenced by CBlastKmer::x_RunKmerFile(), and CBlastKmer::x_SearchMultipleQueries().

◆ oids_considered

int BlastKmerStats::oids_considered

How many OIDs were considered as candidates.

Definition at line 81 of file blastkmerutils.hpp.

Referenced by neighbor_query(), and CBlastKmer::x_SearchMultipleQueries().

◆ total_matches

int BlastKmerStats::total_matches

How many matches returned.

Definition at line 83 of file blastkmerutils.hpp.

Referenced by neighbor_query(), and CBlastKmer::x_SearchMultipleQueries().


The documentation for this struct was generated from the following file:
Modified on Fri Jan 05 07:25:32 2024 by modify_doxy.py rev. 669887