Generated on Wed Nov 1 15:05:15 2006 for Gecode by doxygen 1.4.5
Gecode::Int::OffsetView

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

Inherits Gecode::DerivedViewBase< IntView >.

List of all members.

Detailed Description

Offset integer view.

An offset integer view $o$ for an integer view $x$ and an integer $c$ provides operations such that $o$ behaves as $x+c$ .

Definition at line 395 of file view.icc.

Constructors and initialization

 OffsetView (void)
 Default constructor.
 OffsetView (const IntView &x, int c)
 Initialize with integer view x and offset c.
void init (const IntView &x, int c)
 Initialize with integer view x and offset c.
int offset (void) const
 Return offset.

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, bool process=true)
 Subscribe propagator p with propagation condition pc to variable.
void cancel (Space *home, Propagator *p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc to view.

Cloning

void update (Space *home, bool share, OffsetView &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::OffsetView &x, const Int::OffsetView &y)
 Test whether views x and y are the same.
bool before (const Int::OffsetView &x, const Int::OffsetView &y)
 Test whether view x comes before y (arbitrary order).

Protected Attributes

int c
 Offset.

Related Functions

(Note that these are not member functions.)

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

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 31 of file offset.icc.

Gecode::Int::OffsetView::OffsetView (  const IntView &  x,
int  c
)  [inline]
 

Initialize with integer view x and offset c.

Definition at line 33 of file offset.icc.

Member Function Documentation

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

Initialize with integer view x and offset c.

Definition at line 36 of file offset.icc.

int Gecode::Int::OffsetView::offset (  void   )  const [inline]
 

Return offset.

Definition at line 40 of file offset.icc.

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

Return minimum of domain.

Definition at line 50 of file offset.icc.

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

Return maximum of domain.

Definition at line 54 of file offset.icc.

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

Return median of domain.

Definition at line 58 of file offset.icc.

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

Return assigned value (only if assigned).

Definition at line 62 of file offset.icc.

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

Return size (cardinality) of domain.

Definition at line 71 of file offset.icc.

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

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

Definition at line 67 of file offset.icc.

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

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

Definition at line 75 of file offset.icc.

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

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

Definition at line 79 of file offset.icc.

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

Test whether domain is a range.

Definition at line 88 of file offset.icc.

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

Test whether view is assigned.

Definition at line 92 of file offset.icc.

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

Test whether n is contained in domain.

Definition at line 97 of file offset.icc.

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

Test whether n is contained in domain.

Definition at line 101 of file offset.icc.

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

Restrict domain values to be less or equal than n.

Definition at line 111 of file offset.icc.

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

Restrict domain values to be less or equal than n.

Definition at line 115 of file offset.icc.

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

Restrict domain values to be less than n.

Definition at line 119 of file offset.icc.

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

Restrict domain values to be less than n.

Definition at line 123 of file offset.icc.

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

Restrict domain values to be greater or equal than n.

Definition at line 127 of file offset.icc.

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

Restrict domain values to be greater or equal than n.

Definition at line 131 of file offset.icc.

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

Restrict domain values to be greater than n.

Definition at line 135 of file offset.icc.

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

Restrict domain values to be greater than n.

Definition at line 139 of file offset.icc.

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

Restrict domain values to be different from n.

Definition at line 143 of file offset.icc.

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

Restrict domain values to be different from n.

Definition at line 147 of file offset.icc.

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

Restrict domain values to be equal to n.

Definition at line 151 of file offset.icc.

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

Restrict domain values to be equal to n.

Definition at line 155 of file offset.icc.

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

Replace domain by range sequence described by i.

Definition at line 167 of file offset.icc.

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

Intersect domain with range sequence described by i.

Definition at line 172 of file offset.icc.

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

Remove from domain the range sequence described by i.

Definition at line 177 of file offset.icc.

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

Return modification event of propagator p for view.

Definition at line 188 of file offset.icc.

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

Translate modification event me to propagator modification event for view.

Definition at line 192 of file offset.icc.

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

Subscribe propagator p with propagation condition pc to variable.

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 202 of file offset.icc.

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

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

Definition at line 207 of file offset.icc.

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

Update this view to be a clone of view x.

Definition at line 217 of file offset.icc.

Friends And Related Function Documentation

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

Test whether views x and y are the same.

Definition at line 262 of file offset.icc.

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

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

Definition at line 266 of file offset.icc.

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

Print offset integer view.

Definition at line 83 of file print.cc.

Member Data Documentation

int Gecode::Int::OffsetView::c [protected]
 

Offset.

Definition at line 398 of file view.icc.

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