Generated on Sat Feb 7 2015 02:01:50 for Gecode by doxygen 1.8.9.1
Gecode::Iter::Ranges::Array Class Reference

Range iterator for array of ranges More...

#include <ranges-array.hpp>

Classes

class  Range
 Ranges for array More...
 

Protected Attributes

Ranger
 Array for ranges. More...
 
int c
 Current range. More...
 
int n
 Number of ranges in array. More...
 

Constructors and initialization

 Array (void)
 Default constructor. More...
 
 Array (Range *r, int n)
 Initialize with n ranges from r. More...
 
void init (Range *r, int n)
 Initialize with n ranges from r. More...
 

Iteration control

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

Range access

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

Detailed Description

Range iterator for array of ranges

Allows to iterate the ranges as defined by an array where the ranges must be increasing and non-overlapping. The ranges can be iterated several times provided the iterator is reset by the reset member function.

Definition at line 50 of file ranges-array.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 98 of file ranges-array.hpp.

Gecode::Iter::Ranges::Array::Array ( Range r,
int  n 
)
inline

Initialize with n ranges from r.

Definition at line 101 of file ranges-array.hpp.

Member Function Documentation

void Gecode::Iter::Ranges::Array::init ( Range r,
int  n 
)
inline

Initialize with n ranges from r.

Definition at line 105 of file ranges-array.hpp.

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

Test whether iterator is still at a range or done.

Definition at line 114 of file ranges-array.hpp.

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

Move iterator to next range (if possible)

Definition at line 110 of file ranges-array.hpp.

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

Reset iterator to start from beginning.

Definition at line 119 of file ranges-array.hpp.

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

Return smallest value of range.

Definition at line 124 of file ranges-array.hpp.

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

Return largest value of range.

Definition at line 128 of file ranges-array.hpp.

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

Return width of range (distance between minimum and maximum)

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

Member Data Documentation

Range* Gecode::Iter::Ranges::Array::r
protected

Array for ranges.

Definition at line 59 of file ranges-array.hpp.

int Gecode::Iter::Ranges::Array::c
protected

Current range.

Definition at line 61 of file ranges-array.hpp.

int Gecode::Iter::Ranges::Array::n
protected

Number of ranges in array.

Definition at line 63 of file ranges-array.hpp.


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