bpp::AbstractTreeLikelihood::SimpleSiteIterator Class Reference

A very simple site iterator. More...

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

Inheritance diagram for bpp::AbstractTreeLikelihood::SimpleSiteIterator:

Collaboration diagram for bpp::AbstractTreeLikelihood::SimpleSiteIterator:

Public Member Functions
	SimpleSiteIterator (size_t nbSites, size_t offset=0)
size_t	next () throw (Exception)
bool	hasNext () const

Private Attributes
size_t	maxIndex_
size_t	index_
size_t	offset_

Detailed Description

A very simple site iterator.

This iterator loops over a continuous range of sites. The ocnstructor takes as input the number of sites to iterate over, and optionally an offset argument, specifying the index of the first site.

Definition at line 109 of file AbstractTreeLikelihood.h.

Constructor & Destructor Documentation

SimpleSiteIterator()

bpp::AbstractTreeLikelihood::SimpleSiteIterator::SimpleSiteIterator ( size_t  nbSites, size_t  offset = 0  )

inline

Definition at line 118 of file AbstractTreeLikelihood.h.

Member Function Documentation

hasNext()

bool bpp::AbstractTreeLikelihood::SimpleSiteIterator::hasNext ( ) const

inlinevirtual

Returns

True is there is at least another site in the set.

Implements bpp::TreeLikelihood::SiteIterator.

Definition at line 129 of file AbstractTreeLikelihood.h.

References index_, and maxIndex_.

Referenced by next().

next()

size_t bpp::AbstractTreeLikelihood::SimpleSiteIterator::next ( ) throw ( Exception )

inlinevirtual

Returns

The position of the next site in the set.

Implements bpp::TreeLikelihood::SiteIterator.

Definition at line 122 of file AbstractTreeLikelihood.h.

References hasNext(), index_, and offset_.

Member Data Documentation

index_

size_t bpp::AbstractTreeLikelihood::SimpleSiteIterator::index_

private

Definition at line 114 of file AbstractTreeLikelihood.h.

Referenced by hasNext(), and next().

maxIndex_

size_t bpp::AbstractTreeLikelihood::SimpleSiteIterator::maxIndex_

private

Definition at line 113 of file AbstractTreeLikelihood.h.

Referenced by hasNext().

offset_

size_t bpp::AbstractTreeLikelihood::SimpleSiteIterator::offset_

private

Definition at line 115 of file AbstractTreeLikelihood.h.

Referenced by next().

---

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

• Bpp/Phyl/Likelihood/AbstractTreeLikelihood.h