Generated on Mon Nov 30 23:53:49 2009 for Gecode by doxygen 1.6.1

Gecode::Int::ConstIntView Class Reference
[Integer views]

Constant integer view. More...

#include <view.hpp>

List of all members.

Protected Attributes

int x

Constructors and initialization



 ConstIntView (void)
 Default constructor.
 ConstIntView (int n)
 Initialize with integer value n.
void init (int n)
 Initialize with integer value n.

Value access



int min (void) const
 Return minimum of domain.
int max (void) const
 Return maximum of domain.
int med (void) const
 Return median of domain (greatest element not greater than the median).
int val (void) const
 Return assigned value (only if assigned).
unsigned int size (void) const
 Return size (cardinality) of domain.
unsigned int width (void) const
 Return width of domain (distance between maximum and minimum).
unsigned int regret_min (void) const
 Return regret of domain minimum (distance to next larger value).
unsigned int regret_max (void) const
 Return regret of domain maximum (distance to next smaller value).

Domain tests



bool range (void) const
 Test whether domain is a range.
bool assigned (void) const
 Test whether view is assigned.
bool in (int n) const
 Test whether n is contained in domain.
bool in (double n) const
 Test whether n is contained in domain.

Domain update by value



ModEvent lq (Space &home, int n)
 Restrict domain values to be less or equal than n.
ModEvent lq (Space &home, double n)
 Restrict domain values to be less or equal than n.
ModEvent le (Space &home, int n)
 Restrict domain values to be less than n.
ModEvent le (Space &home, double n)
 Restrict domain values to be less than n.
ModEvent gq (Space &home, int n)
 Restrict domain values to be greater or equal than n.
ModEvent gq (Space &home, double n)
 Restrict domain values to be greater or equal than n.
ModEvent gr (Space &home, int n)
 Restrict domain values to be greater than n.
ModEvent gr (Space &home, double n)
 Restrict domain values to be greater than n.
ModEvent nq (Space &home, int n)
 Restrict domain values to be different from n.
ModEvent nq (Space &home, double n)
 Restrict domain values to be different from n.
ModEvent eq (Space &home, int n)
 Restrict domain values to be equal to n.
ModEvent eq (Space &home, double n)
 Restrict domain values to be equal to n.

Domain update by iterator

Views can be both updated by range and value iterators. Value iterators do not need to be strict in that the same value is allowed to occur more than once in the iterated sequence.

The argument depends must be true, if the iterator passed as argument depends on the view on which the operation is invoked. In this case, the view is only updated after the iterator has been consumed. Otherwise, the domain might be updated concurrently while following the iterator.



template<class I >
ModEvent narrow_r (Space &home, I &i, bool depends=true)
 Replace domain by ranges described by i.
template<class I >
ModEvent inter_r (Space &home, I &i, bool depends=true)
 Intersect domain with ranges described by i.
template<class I >
ModEvent minus_r (Space &home, I &i, bool depends=true)
 Remove from domain the ranges described by i.
template<class I >
ModEvent narrow_v (Space &home, I &i, bool depends=true)
 Replace domain by values described by i.
template<class I >
ModEvent inter_v (Space &home, I &i, bool depends=true)
 Intersect domain with values described by i.
template<class I >
ModEvent minus_v (Space &home, I &i, bool depends=true)
 Remove from domain the values 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.

Delta information for advisors



int min (const Delta &d) const
 Return minimum value just pruned.
int max (const Delta &d) const
 Return maximum value just pruned.
bool any (const Delta &d) const
 Test whether arbitrary values got pruned.
static ModEvent modevent (const Delta &d)
 Return modification event.

Cloning



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

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 me)
 Translate modification event me to modification event delta for view.

Detailed Description

Constant integer view.

A constant integer view $x$ for an integer $c$ provides operations such that $x$ behaves as a view assigned to $c$.

Definition at line 949 of file view.hpp.


Constructor & Destructor Documentation

Gecode::Int::ConstIntView::ConstIntView ( void   )  [inline]

Default constructor.

Definition at line 47 of file constint.hpp.

Gecode::Int::ConstIntView::ConstIntView ( int  n  )  [inline]

Initialize with integer value n.

Definition at line 49 of file constint.hpp.


Member Function Documentation

void Gecode::Int::ConstIntView::init ( int  n  )  [inline]

Initialize with integer value n.

Definition at line 51 of file constint.hpp.

int Gecode::Int::ConstIntView::min ( void   )  const [inline]

Return minimum of domain.

Definition at line 61 of file constint.hpp.

int Gecode::Int::ConstIntView::max ( void   )  const [inline]

Return maximum of domain.

Definition at line 65 of file constint.hpp.

int Gecode::Int::ConstIntView::med ( void   )  const [inline]

Return median of domain (greatest element not greater than the median).

Definition at line 69 of file constint.hpp.

int Gecode::Int::ConstIntView::val ( void   )  const [inline]

Return assigned value (only if assigned).

Definition at line 73 of file constint.hpp.

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

Return size (cardinality) of domain.

Definition at line 78 of file constint.hpp.

unsigned int Gecode::Int::ConstIntView::width ( void   )  const [inline]

Return width of domain (distance between maximum and minimum).

Definition at line 82 of file constint.hpp.

unsigned int Gecode::Int::ConstIntView::regret_min ( void   )  const [inline]

Return regret of domain minimum (distance to next larger value).

Definition at line 86 of file constint.hpp.

unsigned int Gecode::Int::ConstIntView::regret_max ( void   )  const [inline]

Return regret of domain maximum (distance to next smaller value).

Definition at line 90 of file constint.hpp.

bool Gecode::Int::ConstIntView::range ( void   )  const [inline]

Test whether domain is a range.

Definition at line 100 of file constint.hpp.

bool Gecode::Int::ConstIntView::assigned ( void   )  const [inline]

Test whether view is assigned.

Definition at line 104 of file constint.hpp.

bool Gecode::Int::ConstIntView::in ( int  n  )  const [inline]

Test whether n is contained in domain.

Definition at line 109 of file constint.hpp.

bool Gecode::Int::ConstIntView::in ( double  n  )  const [inline]

Test whether n is contained in domain.

Definition at line 113 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::lq ( Space home,
int  n 
) [inline]

Restrict domain values to be less or equal than n.

Definition at line 123 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::lq ( Space home,
double  n 
) [inline]

Restrict domain values to be less or equal than n.

Definition at line 127 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::le ( Space home,
int  n 
) [inline]

Restrict domain values to be less than n.

Definition at line 132 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::le ( Space home,
double  n 
) [inline]

Restrict domain values to be less than n.

Definition at line 136 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::gq ( Space home,
int  n 
) [inline]

Restrict domain values to be greater or equal than n.

Definition at line 141 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::gq ( Space home,
double  n 
) [inline]

Restrict domain values to be greater or equal than n.

Definition at line 145 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::gr ( Space home,
int  n 
) [inline]

Restrict domain values to be greater than n.

Definition at line 150 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::gr ( Space home,
double  n 
) [inline]

Restrict domain values to be greater than n.

Definition at line 154 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::nq ( Space home,
int  n 
) [inline]

Restrict domain values to be different from n.

Definition at line 159 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::nq ( Space home,
double  n 
) [inline]

Restrict domain values to be different from n.

Definition at line 163 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::eq ( Space home,
int  n 
) [inline]

Restrict domain values to be equal to n.

Definition at line 168 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::eq ( Space home,
double  n 
) [inline]

Restrict domain values to be equal to n.

Definition at line 172 of file constint.hpp.

template<class I >
ModEvent Gecode::Int::ConstIntView::narrow_r ( Space home,
I &  i,
bool  depends = true 
) [inline]

Replace domain by ranges described by i.

Definition at line 184 of file constint.hpp.

template<class I >
ModEvent Gecode::Int::ConstIntView::inter_r ( Space home,
I &  i,
bool  depends = true 
) [inline]

Intersect domain with ranges described by i.

Definition at line 190 of file constint.hpp.

template<class I >
ModEvent Gecode::Int::ConstIntView::minus_r ( Space home,
I &  i,
bool  depends = true 
) [inline]

Remove from domain the ranges described by i.

Definition at line 198 of file constint.hpp.

template<class I >
ModEvent Gecode::Int::ConstIntView::narrow_v ( Space home,
I &  i,
bool  depends = true 
) [inline]

Replace domain by values described by i.

Definition at line 206 of file constint.hpp.

template<class I >
ModEvent Gecode::Int::ConstIntView::inter_v ( Space home,
I &  i,
bool  depends = true 
) [inline]

Intersect domain with values described by i.

Definition at line 212 of file constint.hpp.

template<class I >
ModEvent Gecode::Int::ConstIntView::minus_v ( Space home,
I &  i,
bool  depends = true 
) [inline]

Remove from domain the values described by i.

Definition at line 220 of file constint.hpp.

void Gecode::Int::ConstIntView::schedule ( Space home,
Propagator p,
ModEvent  me 
) [inline, static]

Schedule propagator p with modification event me.

Definition at line 234 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::me ( const ModEventDelta med  )  [inline, static]

Return modification event for view type in med.

Definition at line 238 of file constint.hpp.

ModEventDelta Gecode::Int::ConstIntView::med ( ModEvent  me  )  [inline, static]

Translate modification event me to modification event delta for view.

Definition at line 242 of file constint.hpp.

void Gecode::Int::ConstIntView::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 252 of file constint.hpp.

void Gecode::Int::ConstIntView::cancel ( Space home,
Propagator p,
PropCond  pc 
) [inline]

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

Definition at line 256 of file constint.hpp.

void Gecode::Int::ConstIntView::subscribe ( Space home,
Advisor a 
) [inline]

Subscribe advisor a to view.

Definition at line 258 of file constint.hpp.

void Gecode::Int::ConstIntView::cancel ( Space home,
Advisor a 
) [inline]

Cancel subscription of advisor a.

Definition at line 260 of file constint.hpp.

ModEvent Gecode::Int::ConstIntView::modevent ( const Delta d  )  [inline, static]

Return modification event.

Definition at line 269 of file constint.hpp.

int Gecode::Int::ConstIntView::min ( const Delta d  )  const [inline]

Return minimum value just pruned.

Definition at line 273 of file constint.hpp.

int Gecode::Int::ConstIntView::max ( const Delta d  )  const [inline]

Return maximum value just pruned.

Definition at line 277 of file constint.hpp.

bool Gecode::Int::ConstIntView::any ( const Delta d  )  const [inline]

Test whether arbitrary values got pruned.

Definition at line 281 of file constint.hpp.

void Gecode::Int::ConstIntView::update ( Space home,
bool  share,
ConstIntView x 
) [inline]

Update this view to be a clone of view x.

Definition at line 292 of file constint.hpp.


Member Data Documentation

Definition at line 951 of file view.hpp.


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