A toolkit for working with phylogenetic data.
v0.24.0
IteratorDeletions Class Reference

#include <genesis/utils/math/twobit_vector/iterator_deletions.hpp>

Detailed Description

Take a TwobitVector sequence and iterate over all possible deletions of its values.

Definition at line 51 of file iterator_deletions.hpp.

Public Member Functions

 IteratorDeletions ()
 
 IteratorDeletions (TwobitVector const &vector)
 
 IteratorDeletions (IteratorDeletions const &)=default
 
 IteratorDeletions (IteratorDeletions &&)=default
 
 ~IteratorDeletions ()=default
 
TwobitVector::WordType hash () const
 Get the hash value of the current vector. More...
 
bool operator!= (self_type const &other) const
 
value_type const & operator* ()
 
self_typeoperator++ ()
 
self_type operator++ (int)
 
value_type const * operator-> ()
 
IteratorDeletionsoperator= (IteratorDeletions const &)=default
 
IteratorDeletionsoperator= (IteratorDeletions &&)=default
 
bool operator== (self_type const &other) const
 
size_t position () const
 Get the position that is currently deleted. More...
 
TwobitVector const & vector () const
 Get the current vector. More...
 

Public Types

using iterator_category = std::forward_iterator_tag
 
using self_type = IteratorDeletions
 
using value_type = TwobitVector
 

Constructor & Destructor Documentation

◆ IteratorDeletions() [1/4]

IteratorDeletions ( )
inline

Definition at line 67 of file iterator_deletions.hpp.

◆ IteratorDeletions() [2/4]

IteratorDeletions ( TwobitVector const &  vector)
inlineexplicit

Definition at line 75 of file iterator_deletions.hpp.

◆ ~IteratorDeletions()

~IteratorDeletions ( )
default

◆ IteratorDeletions() [3/4]

IteratorDeletions ( IteratorDeletions const &  )
default

◆ IteratorDeletions() [4/4]

Member Function Documentation

◆ hash()

TwobitVector::WordType hash ( ) const
inline

Get the hash value of the current vector.

Definition at line 182 of file iterator_deletions.hpp.

◆ operator!=()

bool operator!= ( self_type const &  other) const
inline

Definition at line 162 of file iterator_deletions.hpp.

◆ operator*()

value_type const& operator* ( )
inline

Definition at line 100 of file iterator_deletions.hpp.

◆ operator++() [1/2]

self_type& operator++ ( )
inline

Definition at line 110 of file iterator_deletions.hpp.

◆ operator++() [2/2]

self_type operator++ ( int  )
inline

Definition at line 150 of file iterator_deletions.hpp.

◆ operator->()

value_type const* operator-> ( )
inline

Definition at line 105 of file iterator_deletions.hpp.

◆ operator=() [1/2]

IteratorDeletions& operator= ( IteratorDeletions const &  )
default

◆ operator=() [2/2]

IteratorDeletions& operator= ( IteratorDeletions &&  )
default

◆ operator==()

bool operator== ( self_type const &  other) const
inline

Definition at line 157 of file iterator_deletions.hpp.

◆ position()

size_t position ( ) const
inline

Get the position that is currently deleted.

Definition at line 174 of file iterator_deletions.hpp.

◆ vector()

TwobitVector const& vector ( ) const
inline

Get the current vector.

Definition at line 190 of file iterator_deletions.hpp.

Member Typedef Documentation

◆ iterator_category

using iterator_category = std::forward_iterator_tag

Definition at line 59 of file iterator_deletions.hpp.

◆ self_type

Definition at line 60 of file iterator_deletions.hpp.

◆ value_type

Definition at line 61 of file iterator_deletions.hpp.


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