Generated on Fri Oct 19 11:25:45 2018 for Gecode by doxygen 1.6.3

Gecode::IntSet Class Reference
[Integer variablesSet variables]

Integer sets. More...

#include <int.hh>

List of all members.

Classes

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

Public Member Functions

template<>
 IntSet (const std::vector< int > &r)
 Initialize with integers from vector r.
template<>
 IntSet (const std::vector< std::pair< int, int >> &r)
 Initialize with ranges from vector r.

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.

Predefined value



static const IntSet empty
 Empty set.

Constructors and initialization



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

Range access



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

Entire set access



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

Equality tests



bool operator== (const IntSet &s) const
 Return whether s is equal.
bool operator!= (const IntSet &s) const
 Return whether s is not equal.

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 174 of file int.hh.


Constructor & Destructor Documentation

Gecode::IntSet::IntSet ( void   )  [inline]

Initialize as empty set.

Definition at line 43 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 144 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 103 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 97 of file int-set-1.hpp.

template<class I >
Gecode::IntSet::IntSet ( I &  i  )  [inline, explicit]

Initialize with range iterator i.

Initialize integer set with iterator.

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

template<class I >
Gecode::IntSet::IntSet ( const I &  i  )  [inline, explicit]

Initialize with range iterator i.

Initialize integer set with iterator.

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

Gecode::IntSet::IntSet ( std::initializer_list< int >  r  ) 

Initialize with integers from list r.

Definition at line 150 of file int-set.cpp.

Gecode::IntSet::IntSet ( std::initializer_list< std::pair< int, int >>  r  ) 

Initialize with ranges from vector r.

The minimum is the first element and the maximum is the second element.

Definition at line 162 of file int-set.cpp.

template<>
Gecode::IntSet::IntSet ( const std::vector< int > &  r  )  [inline]

Initialize with integers from vector r.

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

template<>
Gecode::IntSet::IntSet ( const std::vector< std::pair< int, int >> &  r  )  [inline]

Initialize with ranges from vector r.

The minimum is the first element and the maximum is the second element.

Definition at line 129 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 168 of file int-set-1.hpp.

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

Return minimum of range at position i.

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

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

Return maximum of range at position i.

Definition at line 155 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 161 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 174 of file int-set-1.hpp.

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

Return size (cardinality) of set.

Definition at line 195 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 201 of file int-set-1.hpp.

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

Return minimum of entire set.

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

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

Return maximum of entire set.

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

bool Gecode::IntSet::operator== ( const IntSet s  )  const [inline]

Return whether s is equal.

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

bool Gecode::IntSet::operator!= ( const IntSet s  )  const [inline]

Return whether s is not equal.

Definition at line 220 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 289 of file int-set-1.hpp.


Member Data Documentation

const IntSet Gecode::IntSet::empty [static]

Empty set.

Definition at line 283 of file int.hh.


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