bpp-phyl3  3.0.0
bpp::TreeLikelihoodInterface::SiteIterator Class Referenceabstract

An iterator over a set of sites, specified by their position. More...

#include <Bpp/Phyl/Legacy/Likelihood/TreeLikelihood.h>

+ Inheritance diagram for bpp::TreeLikelihoodInterface::SiteIterator:

Public Member Functions

virtual ~SiteIterator ()
 
virtual size_t next ()=0
 
virtual bool hasNext () const =0
 

Detailed Description

An iterator over a set of sites, specified by their position.

In most cases, the position will reflect the index of an inner array used for likelihood storage.

Definition at line 56 of file TreeLikelihood.h.

Constructor & Destructor Documentation

◆ ~SiteIterator()

virtual bpp::TreeLikelihoodInterface::SiteIterator::~SiteIterator ( )
inlinevirtual

Definition at line 59 of file TreeLikelihood.h.

Member Function Documentation

◆ hasNext()

virtual bool bpp::TreeLikelihoodInterface::SiteIterator::hasNext ( ) const
pure virtual
Returns
True is there is at least another site in the set.

Implemented in bpp::AbstractTreeLikelihood::SimpleSiteIterator.

◆ next()

virtual size_t bpp::TreeLikelihoodInterface::SiteIterator::next ( )
pure virtual
Returns
The position of the next site in the set.

Implemented in bpp::AbstractTreeLikelihood::SimpleSiteIterator.


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