KmerScanner< Tag >::Iterator Class Reference

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

Detailed Description

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

Definition at line 75 of file kmer_scanner.hpp.

Public Member Functions
	Iterator (self_type &&)=default
	Iterator (self_type const &)=default
	~Iterator ()=default
bool	operator!= (self_type const &it) const
value_type &	operator* ()
value_type const &	operator* () const
self_type &	operator++ ()
value_type *	operator-> ()
value_type const *	operator-> () const
Iterator &	operator= (self_type &&)=default
Iterator &	operator= (self_type const &)=default
bool	operator== (self_type const &it) const
	Compare two iterators for equality. More...

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

Public Attributes
friend	KmerScanner

Constructor & Destructor Documentation

~Iterator()

~Iterator ( )

default

Iterator() [1/2]

Iterator ( self_type const &  )

default

Iterator() [2/2]

Iterator ( self_type &&  )

default

Member Function Documentation

operator!=()

bool operator!= ( self_type const &  it ) const

inline

Definition at line 169 of file kmer_scanner.hpp.

operator*() [1/2]

value_type& operator* ( )

inline

Definition at line 140 of file kmer_scanner.hpp.

operator*() [2/2]

value_type const& operator* ( ) const

inline

Definition at line 135 of file kmer_scanner.hpp.

operator++()

self_type& operator++ ( )

inline

Definition at line 149 of file kmer_scanner.hpp.

operator->() [1/2]

value_type* operator-> ( )

inline

Definition at line 130 of file kmer_scanner.hpp.

operator->() [2/2]

value_type const* operator-> ( ) const

inline

Definition at line 125 of file kmer_scanner.hpp.

operator=() [1/2]

Iterator& operator= ( self_type &&  )

default

operator=() [2/2]

Iterator& operator= ( self_type const &  )

default

operator==()

bool operator== ( self_type const &  it ) const

inline

Compare two iterators for equality.

Any two iterators that are created by calling begin() on the same KmerScanner instance will compare equal, as long as neither of them is past-the-end. A valid (not past-the-end) iterator and an end() iterator will not compare equal; all past-the-end iterators compare equal, independently from which parent they were created.

Definition at line 164 of file kmer_scanner.hpp.

Member Typedef Documentation

iterator_category

using iterator_category = std::input_iterator_tag

Definition at line 87 of file kmer_scanner.hpp.

pointer

using pointer = value_type const*

Definition at line 85 of file kmer_scanner.hpp.

reference

using reference = value_type const&

Definition at line 86 of file kmer_scanner.hpp.

self_type

using self_type = KmerScanner::Iterator

Definition at line 83 of file kmer_scanner.hpp.

value_type

using value_type = Kmer<Tag>

Definition at line 84 of file kmer_scanner.hpp.

Member Data Documentation

KmerScanner

friend KmerScanner

Definition at line 119 of file kmer_scanner.hpp.

---

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

• kmer_scanner.hpp