Generated on Wed Jan 4 17:49:19 2006 for Gecode by doxygen 1.4.6
Gecode::Int::ConstIntView

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

List of all members.

Detailed Description

Constant integer view.

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

Definition at line 718 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.

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 range iterator

template<class I>
ModEvent narrow (Space *home, I &i)
 Replace domain by range sequence described by i.
template<class I>
ModEvent inter (Space *home, I &i)
 Intersect domain with range sequence described by i.
template<class I>
ModEvent minus (Space *home, I &i)
 Remove from domain the range sequence described by i.

Dependencies

void subscribe (Space *home, Propagator *p, PropCond pc)
 Subscribe propagator p with propagation condition pc to view.
void cancel (Propagator *p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc to view.

Cloning

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

Propagator modification events

static ModEvent pme (const Propagator *p)
 Return modification event of propagator p for view.
static PropModEvent pme (ModEvent me)
 Translate modification event me to propagator modification event for view.

View comparison

bool same (const Int::ConstIntView &x, const Int::ConstIntView &y)
 Test whether views x and y are the same.
template<class View, unsigned int n>
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 31 of file constint.icc.

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

Initialize with integer value n.

Definition at line 33 of file constint.icc.

Member Function Documentation

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

Initialize with integer value n.

Definition at line 35 of file constint.icc.

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

Return minimum of domain.

Definition at line 45 of file constint.icc.

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

Return maximum of domain.

Definition at line 49 of file constint.icc.

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

Return median of domain.

Definition at line 53 of file constint.icc.

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

Return assigned value (only if assigned).

Definition at line 57 of file constint.icc.

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

Return size (cardinality) of domain.

Definition at line 62 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 66 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 70 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 74 of file constint.icc.

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

Test whether domain is a range.

Definition at line 84 of file constint.icc.

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

Test whether view is assigned.

Definition at line 88 of file constint.icc.

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

Test whether n is contained in domain.

Definition at line 93 of file constint.icc.

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

Test whether n is contained in domain.

Definition at line 97 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 107 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 111 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 116 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 120 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 125 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 129 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 134 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 138 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 143 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 147 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 152 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 156 of file constint.icc.

template<class I>
ModEvent Gecode::Int::ConstIntView::narrow (  Space *  home,
I &  i
)  [inline]
 

Replace domain by range sequence described by i.

Definition at line 168 of file constint.icc.

template<class I>
ModEvent Gecode::Int::ConstIntView::inter (  Space *  home,
I &  i
) 
 

Intersect domain with range sequence described by i.

Definition at line 173 of file constint.icc.

template<class I>
ModEvent Gecode::Int::ConstIntView::minus (  Space *  home,
I &  i
) 
 

Remove from domain the range sequence described by i.

Definition at line 179 of file constint.icc.

ModEvent Gecode::Int::ConstIntView::pme (  const Propagator *  p  )  [inline, static]
 

Return modification event of propagator p for view.

Definition at line 191 of file constint.icc.

PropModEvent Gecode::Int::ConstIntView::pme (  ModEvent  me  )  [inline, static]
 

Translate modification event me to propagator modification event for view.

Definition at line 195 of file constint.icc.

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

Subscribe propagator p with propagation condition pc to view.

Definition at line 205 of file constint.icc.

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

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

Definition at line 207 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 216 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 295 of file constint.icc.

template<class View, unsigned int n>
bool before (  const Int::ConstIntView &  x,
const Int::ConstIntView &  y
)  [related]
 

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

Definition at line 299 of file constint.icc.

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

Print constant integer view.

Definition at line 95 of file print.cc.

Member Data Documentation

int Gecode::Int::ConstIntView::x [protected]
 

Definition at line 720 of file view.icc.

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