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

A class that creates the Kmers for a set of input queries.

#include <kmergenerator.h>

Public Member Functions

 KmerGenerator (const uint &_kmerSize, const bool &_refOnly, const SearchType &_searchType, const uint &_overlap=0, const uint &_stride=1, const uint &_maxKmers=1000000000, const bool &_verbose=false)
 Constructor.
 
virtual ~KmerGenerator ()
 Destructor.
 
virtual std::set< std::string > genSlidingSearchStrings (const std::string &queryString)
 Generate search strings (i.e. kmers) for a sliding search. More...
 
virtual std::set< std::string > genCenteredSearchStrings (const std::string &queryString)
 Generate search strings (i.e. kmers) for a centered search. More...
 
virtual std::set< std::string > genSearchKmers (const ft::QueryClass &queryObj)
 Generate search strings (i.e. kmers) More...
 
Getters

Constant functions to get properties for Kmer Generation

uint getKmerSize () const
 
bool getRefOnly () const
 
SearchType getSearchType () const
 
uint getOverlap () const
 
uint getStride () const
 
uint getMaxKmers () const
 

Private Attributes

Properties

Fixed Properties

std::map< std::string, uint > _counter
 
uint _kmerSize
 
bool _refOnly
 
SearchType _searchType
 
uint _overlap
 
uint _stride
 
uint _maxKmers
 
bool _verbose
 

Member Function Documentation

◆ genCenteredSearchStrings()

std::set< std::string > ft::KmerGenerator::genCenteredSearchStrings ( const std::string &  queryString)
virtual
Parameters
queryString
Returns
set of kmers

◆ genSearchKmers()

std::set< std::string > ft::KmerGenerator::genSearchKmers ( const ft::QueryClass &  queryObj)
virtual
Parameters
ft::QueryClassquery
Returns
set of kmers

◆ genSlidingSearchStrings()

std::set< std::string > ft::KmerGenerator::genSlidingSearchStrings ( const std::string &  queryString)
virtual
Parameters
queryString
Returns
set of kmers

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