Public Member Functions | Public Attributes

MGT::KmerState Class Reference

Class that holds a counter for one k-mer along with jump pointers for next k-mers. More...

#include <kmers.hpp>

List of all members.

Public Member Functions

std::ostream & print (std::ostream &out, const PKmerState pFirstState) const
 Print KmerState object for debugging.

Public Attributes

PKmerState m_next [g_maxINuc]
 Array of "edges" - a pointer to another KmerState for each extended alphabet symbol.
PKmerStateData m_pData
 Pointer to payload object.
PKmerState m_revComp
 Pointer to a reverse-complement KmerState object.
bool m_isRevComp
 true if we marked this state as reverse-complement (for KmerStates::isRevComp()).
KmerId m_id
 ID of corresponding k-mer (for KmerStates::idState()).

Detailed Description

Class that holds a counter for one k-mer along with jump pointers for next k-mers.


Member Function Documentation

std::ostream & MGT::KmerState::print ( std::ostream &  out,
const PKmerState  pFirstState 
) const

Print KmerState object for debugging.

Parameters:
pFirstState- pointer to the first KmerState, used here to convert internal pointers to indices

Member Data Documentation

ID of corresponding k-mer (for KmerStates::idState()).

Declared public only for access by KmerStates class.

true if we marked this state as reverse-complement (for KmerStates::isRevComp()).

Declared public only for access by KmerStates class.

Array of "edges" - a pointer to another KmerState for each extended alphabet symbol.

Declared public only for access by KmerStates class.

Pointer to payload object.

Declared public only for access by KmerStates class.

Pointer to a reverse-complement KmerState object.

Declared public only for access by KmerStates class.


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