Generated on Thu Jan 16 2025 00:00:00 for Gecode by doxygen 1.14.0
Gecode::Iter::Ranges::Map< I, M, true > Class Template Reference

Specialized mapping of ranges for strict maps. More...

#include <ranges-map.hpp>

Protected Attributes

i
 Input range iterator.
m
 Map object.

Constructors and initialization

 Map (void)
 Default constructor.
 Map (I &i)
 Initialize with ranges from i.
 Map (I &i, const M &m)
 Initialize with ranges from i and map m.
void init (I &i)
 Initialize with ranges from i.
void init (I &i, const M &m)
 Initialize with ranges from i and map m.

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)

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

template<class I, class M>
class Gecode::Iter::Ranges::Map< I, M, true >

Specialized mapping of ranges for strict maps.

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

Constructor & Destructor Documentation

◆ Map() [1/3]

template<class I, class M>
Gecode::Iter::Ranges::Map< I, M, true >::Map ( void )
inline

Default constructor.

Definition at line 206 of file ranges-map.hpp.

◆ Map() [2/3]

template<class I, class M>
Gecode::Iter::Ranges::Map< I, M, true >::Map ( I & i)
inline

Initialize with ranges from i.

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

◆ Map() [3/3]

template<class I, class M>
Gecode::Iter::Ranges::Map< I, M, true >::Map ( I & i,
const M & m )
inline

Initialize with ranges from i and map m.

Definition at line 224 of file ranges-map.hpp.

Member Function Documentation

◆ init() [1/2]

template<class I, class M>
void Gecode::Iter::Ranges::Map< I, M, true >::init ( I & i)
inline

Initialize with ranges from i.

Definition at line 210 of file ranges-map.hpp.

◆ init() [2/2]

template<class I, class M>
void Gecode::Iter::Ranges::Map< I, M, true >::init ( I & i,
const M & m )
inline

Initialize with ranges from i and map m.

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

◆ operator()()

template<class I, class M>
bool Gecode::Iter::Ranges::Map< I, M, true >::operator() ( void ) const
inline

Test whether iterator is still at a range or done.

Definition at line 228 of file ranges-map.hpp.

◆ operator++()

template<class I, class M>
void Gecode::Iter::Ranges::Map< I, M, true >::operator++ ( void )
inline

Move iterator to next range (if possible)

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

◆ min()

template<class I, class M>
int Gecode::Iter::Ranges::Map< I, M, true >::min ( void ) const
inline

Return smallest value of range.

Definition at line 239 of file ranges-map.hpp.

◆ max()

template<class I, class M>
int Gecode::Iter::Ranges::Map< I, M, true >::max ( void ) const
inline

Return largest value of range.

Definition at line 244 of file ranges-map.hpp.

◆ width()

template<class I, class M>
unsigned int Gecode::Iter::Ranges::Map< I, M, true >::width ( void ) const
inline

Return width of range (distance between minimum and maximum)

Definition at line 249 of file ranges-map.hpp.

Member Data Documentation

◆ i

template<class I, class M>
I Gecode::Iter::Ranges::Map< I, M, true >::i
protected

Input range iterator.

Definition at line 117 of file ranges-map.hpp.

◆ m

template<class I, class M>
M Gecode::Iter::Ranges::Map< I, M, true >::m
protected

Map object.

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


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