MicrovariantScanner< Tag > Class Template Reference

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

Detailed Description

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

Definition at line 56 of file microvariant_scanner.hpp.

Public Member Functions
	MicrovariantScanner ()
	MicrovariantScanner (Kmer< Tag > const &kmer)
	MicrovariantScanner (MicrovariantScanner &&)=default
	MicrovariantScanner (MicrovariantScanner const &)=default
	~MicrovariantScanner ()=default
Kmer< Tag > const &	kmer () const
	Get the current k-mer microvariant. More...
bool	operator!= (self_type const &other) const
value_type const &	operator* ()
self_type &	operator++ ()
value_type const *	operator-> ()
MicrovariantScanner &	operator= (MicrovariantScanner &&)=default
MicrovariantScanner &	operator= (MicrovariantScanner const &)=default
bool	operator== (self_type const &other) const
size_t	position () const
	Get the position that is currently deleted. More...

Public Types
using	iterator_category = std::forward_iterator_tag
using	self_type = MicrovariantScanner
using	value_type = Kmer< Tag >

Constructor & Destructor Documentation

MicrovariantScanner() [1/4]

MicrovariantScanner ( )

inline

Definition at line 72 of file microvariant_scanner.hpp.

MicrovariantScanner() [2/4]

MicrovariantScanner ( Kmer< Tag > const &  kmer )

inlineexplicit

Definition at line 76 of file microvariant_scanner.hpp.

~MicrovariantScanner()

~MicrovariantScanner ( )

default

MicrovariantScanner() [3/4]

MicrovariantScanner ( MicrovariantScanner< Tag > const &  )

default

MicrovariantScanner() [4/4]

MicrovariantScanner ( MicrovariantScanner< Tag > &&  )

default

Member Function Documentation

kmer()

Kmer<Tag> const& kmer ( ) const

inline

Get the current k-mer microvariant.

Definition at line 190 of file microvariant_scanner.hpp.

operator!=()

bool operator!= ( self_type const &  other ) const

inline

Definition at line 170 of file microvariant_scanner.hpp.

operator*()

value_type const& operator* ( )

inline

Definition at line 97 of file microvariant_scanner.hpp.

operator++()

self_type& operator++ ( )

inline

Definition at line 107 of file microvariant_scanner.hpp.

operator->()

value_type const* operator-> ( )

inline

Definition at line 102 of file microvariant_scanner.hpp.

operator=() [1/2]

MicrovariantScanner& operator= ( MicrovariantScanner< Tag > &&  )

default

operator=() [2/2]

MicrovariantScanner& operator= ( MicrovariantScanner< Tag > const &  )

default

operator==()

bool operator== ( self_type const &  other ) const

inline

Definition at line 165 of file microvariant_scanner.hpp.

position()

size_t position ( ) const

inline

Get the position that is currently deleted.

Definition at line 182 of file microvariant_scanner.hpp.

Member Typedef Documentation

iterator_category

using iterator_category = std::forward_iterator_tag

Definition at line 64 of file microvariant_scanner.hpp.

self_type

using self_type = MicrovariantScanner

Definition at line 65 of file microvariant_scanner.hpp.

value_type

using value_type = Kmer<Tag>

Definition at line 66 of file microvariant_scanner.hpp.

---

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

• microvariant_scanner.hpp