Generated on Mon Aug 25 11:35:50 2008 for Gecode by doxygen 1.5.6

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

Inherits Gecode::ConstViewBase.

List of all members.


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 962 of file view.icc.


Constructors and initialization

 ConstIntView (void)
 Default constructor.
 ConstIntView (int n)
 Initialize with integer value n.
void init (int n)
 Initialize with integer value n.
 ConstIntView (Space *home, const Reflection::VarMap &vars, Reflection::Arg *arg)
 Initialize from specification.

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.
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.

Reflection

Reflection::Argspec (const Space *home, Reflection::VarMap &m) const
 Return specification for this view, using variable map m.
static Support::Symbol type (void)
 Return specification for this view, using variable map m.

View-dependent propagator support

static void schedule (Space *home, Propagator *p, ModEvent me)
 Schedule propagator p with modification event me.
static ModEvent me (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.

View comparison

bool same (const Int::ConstIntView &x, const Int::ConstIntView &y)
 Test whether views x and y are the same.
bool before (const Int::ConstIntView &x, const Int::ConstIntView &y)
 Test whether view x is before y (arbitrary order).

Protected Attributes

int x

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &, const Gecode::Int::ConstIntView &)
 Print constant integer view.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 47 of file constint.icc.

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

Initialize with integer value n.

Definition at line 49 of file constint.icc.

Gecode::Int::ConstIntView::ConstIntView ( Space home,
const Reflection::VarMap vars,
Reflection::Arg arg 
) [inline]

Initialize from specification.

Definition at line 55 of file constint.icc.


Member Function Documentation

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

Initialize with integer value n.

Definition at line 51 of file constint.icc.

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

Return minimum of domain.

Definition at line 64 of file constint.icc.

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

Return maximum of domain.

Definition at line 68 of file constint.icc.

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

Return median of domain.

Definition at line 72 of file constint.icc.

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

Return assigned value (only if assigned).

Definition at line 76 of file constint.icc.

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

Return size (cardinality) of domain.

Definition at line 81 of file constint.icc.

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

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

Definition at line 85 of file constint.icc.

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

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

Definition at line 89 of file constint.icc.

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

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

Definition at line 93 of file constint.icc.

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

Test whether domain is a range.

Definition at line 103 of file constint.icc.

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

Test whether view is assigned.

Definition at line 107 of file constint.icc.

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

Test whether n is contained in domain.

Definition at line 112 of file constint.icc.

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

Test whether n is contained in domain.

Definition at line 116 of file constint.icc.

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

Restrict domain values to be less or equal than n.

Definition at line 126 of file constint.icc.

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

Restrict domain values to be less or equal than n.

Definition at line 130 of file constint.icc.

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

Restrict domain values to be less than n.

Definition at line 135 of file constint.icc.

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

Restrict domain values to be less than n.

Definition at line 139 of file constint.icc.

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

Restrict domain values to be greater or equal than n.

Definition at line 144 of file constint.icc.

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

Restrict domain values to be greater or equal than n.

Definition at line 148 of file constint.icc.

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

Restrict domain values to be greater than n.

Definition at line 153 of file constint.icc.

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

Restrict domain values to be greater than n.

Definition at line 157 of file constint.icc.

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

Restrict domain values to be different from n.

Definition at line 162 of file constint.icc.

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

Restrict domain values to be different from n.

Definition at line 166 of file constint.icc.

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

Restrict domain values to be equal to n.

Definition at line 171 of file constint.icc.

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

Restrict domain values to be equal to n.

Definition at line 175 of file constint.icc.

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 187 of file constint.icc.

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 192 of file constint.icc.

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 199 of file constint.icc.

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.icc.

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 211 of file constint.icc.

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 218 of file constint.icc.

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

Schedule propagator p with modification event me.

Definition at line 231 of file constint.icc.

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

Return modification event for view type in med.

Definition at line 235 of file constint.icc.

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

Translate modification event me to modification event delta for view.

Definition at line 239 of file constint.icc.

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 249 of file constint.icc.

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 253 of file constint.icc.

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

Subscribe advisor a to view.

Definition at line 255 of file constint.icc.

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

Cancel subscription of advisor a.

Definition at line 257 of file constint.icc.

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

Return modification event.

Definition at line 266 of file constint.icc.

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

Return minimum value just pruned.

Definition at line 270 of file constint.icc.

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

Return maximum value just pruned.

Definition at line 274 of file constint.icc.

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

Test whether arbitrary values got pruned.

Definition at line 278 of file constint.icc.

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 289 of file constint.icc.

Reflection::Arg * Gecode::Int::ConstIntView::spec ( const Space home,
Reflection::VarMap m 
) const [inline]

Return specification for this view, using variable map m.

Definition at line 298 of file constint.icc.

Support::Symbol Gecode::Int::ConstIntView::type ( void   )  [inline, static]

Return specification for this view, using variable map m.

Definition at line 302 of file constint.icc.


Friends And Related Function Documentation

bool same ( const Int::ConstIntView x,
const Int::ConstIntView y 
) [related]

Test whether views x and y are the same.

Definition at line 381 of file constint.icc.

bool before ( const Int::ConstIntView x,
const Int::ConstIntView y 
) [related]

Test whether view x is before y (arbitrary order).

Definition at line 385 of file constint.icc.

std::ostream & operator<< ( std::ostream &  ,
const Gecode::Int::ConstIntView  
) [related]

Print constant integer view.

Definition at line 115 of file print.cc.


Member Data Documentation

Definition at line 964 of file view.icc.


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