bpp::TreeLikelihood::SiteIterator Class Reference

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

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

Inheritance diagram for bpp::TreeLikelihood::SiteIterator:

Public Member Functions
virtual	~SiteIterator ()
virtual size_t	next ()=0 throw (Exception)
virtual bool	hasNext () const =0

Detailed Description

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

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

Definition at line 94 of file TreeLikelihood.h.

Constructor & Destructor Documentation

~SiteIterator()

virtual bpp::TreeLikelihood::SiteIterator::~SiteIterator ( )

inlinevirtual

Definition at line 97 of file TreeLikelihood.h.

Member Function Documentation

hasNext()

virtual bool bpp::TreeLikelihood::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::TreeLikelihood::SiteIterator::next ( ) throw ( Exception )

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:

• Bpp/Phyl/Likelihood/TreeLikelihood.h