A library for working with phylogenetic and population genetic data.
v0.32.0
KmerScanner< Tag > Class Template Reference

#include <genesis/sequence/kmer/kmer_scanner.hpp>

Detailed Description

template<typename Tag>
class genesis::sequence::KmerScanner< Tag >

Definition at line 55 of file kmer_scanner.hpp.

Public Member Functions

 KmerScanner (self_type &&)=default
 
 KmerScanner (self_type const &)=default
 
 KmerScanner (std::string &&input)
 
 KmerScanner (std::string &&input, uint8_t k)
 
 KmerScanner (std::string const &input)
 
 KmerScanner (std::string const &input, uint8_t k)
 
 ~KmerScanner ()=default
 
Iterator begin () const
 
Iterator end () const
 
self_typeoperator= (self_type &&)=default
 
self_typeoperator= (self_type const &)=default
 

Public Types

using iterator_category = std::input_iterator_tag
 
using pointer = value_type *
 
using reference = value_type &
 
using self_type = KmerScanner
 
using value_type = Kmer< Tag >
 

Classes

class  Iterator
 

Constructor & Destructor Documentation

◆ KmerScanner() [1/6]

KmerScanner ( std::string const &  input)
inline

Definition at line 227 of file kmer_scanner.hpp.

◆ KmerScanner() [2/6]

KmerScanner ( std::string &&  input)
inline

Definition at line 231 of file kmer_scanner.hpp.

◆ KmerScanner() [3/6]

KmerScanner ( std::string const &  input,
uint8_t  k 
)
inline

Definition at line 235 of file kmer_scanner.hpp.

◆ KmerScanner() [4/6]

KmerScanner ( std::string &&  input,
uint8_t  k 
)
inline

Definition at line 241 of file kmer_scanner.hpp.

◆ ~KmerScanner()

~KmerScanner ( )
default

◆ KmerScanner() [5/6]

KmerScanner ( self_type const &  )
default

◆ KmerScanner() [6/6]

KmerScanner ( self_type &&  )
default

Member Function Documentation

◆ begin()

Iterator begin ( ) const
inline

Definition at line 259 of file kmer_scanner.hpp.

◆ end()

Iterator end ( ) const
inline

Definition at line 264 of file kmer_scanner.hpp.

◆ operator=() [1/2]

self_type& operator= ( self_type &&  )
default

◆ operator=() [2/2]

self_type& operator= ( self_type const &  )
default

Member Typedef Documentation

◆ iterator_category

using iterator_category = std::input_iterator_tag

Definition at line 67 of file kmer_scanner.hpp.

◆ pointer

using pointer = value_type*

Definition at line 65 of file kmer_scanner.hpp.

◆ reference

Definition at line 66 of file kmer_scanner.hpp.

◆ self_type

Definition at line 63 of file kmer_scanner.hpp.

◆ value_type

using value_type = Kmer<Tag>

Definition at line 64 of file kmer_scanner.hpp.


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