Generated on Mon Jul 6 18:09:34 2009 for Gecode by doxygen 1.5.9

Gecode::Int::GCC::CardView Class Reference

Card integer view. More...

#include <occur.hpp>

List of all members.

Public Member Functions

 CardView (void)
 CardView (const IntView &x, int c)
 Initialize with integer view x and value c.
void init (const IntView &x, int c)
 Initialize with integer view x and value c.
void init (Space &home, int mi, int ma, int c)
int card (void) const
 Return value.
void card (int ca)
ModEvent inc (void)
 Increment counter.
void counter (int)
 Set the counter to the number of times value c occurs.
int counter (void)
 Return the number of times value c occurs.

Protected Attributes

int c
 Card.
int count
 Counter.

Value access

void operator= (const IntView &x)
 Assignment operator.
void operator= (const Gecode::Int::GCC::CardView &x)
 Assignment operator.
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).
IntView intview (void)
 Return used IntView.
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

Test whether domain is a range

bool range (void) const
 Test whether view is assigned.
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

Restrict domain values to be less or equal than n

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

Subscribe propagator p with propagation condition pc to view

void subscribe (Space &home, Propagator &p, PropCond pc, bool process=true)
 Cancel subscription of 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 variable.
void cancel (Space &home, Advisor &a)
 Cancel subscription of advisor a.

Cloning

Update this view to be a clone of view x

void update (Space &home, bool share, CardView &x)

View comparison

Test whether this view is the same as x

bool operator== (const CardView &x) const
 Test whether this view is not the same as x.
bool operator!= (const CardView &x) const
 Test whether this view is not the same as x.
bool operator< (const CardView &x) const
 Test whether this view is smaller than x (arbitrary order).
bool operator> (const CardView &x) const
 Test whether this view is larger than x (arbitrary order).

View-dependent propagator support

Schedule propagator p with modification event me

static void schedule (Space &home, Propagator &p, ModEvent me)
 Return modification event for view type in med.
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

Card integer view.

Definition at line 240 of file occur.hpp.


Constructor & Destructor Documentation

Gecode::Int::GCC::CardView::CardView ( void   )  [inline]

Definition at line 415 of file occur.hpp.

Gecode::Int::GCC::CardView::CardView ( const IntView x,
int  c 
) [inline]

Initialize with integer view x and value c.

Definition at line 418 of file occur.hpp.


Member Function Documentation

void Gecode::Int::GCC::CardView::init ( const IntView x,
int  c 
) [inline]

Initialize with integer view x and value c.

Definition at line 422 of file occur.hpp.

void Gecode::Int::GCC::CardView::init ( Space home,
int  mi,
int  ma,
int  c 
) [inline]

Definition at line 430 of file occur.hpp.

int Gecode::Int::GCC::CardView::card ( void   )  const [inline]

Return value.

Definition at line 444 of file occur.hpp.

void Gecode::Int::GCC::CardView::card ( int  ca  )  [inline]

Definition at line 439 of file occur.hpp.

ModEvent Gecode::Int::GCC::CardView::inc ( void   )  [inline]

Increment counter.

Definition at line 449 of file occur.hpp.

void Gecode::Int::GCC::CardView::counter ( int  c  )  [inline]

Set the counter to the number of times value c occurs.

Definition at line 459 of file occur.hpp.

int Gecode::Int::GCC::CardView::counter ( void   )  [inline]

Return the number of times value c occurs.

Definition at line 464 of file occur.hpp.

void Gecode::Int::GCC::CardView::operator= ( const IntView x  )  [inline]

Assignment operator.

Definition at line 474 of file occur.hpp.

void Gecode::Int::GCC::CardView::operator= ( const Gecode::Int::GCC::CardView x  )  [inline]

Assignment operator.

Definition at line 481 of file occur.hpp.

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

Return minimum of domain.

Definition at line 489 of file occur.hpp.

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

Return maximum of domain.

Definition at line 493 of file occur.hpp.

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

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

Definition at line 497 of file occur.hpp.

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

Return assigned value (only if assigned).

Definition at line 502 of file occur.hpp.

IntView Gecode::Int::GCC::CardView::intview ( void   )  [inline]

Return used IntView.

Definition at line 507 of file occur.hpp.

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

Return size (cardinality) of domain.

Definition at line 517 of file occur.hpp.

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

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

Definition at line 513 of file occur.hpp.

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

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

Definition at line 521 of file occur.hpp.

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

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

Definition at line 525 of file occur.hpp.

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

Test whether view is assigned.

Definition at line 534 of file occur.hpp.

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

Test whether view is assigned.

Definition at line 538 of file occur.hpp.

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

Test whether n is contained in domain.

Definition at line 543 of file occur.hpp.

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

Test whether n is contained in domain.

Definition at line 547 of file occur.hpp.

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

Restrict domain values to be less or equal than n.

Definition at line 557 of file occur.hpp.

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

Restrict domain values to be less or equal than n.

Definition at line 561 of file occur.hpp.

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

Restrict domain values to be less than n.

Definition at line 565 of file occur.hpp.

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

Restrict domain values to be less than n.

Definition at line 569 of file occur.hpp.

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

Restrict domain values to be greater or equal than n.

Definition at line 573 of file occur.hpp.

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

Restrict domain values to be greater or equal than n.

Definition at line 577 of file occur.hpp.

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

Restrict domain values to be greater than n.

Definition at line 581 of file occur.hpp.

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

Restrict domain values to be greater than n.

Definition at line 585 of file occur.hpp.

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

Restrict domain values to be different from n.

Definition at line 589 of file occur.hpp.

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

Restrict domain values to be different from n.

Definition at line 593 of file occur.hpp.

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

Restrict domain values to be equal to n.

Definition at line 597 of file occur.hpp.

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

Restrict domain values to be equal to n.

Definition at line 601 of file occur.hpp.

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

Replace domain by ranges described by i.

Definition at line 612 of file occur.hpp.

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

Intersect domain with ranges described by i.

Definition at line 617 of file occur.hpp.

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

Remove from domain the ranges described by i.

Definition at line 622 of file occur.hpp.

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

Replace domain by values described by i.

Definition at line 627 of file occur.hpp.

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

Intersect domain with values described by i.

Definition at line 632 of file occur.hpp.

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

Remove from domain the values described by i.

Definition at line 637 of file occur.hpp.

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

Return modification event for view type in med.

Definition at line 648 of file occur.hpp.

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

Return modification event for view type in med.

Definition at line 652 of file occur.hpp.

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

Translate modification event me to modification event delta for view.

Definition at line 656 of file occur.hpp.

void Gecode::Int::GCC::CardView::subscribe ( Space home,
Propagator p,
PropCond  pc,
bool  process = true 
) [inline]

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

Definition at line 666 of file occur.hpp.

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

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

Definition at line 670 of file occur.hpp.

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

Subscribe advisor a to variable.

Definition at line 674 of file occur.hpp.

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

Cancel subscription of advisor a.

Definition at line 678 of file occur.hpp.

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

Definition at line 688 of file occur.hpp.

bool Gecode::Int::GCC::CardView::operator== ( const CardView x  )  const

Test whether this view is not the same as x.

bool Gecode::Int::GCC::CardView::operator!= ( const CardView x  )  const

Test whether this view is not the same as x.

bool Gecode::Int::GCC::CardView::operator< ( const CardView x  )  const

Test whether this view is smaller than x (arbitrary order).

bool Gecode::Int::GCC::CardView::operator> ( const CardView x  )  const

Test whether this view is larger than x (arbitrary order).


Member Data Documentation

Card.

Definition at line 243 of file occur.hpp.

Counter.

Definition at line 245 of file occur.hpp.


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