Gecode::Iter::Ranges::Array Class Reference
[Range iterators]
Range iterator for array of ranges More...
#include <ranges-array.hpp>
Classes | |
class | Range |
Ranges for array More... | |
Protected Attributes | |
Range * | r |
Array for ranges. | |
unsigned int | c |
Current range. | |
unsigned int | n |
Number of ranges in array. | |
Constructors and initialization | |
| |
Array (void) | |
Default constructor. | |
Array (Range *r, unsigned int n) | |
Initialize with n ranges from r. | |
Array (Range *r, int n) | |
Initialize with n ranges from r. | |
void | init (Range *r, unsigned int n) |
Initialize with n ranges from r. | |
void | init (Range *r, int n) |
Initialize with n ranges from r. | |
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 from beginning. | |
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
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 46 of file ranges-array.hpp.
Constructor & Destructor Documentation
Gecode::Iter::Ranges::Array::Array | ( | void | ) | [inline] |
Default constructor.
Definition at line 99 of file ranges-array.hpp.
Gecode::Iter::Ranges::Array::Array | ( | Range * | r, | |
unsigned int | n | |||
) | [inline] |
Initialize with n ranges from r.
Definition at line 102 of file ranges-array.hpp.
Gecode::Iter::Ranges::Array::Array | ( | Range * | r, | |
int | n | |||
) | [inline] |
Initialize with n ranges from r.
Definition at line 106 of file ranges-array.hpp.
Member Function Documentation
void Gecode::Iter::Ranges::Array::init | ( | Range * | r, | |
unsigned int | n | |||
) | [inline] |
Initialize with n ranges from r.
Definition at line 110 of file ranges-array.hpp.
void Gecode::Iter::Ranges::Array::init | ( | Range * | r, | |
int | n | |||
) | [inline] |
Initialize with n ranges from r.
Definition at line 115 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 124 of file ranges-array.hpp.
void Gecode::Iter::Ranges::Array::operator++ | ( | void | ) | [inline] |
Move iterator to next range (if possible).
Definition at line 120 of file ranges-array.hpp.
void Gecode::Iter::Ranges::Array::reset | ( | void | ) | [inline] |
Reset iterator to start from beginning.
Definition at line 129 of file ranges-array.hpp.
int Gecode::Iter::Ranges::Array::min | ( | void | ) | const [inline] |
Return smallest value of range.
Definition at line 134 of file ranges-array.hpp.
int Gecode::Iter::Ranges::Array::max | ( | void | ) | const [inline] |
Return largest value of range.
Definition at line 138 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 142 of file ranges-array.hpp.
Member Data Documentation
Range* Gecode::Iter::Ranges::Array::r [protected] |
Array for ranges.
Definition at line 56 of file ranges-array.hpp.
unsigned int Gecode::Iter::Ranges::Array::c [protected] |
Current range.
Definition at line 58 of file ranges-array.hpp.
unsigned int Gecode::Iter::Ranges::Array::n [protected] |
Number of ranges in array.
Definition at line 60 of file ranges-array.hpp.
The documentation for this class was generated from the following file:
- gecode/iter/ranges-array.hpp