A toolkit for working with phylogenetic data.
v0.24.0
IteratorPreorder< TaxonomyType, TaxonType > Class Template Reference

#include <genesis/taxonomy/iterator/preorder.hpp>

Detailed Description

template<typename TaxonomyType, typename TaxonType>
class genesis::taxonomy::IteratorPreorder< TaxonomyType, TaxonType >

Definition at line 103 of file taxonomy/iterator/preorder.hpp.

Public Member Functions

 IteratorPreorder ()
 
 IteratorPreorder (TaxonomyType &taxonomy)
 
 IteratorPreorder (IteratorPreorder const &)=default
 
 IteratorPreorder (IteratorPreorder &&)=default
 
 ~IteratorPreorder ()=default
 
bool operator!= (const self_type &other) const
 
self_type operator* ()
 
self_type operator++ ()
 
self_type operator++ (int)
 
IteratorPreorderoperator= (IteratorPreorder const &)=default
 
IteratorPreorderoperator= (IteratorPreorder &&)=default
 
bool operator== (const self_type &other) const
 
TaxonType & taxon () const
 

Public Types

using iterator_category = std::forward_iterator_tag
 
using self_type = IteratorPreorder< TaxonomyType, TaxonType >
 

Constructor & Destructor Documentation

◆ IteratorPreorder() [1/4]

IteratorPreorder ( )
inline

Definition at line 119 of file taxonomy/iterator/preorder.hpp.

◆ IteratorPreorder() [2/4]

IteratorPreorder ( TaxonomyType &  taxonomy)
inlineexplicit

Definition at line 122 of file taxonomy/iterator/preorder.hpp.

◆ ~IteratorPreorder()

~IteratorPreorder ( )
default

◆ IteratorPreorder() [3/4]

IteratorPreorder ( IteratorPreorder< TaxonomyType, TaxonType > const &  )
default

◆ IteratorPreorder() [4/4]

IteratorPreorder ( IteratorPreorder< TaxonomyType, TaxonType > &&  )
default

Member Function Documentation

◆ operator!=()

bool operator!= ( const self_type other) const
inline

Definition at line 177 of file taxonomy/iterator/preorder.hpp.

◆ operator*()

self_type operator* ( )
inline

Definition at line 143 of file taxonomy/iterator/preorder.hpp.

◆ operator++() [1/2]

self_type operator++ ( )
inline

Definition at line 148 of file taxonomy/iterator/preorder.hpp.

◆ operator++() [2/2]

self_type operator++ ( int  )
inline

Definition at line 165 of file taxonomy/iterator/preorder.hpp.

◆ operator=() [1/2]

IteratorPreorder& operator= ( IteratorPreorder< TaxonomyType, TaxonType > const &  )
default

◆ operator=() [2/2]

IteratorPreorder& operator= ( IteratorPreorder< TaxonomyType, TaxonType > &&  )
default

◆ operator==()

bool operator== ( const self_type other) const
inline

Definition at line 172 of file taxonomy/iterator/preorder.hpp.

◆ taxon()

TaxonType& taxon ( ) const
inline

Definition at line 186 of file taxonomy/iterator/preorder.hpp.

Member Typedef Documentation

◆ iterator_category

using iterator_category = std::forward_iterator_tag

Definition at line 112 of file taxonomy/iterator/preorder.hpp.

◆ self_type

using self_type = IteratorPreorder<TaxonomyType, TaxonType>

Definition at line 113 of file taxonomy/iterator/preorder.hpp.


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