OpenFlexTyper
Public Member Functions | Public Attributes | List of all members
ft::QKMap Class Reference

A class that contains the map between queries and kmers.

#include <qkMapClass.h>

Public Member Functions

 QKMap ()
 Constructor.
 
virtual ~QKMap ()
 Destructor.
 
const std::map< ft::QIdT, std::set< std::string > > & getQKMap ()
 retrieve the qkmap More...
 
std::set< ft::QIdT > retrieveQueries (const ft::KmerClass &kmer)
 Access functions for _qkMap. More...
 
std::set< std::string > retrieveKmers (const ft::QIdT &queryIDT)
 retrieve kmers that map to a specific query ID and type More...
 
bool checkForMatch (const ft::QueryClass &query, const ft::KmerClass &kmer) const
 see if a query contains a kmer More...
 
bool checkForQuery (const ft::QueryClass &query) const
 see if a query is in the qkMap More...
 
void addQKPair (const ft::QIdT &qIDT, const std::string &kmer)
 add a query ID, Type and Kmer pair to the QKMap More...
 

Public Attributes

std::map< ft::QIdT, std::set< std::string > > _map
 

Member Function Documentation

◆ addQKPair()

void ft::QKMap::addQKPair ( const ft::QIdT &  qIDT,
const std::string &  kmer 
)
Parameters
ft::KmerClasskmer
ft::QIdT(query ID, query Type)

◆ checkForMatch()

bool ft::QKMap::checkForMatch ( const ft::QueryClass &  query,
const ft::KmerClass &  kmer 
) const
Parameters
ft::KmerClasskmer
ft::QueryClassquery

◆ checkForQuery()

bool ft::QKMap::checkForQuery ( const ft::QueryClass &  query) const
Parameters
ft::QueryClassquery

◆ getQKMap()

const std::map<ft::QIdT, std::set<std::string> >& ft::QKMap::getQKMap ( )
Returns
_map

◆ retrieveKmers()

std::set< std::string > ft::QKMap::retrieveKmers ( const ft::QIdT &  queryIDT)
Parameters
ft::QIdT
Returns
set of kmer strings

◆ retrieveQueries()

std::set< ft::QIdT > ft::QKMap::retrieveQueries ( const ft::KmerClass &  kmer)

Functions

retrieve queries that map to a specific Kmer

Parameters
ft::KmerClasskmer
Returns
set of query Ids

Member Data Documentation

◆ _map

ft::QKMap::_map

map between queries and sets of kmers


The documentation for this class was generated from the following files: