Generated on Mon Aug 27 2012 17:16:06 for Gecode by doxygen 1.8.1.2
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Gecode::Iter::Ranges::RangeListIter Class Reference
Range iterators

Iterator over range lists. More...

#include <ranges-list.hpp>

Classes

class  RangeList
 Range list class. More...
class  RLIO
 Shared object for allocation. More...

Public Member Functions

 ~RangeListIter (void)
 Destructor.

Protected Member Functions

void set (RangeList *l)
 Set range lists.
RangeList * get (void) const
 Get head of current range list.
RangeList * range (int min, int max, RangeList *&f)
 Create new range possibly from freelist f and init.
RangeList * range (int min, int max)
 Create new range possibly and init.
template<class I >
RangeList * range (I &i, RangeList *&f)
 Create new range possibly from freelist f and init.
template<class I >
RangeList * range (I &i)
 Create new range possibly and init.
template<class I >
RangeList * copy (I &i)
 Copy the iterator i to a range list.

Protected Attributes

RLIO * rlio
 Reference to shared object.
RangeList * h
 Head of range list.
RangeList * c
 Current list element.

Constructors and initialization

 RangeListIter (void)
 Default constructor.
 RangeListIter (const RangeListIter &i)
 Copy constructor.
 RangeListIter (Region &r)
 Initialize.
void init (Region &r)
 Initialize.
RangeListIter & operator= (const RangeListIter &i)
 Assignment operator.

Iteration control

bool operator() (void) const
 Test whether iterator is still at a range or done.
void operator++ (void)
 Move iterator to next range (if possible)
void reset (void)
 Reset iterator to start.

Range access

int min (void) const
 Return smallest value of range.
int max (void) const
 Return largest value of range.
unsigned int width (void) const
 Return width of range (distance between minimum and maximum)

Detailed Description

Iterator over range lists.

Definition at line 45 of file ranges-list.hpp.

Constructor & Destructor Documentation

Gecode::Iter::Ranges::RangeListIter::RangeListIter ( void  )
inline

Default constructor.

Definition at line 132 of file ranges-list.hpp.

Gecode::Iter::Ranges::RangeListIter::RangeListIter ( const RangeListIter &  i)
inline

Copy constructor.

Definition at line 147 of file ranges-list.hpp.

Gecode::Iter::Ranges::RangeListIter::RangeListIter ( Region &  r)
inline

Initialize.

Definition at line 136 of file ranges-list.hpp.

Gecode::Iter::Ranges::RangeListIter::~RangeListIter ( void  )
inline

Destructor.

Definition at line 168 of file ranges-list.hpp.

Member Function Documentation

void Gecode::Iter::Ranges::RangeListIter::set ( RangeList *  l)
inlineprotected

Set range lists.

Definition at line 178 of file ranges-list.hpp.

RangeListIter::RangeList * Gecode::Iter::Ranges::RangeListIter::get ( void  ) const
inlineprotected

Get head of current range list.

Definition at line 183 of file ranges-list.hpp.

RangeListIter::RangeList * Gecode::Iter::Ranges::RangeListIter::range ( int  min,
int  max,
RangeList *&  f 
)
inlineprotected

Create new range possibly from freelist f and init.

Definition at line 188 of file ranges-list.hpp.

RangeListIter::RangeList * Gecode::Iter::Ranges::RangeListIter::range ( int  min,
int  max 
)
inlineprotected

Create new range possibly and init.

Definition at line 201 of file ranges-list.hpp.

template<class I >
RangeListIter::RangeList * Gecode::Iter::Ranges::RangeListIter::range ( I &  i,
RangeList *&  f 
)
inlineprotected

Create new range possibly from freelist f and init.

Definition at line 209 of file ranges-list.hpp.

template<class I >
RangeListIter::RangeList * Gecode::Iter::Ranges::RangeListIter::range ( I &  i)
inlineprotected

Create new range possibly and init.

Definition at line 215 of file ranges-list.hpp.

template<class I >
RangeListIter::RangeList * Gecode::Iter::Ranges::RangeListIter::copy ( I &  i)
inlineprotected

Copy the iterator i to a range list.

Definition at line 221 of file ranges-list.hpp.

void Gecode::Iter::Ranges::RangeListIter::init ( Region &  r)
inline

Initialize.

Definition at line 141 of file ranges-list.hpp.

RangeListIter & Gecode::Iter::Ranges::RangeListIter::operator= ( const RangeListIter &  i)
inline

Assignment operator.

Definition at line 153 of file ranges-list.hpp.

bool Gecode::Iter::Ranges::RangeListIter::operator() ( void  ) const
inline

Test whether iterator is still at a range or done.

Definition at line 233 of file ranges-list.hpp.

void Gecode::Iter::Ranges::RangeListIter::operator++ ( void  )
inline

Move iterator to next range (if possible)

Definition at line 238 of file ranges-list.hpp.

void Gecode::Iter::Ranges::RangeListIter::reset ( void  )
inline

Reset iterator to start.

Definition at line 243 of file ranges-list.hpp.

int Gecode::Iter::Ranges::RangeListIter::min ( void  ) const
inline

Return smallest value of range.

Definition at line 248 of file ranges-list.hpp.

int Gecode::Iter::Ranges::RangeListIter::max ( void  ) const
inline

Return largest value of range.

Definition at line 252 of file ranges-list.hpp.

unsigned int Gecode::Iter::Ranges::RangeListIter::width ( void  ) const
inline

Return width of range (distance between minimum and maximum)

Definition at line 256 of file ranges-list.hpp.

Member Data Documentation

RLIO* Gecode::Iter::Ranges::RangeListIter::rlio
protected

Reference to shared object.

Definition at line 64 of file ranges-list.hpp.

RangeList* Gecode::Iter::Ranges::RangeListIter::h
protected

Head of range list.

Definition at line 66 of file ranges-list.hpp.

RangeList* Gecode::Iter::Ranges::RangeListIter::c
protected

Current list element.

Definition at line 68 of file ranges-list.hpp.

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