Generated on Mon Jul 6 18:09:38 2009 for Gecode by doxygen 1.5.9
Gecode::Set::OffsetSetView

Gecode::Set::OffsetSetView< View > Class Template Reference
[Set views]

Offset set view. More...

#include <view.hpp>

List of all members.

Protected Attributes

int k
 The offset.

Related Functions

(Note that these are not member functions.)

template<class Char , class Traits , class View >
std::basic_ostream< Char,
Traits > & 		operator<< (std::basic_ostream< Char, Traits > &os, const OffsetSetView< View > &x)
 Print offset set view.

Constructors and initialization

 OffsetSetView (void)
 Default constructor.
 OffsetSetView (View &x, int k0)
 Initialize with set view x and offset k0.

Value access

unsigned int cardMin (void) const
 Return minimum cardinality.
unsigned int cardMax (void) const
 Return maximum cardinality.
int lubMin (void) const
 Return minimum of the least upper bound.
int lubMax (void) const
 Return maximum of the least upper bound.
int lubMinN (unsigned int n) const
 Return n-th smallest element of the least upper bound.
int glbMin (void) const
 Return minimum of the greatest lower bound.
int glbMax (void) const
 Return maximum of the greatest lower bound.
unsigned int glbSize (void) const
 Return the number of elements in the greatest lower bound.
unsigned int lubSize (void) const
 Return the number of elements in the least upper bound.
unsigned int unknownSize (void) const
 Return the number of unknown elements.
int offset (void) const
 Return the offset.

Domain tests

bool assigned (void) const
 Test whether view is assigned.
bool contains (int i) const
 Test whether i is in the greatest lower bound.
bool notContains (int i) const
 Test whether i is not in the least upper bound.

Domain update by value

ModEvent cardMin (Space &home, unsigned int m)
 Restrict cardinality to be greater than or equal to m.
ModEvent cardMax (Space &home, unsigned int m)
 Restrict cardinality to be less than or equal to m.
ModEvent include (Space &home, int i, int j)
 Update greatest lower bound to include all elements between and including i and j.
ModEvent exclude (Space &home, int i, int j)
 Restrict least upper bound to not contain all elements between and including i and j.
ModEvent include (Space &home, int i)
 Update greatest lower bound to contain i.
ModEvent exclude (Space &home, int i)
 Restrict least upper bound to not contain i.
ModEvent intersect (Space &home, int i, int j)
 Update least upper bound to contain at most all elements between and including i and j.
ModEvent intersect (Space &home, int i)
 Update least upper bound to contain at most the element i.

Domain update by range iterator

template<class I >
ModEvent excludeI (Space &home, I &i)
 Remove range sequence described by i from least upper bound.
template<class I >
ModEvent includeI (Space &home, I &i)
 Include range sequence described by i in greatest lower bound.
template<class I >
ModEvent intersectI (Space &home, I &iter)
 Intersect least upper bound with range sequence described by i.

Dependencies

void subscribe (Space &home, Propagator &p, PropCond pc, bool process=true)
 Subscribe propagator p with propagation condition pc to view.
void cancel (Space &home, Propagator &p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc to view.
void subscribe (Space &home, Advisor &a)
 Subscribe advisor a to view.
void cancel (Space &home, Advisor &a)
 Cancel subscription of advisor a.

Cloning

void update (Space &home, bool share, OffsetSetView &x)
 Update this view to be a clone of view x.

Delta information for advisors

int glbMin (const Delta &d) const
 Return minimum value just pruned from glb.
int glbMax (const Delta &d) const
 Return maximum value just pruned from glb.
bool glbAny (const Delta &d) const
 Test whether arbitrary values got pruned from glb.
int lubMin (const Delta &d) const
 Return minimum value just pruned from lub.
int lubMax (const Delta &d) const
 Return maximum value just pruned from lub.
bool lubAny (const Delta &d) const
 Test whether arbitrary values got pruned from lub.
static ModEvent modevent (const Delta &d)
 Return modification event.

View-dependent propagator support

static void schedule (Space &home, Propagator &p, ModEvent me)
 Schedule propagator p with modification event me.
static ModEvent me (const ModEventDelta &med)
 Return modification event for view type in med.
static ModEventDelta med (ModEvent)
 Translate modification event me to modification event delta for view.

Detailed Description

template<class View>
class Gecode::Set::OffsetSetView< View >

Offset set view.

An offset set view $s$ for a set view $t$ provides operations such that $s$ behaves like $\{i+k\ |\ i\in t\}$.

Definition at line 1189 of file view.hpp.

Constructor & Destructor Documentation

template<class View >
Gecode::Set::OffsetSetView< View >::OffsetSetView ( void   )  [inline]

Default constructor.

Definition at line 50 of file offset.hpp.

template<class View >
Gecode::Set::OffsetSetView< View >::OffsetSetView ( View &  x,
int  k0 
) [inline]

Initialize with set view x and offset k0.

Definition at line 54 of file offset.hpp.

Member Function Documentation

template<class View >
unsigned int Gecode::Set::OffsetSetView< View >::cardMin ( void   )  const [inline]

Return minimum cardinality.

Definition at line 99 of file offset.hpp.

template<class View >
unsigned int Gecode::Set::OffsetSetView< View >::cardMax ( void   )  const [inline]

Return maximum cardinality.

Definition at line 105 of file offset.hpp.

template<class View >
int Gecode::Set::OffsetSetView< View >::lubMin ( void   )  const [inline]

Return minimum of the least upper bound.

Definition at line 111 of file offset.hpp.

template<class View >
int Gecode::Set::OffsetSetView< View >::lubMax ( void   )  const [inline]

Return maximum of the least upper bound.

Definition at line 119 of file offset.hpp.

template<class View>
int Gecode::Set::OffsetSetView< View >::lubMinN ( unsigned int  n  )  const

Return n-th smallest element of the least upper bound.

template<class View >
int Gecode::Set::OffsetSetView< View >::glbMin ( void   )  const [inline]

Return minimum of the greatest lower bound.

Definition at line 127 of file offset.hpp.

template<class View >
int Gecode::Set::OffsetSetView< View >::glbMax ( void   )  const [inline]

Return maximum of the greatest lower bound.

Definition at line 135 of file offset.hpp.

template<class View >
unsigned int Gecode::Set::OffsetSetView< View >::glbSize ( void   )  const [inline]

Return the number of elements in the greatest lower bound.

Definition at line 63 of file offset.hpp.

template<class View >
unsigned int Gecode::Set::OffsetSetView< View >::lubSize ( void   )  const [inline]

Return the number of elements in the least upper bound.

Definition at line 69 of file offset.hpp.

template<class View >
unsigned int Gecode::Set::OffsetSetView< View >::unknownSize ( void   )  const [inline]

Return the number of unknown elements.

Definition at line 75 of file offset.hpp.

template<class View >
int Gecode::Set::OffsetSetView< View >::offset ( void   )  const [inline]

Return the offset.

Definition at line 81 of file offset.hpp.

template<class View >
bool Gecode::Set::OffsetSetView< View >::assigned ( void   )  const [inline]

Test whether view is assigned.

Definition at line 59 of file offset.hpp.

template<class View >
bool Gecode::Set::OffsetSetView< View >::contains ( int  i  )  const [inline]

Test whether i is in the greatest lower bound.

Definition at line 87 of file offset.hpp.

template<class View >
bool Gecode::Set::OffsetSetView< View >::notContains ( int  i  )  const [inline]

Test whether i is not in the least upper bound.

Definition at line 93 of file offset.hpp.

template<class View >
ModEvent Gecode::Set::OffsetSetView< View >::cardMin ( Space &  home,
unsigned int  m 
) [inline]

Restrict cardinality to be greater than or equal to m.

Definition at line 143 of file offset.hpp.

template<class View >
ModEvent Gecode::Set::OffsetSetView< View >::cardMax ( Space &  home,
unsigned int  m 
) [inline]

Restrict cardinality to be less than or equal to m.

Definition at line 149 of file offset.hpp.

template<class View >
ModEvent Gecode::Set::OffsetSetView< View >::include ( Space &  home,
int  i,
int  j 
) [inline]

Update greatest lower bound to include all elements between and including i and j.

Definition at line 179 of file offset.hpp.

template<class View >
ModEvent Gecode::Set::OffsetSetView< View >::exclude ( Space &  home,
int  i,
int  j 
) [inline]

Restrict least upper bound to not contain all elements between and including i and j.

Definition at line 185 of file offset.hpp.

template<class View >
ModEvent Gecode::Set::OffsetSetView< View >::include ( Space &  home,
int  i 
) [inline]

Update greatest lower bound to contain i.

Definition at line 155 of file offset.hpp.

template<class View >
ModEvent Gecode::Set::OffsetSetView< View >::exclude ( Space &  home,
int  i 
) [inline]

Restrict least upper bound to not contain i.

Definition at line 161 of file offset.hpp.

template<class View >
ModEvent Gecode::Set::OffsetSetView< View >::intersect ( Space &  home,
int  i,
int  j 
) [inline]

Update least upper bound to contain at most all elements between and including i and j.

Definition at line 173 of file offset.hpp.

template<class View >
ModEvent Gecode::Set::OffsetSetView< View >::intersect ( Space &  home,
int  i 
) [inline]

Update least upper bound to contain at most the element i.

Definition at line 167 of file offset.hpp.

template<class View >
template<class I >
ModEvent Gecode::Set::OffsetSetView< View >::excludeI ( Space &  home,
I &  i 
) [inline]

Remove range sequence described by i from least upper bound.

Definition at line 191 of file offset.hpp.

template<class View >
template<class I >
ModEvent Gecode::Set::OffsetSetView< View >::includeI ( Space &  home,
I &  i 
) [inline]

Include range sequence described by i in greatest lower bound.

Definition at line 198 of file offset.hpp.

template<class View >
template<class I >
ModEvent Gecode::Set::OffsetSetView< View >::intersectI ( Space &  home,
I &  iter 
) [inline]

Intersect least upper bound with range sequence described by i.

Definition at line 205 of file offset.hpp.

template<class View >
void Gecode::Set::OffsetSetView< View >::schedule ( Space &  home,
Propagator &  p,
ModEvent  me 
) [inline, static]

Schedule propagator p with modification event me.

Definition at line 237 of file offset.hpp.

template<class View >
ModEvent Gecode::Set::OffsetSetView< View >::me ( const ModEventDelta &  med  )  [inline, static]

Return modification event for view type in med.

Definition at line 242 of file offset.hpp.

template<class View >
ModEventDelta Gecode::Set::OffsetSetView< View >::med ( ModEvent  me  )  [inline, static]

Translate modification event me to modification event delta for view.

Definition at line 248 of file offset.hpp.

template<class View >
void Gecode::Set::OffsetSetView< View >::subscribe ( Space &  home,
Propagator &  p,
PropCond  pc,
bool  process = true 
) [inline]

Subscribe propagator p with propagation condition pc to view.

In case process is false, the propagator is just subscribed but not processed for execution (this must be used when creating subscriptions during propagation).

Definition at line 212 of file offset.hpp.

template<class View >
void Gecode::Set::OffsetSetView< View >::cancel ( Space &  home,
Propagator &  p,
PropCond  pc 
) [inline]

Cancel subscription of propagator p with propagation condition pc to view.

Definition at line 219 of file offset.hpp.

template<class View >
void Gecode::Set::OffsetSetView< View >::subscribe ( Space &  home,
Advisor &  a 
) [inline]

Subscribe advisor a to view.

Definition at line 225 of file offset.hpp.

template<class View >
void Gecode::Set::OffsetSetView< View >::cancel ( Space &  home,
Advisor &  a 
) [inline]

Cancel subscription of advisor a.

Definition at line 231 of file offset.hpp.

template<class View >
void Gecode::Set::OffsetSetView< View >::update ( Space &  home,
bool  share,
OffsetSetView< View > &  x 
) [inline]

Update this view to be a clone of view x.

Definition at line 254 of file offset.hpp.

template<class View >
ModEvent Gecode::Set::OffsetSetView< View >::modevent ( const Delta &  d  )  [inline, static]

Return modification event.

Definition at line 267 of file offset.hpp.

template<class View >
int Gecode::Set::OffsetSetView< View >::glbMin ( const Delta &  d  )  const [inline]

Return minimum value just pruned from glb.

Definition at line 273 of file offset.hpp.

template<class View >
int Gecode::Set::OffsetSetView< View >::glbMax ( const Delta &  d  )  const [inline]

Return maximum value just pruned from glb.

Definition at line 279 of file offset.hpp.

template<class View >
bool Gecode::Set::OffsetSetView< View >::glbAny ( const Delta &  d  )  const [inline]

Test whether arbitrary values got pruned from glb.

Definition at line 285 of file offset.hpp.

template<class View >
int Gecode::Set::OffsetSetView< View >::lubMin ( const Delta &  d  )  const [inline]

Return minimum value just pruned from lub.

Definition at line 291 of file offset.hpp.

template<class View >
int Gecode::Set::OffsetSetView< View >::lubMax ( const Delta &  d  )  const [inline]

Return maximum value just pruned from lub.

Definition at line 297 of file offset.hpp.

template<class View >
bool Gecode::Set::OffsetSetView< View >::lubAny ( const Delta &  d  )  const [inline]

Test whether arbitrary values got pruned from lub.

Definition at line 303 of file offset.hpp.

Friends And Related Function Documentation

template<class Char , class Traits , class View >
std::basic_ostream< Char, Traits > & operator<< ( std::basic_ostream< Char, Traits > &  os,
const OffsetSetView< View > &  x 
) [related]

Print offset set view.

Definition at line 450 of file offset.hpp.

Member Data Documentation

template<class View>
int Gecode::Set::OffsetSetView< View >::k [protected]

The offset.

Definition at line 1193 of file view.hpp.

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