Generated on Thu Feb 21 2013 23:11:55 for Gecode by doxygen 1.8.3.1
Gecode::IntSet Class Reference

Integer sets. More...

#include <int.hh>

Classes

class  MinInc
 Sort ranges according to increasing minimum. More...
 

Related Functions

(Note that these are not member functions.)

template<class Char , class Traits >
std::basic_ostream< Char,
Traits > & 
operator<< (std::basic_ostream< Char, Traits > &os, const IntSet &s)
 Print integer set s. More...
 

Constructors and initialization

 IntSet (void)
 Initialize as empty set. More...
 
 IntSet (int n, int m)
 Initialize as range with minimum n and maximum m. More...
 
 IntSet (const int r[], int n)
 Initialize with n integers from array r. More...
 
 IntSet (const int r[][2], int n)
 Initialize with n ranges from array r. More...
 
template<class I >
 IntSet (I &i)
 Initialize with range iterator i. More...
 

Range access

int ranges (void) const
 Return number of ranges of the specification. More...
 
int min (int i) const
 Return minimum of range at position i. More...
 
int max (int i) const
 Return maximum of range at position i. More...
 
unsigned int width (int i) const
 Return width of range at position i. More...
 

Entire set access

bool in (int n) const
 Return whether n is included in the set. More...
 
unsigned int size (void) const
 Return size (cardinality) of set. More...
 
unsigned int width (void) const
 Return width of set (distance between maximum and minimum) More...
 
int min (void) const
 Return minimum of entire set. More...
 
int max (void) const
 Return maximum of entire set. More...
 

Predefined value

static const IntSet empty
 Empty set. More...
 

Additional Inherited Members

- Public Member Functions inherited from Gecode::SharedHandle
 SharedHandle (void)
 Create shared handle with no object pointing to. More...
 
 SharedHandle (SharedHandle::Object *so)
 Create shared handle that points to shared object so. More...
 
 SharedHandle (const SharedHandle &sh)
 Copy constructor maintaining reference count. More...
 
SharedHandleoperator= (const SharedHandle &sh)
 Assignment operator mainitaining reference count. More...
 
void update (Space &home, bool share, SharedHandle &sh)
 Updating during cloning. More...
 
 ~SharedHandle (void)
 Destructor that maintains reference count. More...
 
- Protected Member Functions inherited from Gecode::SharedHandle
SharedHandle::Objectobject (void) const
 Access to the shared object. More...
 
void object (SharedHandle::Object *n)
 Modify shared object. More...
 

Detailed Description

Integer sets.

Integer sets are the means to specify arbitrary sets of integers to be used as domains for integer variables.

Definition at line 159 of file int.hh.

Constructor & Destructor Documentation

Gecode::IntSet::IntSet ( void  )
inline

Initialize as empty set.

Definition at line 47 of file int-set-1.hpp.

Gecode::IntSet::IntSet ( int  n,
int  m 
)
inline

Initialize as range with minimum n and maximum m.

Note that the set is empty if n is larger than m

Definition at line 101 of file int-set-1.hpp.

Gecode::IntSet::IntSet ( const int  r[],
int  n 
)
inline

Initialize with n integers from array r.

Definition at line 96 of file int-set-1.hpp.

Gecode::IntSet::IntSet ( const int  r[][2],
int  n 
)
inline

Initialize with n ranges from array r.

For position i in the array r, the minimum is r[i][0] and the maximum is r[i][1].

Definition at line 91 of file int-set-1.hpp.

template<class I >
Gecode::IntSet::IntSet ( I &  i)
explicit

Initialize with range iterator i.

Definition at line 86 of file int-set-1.hpp.

Member Function Documentation

int Gecode::IntSet::ranges ( void  ) const
inline

Return number of ranges of the specification.

Definition at line 125 of file int-set-1.hpp.

int Gecode::IntSet::min ( int  i) const
inline

Return minimum of range at position i.

Definition at line 106 of file int-set-1.hpp.

int Gecode::IntSet::max ( int  i) const
inline

Return maximum of range at position i.

Definition at line 112 of file int-set-1.hpp.

unsigned int Gecode::IntSet::width ( int  i) const
inline

Return width of range at position i.

Definition at line 118 of file int-set-1.hpp.

bool Gecode::IntSet::in ( int  n) const
inline

Return whether n is included in the set.

Definition at line 131 of file int-set-1.hpp.

unsigned int Gecode::IntSet::size ( void  ) const
inline

Return size (cardinality) of set.

Definition at line 152 of file int-set-1.hpp.

unsigned int Gecode::IntSet::width ( void  ) const
inline

Return width of set (distance between maximum and minimum)

Definition at line 158 of file int-set-1.hpp.

int Gecode::IntSet::min ( void  ) const
inline

Return minimum of entire set.

Definition at line 140 of file int-set-1.hpp.

int Gecode::IntSet::max ( void  ) const
inline

Return maximum of entire set.

Definition at line 146 of file int-set-1.hpp.

Friends And Related Function Documentation

template<class Char , class Traits >
std::basic_ostream< Char, Traits > & operator<< ( std::basic_ostream< Char, Traits > &  os,
const IntSet s 
)
related

Print integer set s.

Definition at line 227 of file int-set-1.hpp.

Member Data Documentation

const IntSet Gecode::IntSet::empty
static

Empty set.

Definition at line 247 of file int.hh.


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