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

Gecode::Int::ScaleView< Val, UnsVal > Class Template Reference
[Integer views]

Scale integer view (template). More...

#include <view.hpp>

List of all members.

Protected Attributes

int a
 Scale factor.

Related Functions

(Note that these are not member functions.)



template<class Char , class Traits >
std::basic_ostream< Char,
Traits > & 
operator<< (std::basic_ostream< Char, Traits > &os, const ZeroIntView &x)
 Print integer zero view.

Support functions for division



int floor_div (double x) const
 Return $\lfloor x/a\rfloor$.
int ceil_div (double x) const
 Return $\lceil x/a\rceil$.
int exact_div (double x, bool &exact) const
 Return $x/a$ and set exact to true if x is multiple of a.
int floor_div (int) const
 Return $\lfloor x/a\rfloor$.
int ceil_div (int) const
 Return $\lceil x/a\rceil$.
int exact_div (int, bool &) const
 Return $x/a$ and set exact to true if x is multiple of a.

Constructors and initialization



 ScaleView (void)
 Default constructor.
 ScaleView (int b, const IntView &y)
 Initialize as $b\cdot y$.
void init (int b, const IntView &y)
 Initialize as $b\cdot y$.
int scale (void) const
 Return scale factor of scale view.

Value access



Val min (void) const
 Return minimum of domain.
Val max (void) const
 Return maximum of domain.
Val med (void) const
 Return median of domain (greatest element not greater than the median).
Val val (void) const
 Return assigned value (only if assigned).
UnsVal size (void) const
 Return size (cardinality) of domain.
UnsVal width (void) const
 Return width of domain (distance between maximum and minimum).
UnsVal regret_min (void) const
 Return regret of domain minimum (distance to next larger value).
UnsVal 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 (Val n) const
 Test whether n is contained in domain.

Domain update by value



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

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



Val min (const Delta &d) const
 Return minimum value just pruned.
Val 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, ScaleView< Val, UnsVal > &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

template<class Val, class UnsVal>
class Gecode::Int::ScaleView< Val, UnsVal >

Scale integer view (template).

A scale integer view $s$ for an integer view $x$ and a non-negative integer $a$ provides operations such that $s$ behaves as $a\cdot x$.

The precision of a scale integer view is defined by the value types Val and UnsVal. Val can be either int or double where UnsVal must be the unsigned variant of Val (that is, if Val is int, then UnsVal must be unsigned int; if Val is double, then UnsVal must be double as well). The range which is allowed for the two types is defined by the values in Gecode::Limits.

Note that scale integer views currently do not provide operations for updating domains by range iterators.

The template is not to be used directly (as it is very clumsy). Use the following instead:

  • IntScaleView for scale views with integer precision
  • DoubleScaleView for scale views with double precision

Definition at line 748 of file view.hpp.


Constructor & Destructor Documentation

template<class Val , class UnsVal >
Gecode::Int::ScaleView< Val, UnsVal >::ScaleView ( void   )  [inline]

Default constructor.

Definition at line 103 of file scale.hpp.

template<class Val , class UnsVal >
Gecode::Int::ScaleView< Val, UnsVal >::ScaleView ( int  b,
const IntView y 
) [inline]

Initialize as $b\cdot y$.

Definition at line 107 of file scale.hpp.


Member Function Documentation

template<class Val , class UnsVal >
int Gecode::Int::ScaleView< Val, UnsVal >::floor_div ( double  x  )  const [inline, protected]

Return $\lfloor x/a\rfloor$.

Definition at line 48 of file scale.hpp.

template<class Val , class UnsVal >
int Gecode::Int::ScaleView< Val, UnsVal >::ceil_div ( double  x  )  const [inline, protected]

Return $\lceil x/a\rceil$.

Definition at line 54 of file scale.hpp.

template<class Val , class UnsVal >
int Gecode::Int::ScaleView< Val, UnsVal >::exact_div ( double  x,
bool &  exact 
) const [inline, protected]

Return $x/a$ and set exact to true if x is multiple of a.

Definition at line 60 of file scale.hpp.

template<class Val, class UnsVal>
int Gecode::Int::ScaleView< Val, UnsVal >::floor_div ( int   )  const [protected]

Return $\lfloor x/a\rfloor$.

template<class Val, class UnsVal>
int Gecode::Int::ScaleView< Val, UnsVal >::ceil_div ( int   )  const [protected]

Return $\lceil x/a\rceil$.

template<class Val, class UnsVal>
int Gecode::Int::ScaleView< Val, UnsVal >::exact_div ( int  ,
bool &   
) const [protected]

Return $x/a$ and set exact to true if x is multiple of a.

template<class Val , class UnsVal >
void Gecode::Int::ScaleView< Val, UnsVal >::init ( int  b,
const IntView y 
) [inline]

Initialize as $b\cdot y$.

Definition at line 112 of file scale.hpp.

template<class Val , class UnsVal >
int Gecode::Int::ScaleView< Val, UnsVal >::scale ( void   )  const [inline]

Return scale factor of scale view.

Definition at line 118 of file scale.hpp.

template<class Val , class UnsVal >
Val Gecode::Int::ScaleView< Val, UnsVal >::min ( void   )  const [inline]

Return minimum of domain.

Definition at line 130 of file scale.hpp.

template<class Val , class UnsVal >
Val Gecode::Int::ScaleView< Val, UnsVal >::max ( void   )  const [inline]

Return maximum of domain.

Definition at line 136 of file scale.hpp.

template<class Val , class UnsVal >
Val Gecode::Int::ScaleView< Val, UnsVal >::med ( void   )  const [inline]

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

Definition at line 142 of file scale.hpp.

template<class Val , class UnsVal >
Val Gecode::Int::ScaleView< Val, UnsVal >::val ( void   )  const [inline]

Return assigned value (only if assigned).

Definition at line 148 of file scale.hpp.

template<class Val , class UnsVal >
UnsVal Gecode::Int::ScaleView< Val, UnsVal >::size ( void   )  const [inline]

Return size (cardinality) of domain.

Definition at line 154 of file scale.hpp.

template<class Val , class UnsVal >
UnsVal Gecode::Int::ScaleView< Val, UnsVal >::width ( void   )  const [inline]

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

Definition at line 160 of file scale.hpp.

template<class Val , class UnsVal >
UnsVal Gecode::Int::ScaleView< Val, UnsVal >::regret_min ( void   )  const [inline]

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

Definition at line 166 of file scale.hpp.

template<class Val , class UnsVal >
UnsVal Gecode::Int::ScaleView< Val, UnsVal >::regret_max ( void   )  const [inline]

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

Definition at line 172 of file scale.hpp.

template<class Val , class UnsVal >
bool Gecode::Int::ScaleView< Val, UnsVal >::range ( void   )  const [inline]

Test whether domain is a range.

Definition at line 183 of file scale.hpp.

template<class Val , class UnsVal >
bool Gecode::Int::ScaleView< Val, UnsVal >::assigned ( void   )  const [inline]

Test whether view is assigned.

Definition at line 189 of file scale.hpp.

template<class Val , class UnsVal >
bool Gecode::Int::ScaleView< Val, UnsVal >::in ( Val  n  )  const [inline]

Test whether n is contained in domain.

Definition at line 195 of file scale.hpp.

template<class Val , class UnsVal >
ModEvent Gecode::Int::ScaleView< Val, UnsVal >::lq ( Space home,
Val  n 
) [inline]

Restrict domain values to be less or equal than n.

Definition at line 210 of file scale.hpp.

template<class Val , class UnsVal >
ModEvent Gecode::Int::ScaleView< Val, UnsVal >::le ( Space home,
Val  n 
) [inline]

Restrict domain values to be less than n.

Definition at line 216 of file scale.hpp.

template<class Val , class UnsVal >
ModEvent Gecode::Int::ScaleView< Val, UnsVal >::gq ( Space home,
Val  n 
) [inline]

Restrict domain values to be greater or equal than n.

Definition at line 222 of file scale.hpp.

template<class Val , class UnsVal >
ModEvent Gecode::Int::ScaleView< Val, UnsVal >::gr ( Space home,
Val  n 
) [inline]

Restrict domain values to be greater than n.

Definition at line 227 of file scale.hpp.

template<class Val , class UnsVal >
ModEvent Gecode::Int::ScaleView< Val, UnsVal >::nq ( Space home,
Val  n 
) [inline]

Restrict domain values to be different from n.

Definition at line 233 of file scale.hpp.

template<class Val , class UnsVal >
ModEvent Gecode::Int::ScaleView< Val, UnsVal >::eq ( Space home,
Val  n 
) [inline]

Restrict domain values to be equal to n.

Definition at line 241 of file scale.hpp.

template<class Val , class UnsVal >
void Gecode::Int::ScaleView< Val, UnsVal >::schedule ( Space home,
Propagator p,
ModEvent  me 
) [inline, static]

Schedule propagator p with modification event me.

Definition at line 254 of file scale.hpp.

template<class Val , class UnsVal >
ModEvent Gecode::Int::ScaleView< Val, UnsVal >::me ( const ModEventDelta med  )  [inline, static]

Return modification event for view type in med.

Definition at line 259 of file scale.hpp.

template<class Val , class UnsVal >
ModEventDelta Gecode::Int::ScaleView< Val, UnsVal >::med ( ModEvent  me  )  [inline, static]

Translate modification event me to modification event delta for view.

Definition at line 265 of file scale.hpp.

template<class Val , class UnsVal >
void Gecode::Int::ScaleView< Val, UnsVal >::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 277 of file scale.hpp.

template<class Val , class UnsVal >
void Gecode::Int::ScaleView< Val, UnsVal >::cancel ( Space home,
Propagator p,
PropCond  pc 
) [inline]

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

Definition at line 283 of file scale.hpp.

template<class Val , class UnsVal >
void Gecode::Int::ScaleView< Val, UnsVal >::subscribe ( Space home,
Advisor a 
) [inline]

Subscribe advisor a to view.

Definition at line 288 of file scale.hpp.

template<class Val , class UnsVal >
void Gecode::Int::ScaleView< Val, UnsVal >::cancel ( Space home,
Advisor a 
) [inline]

Cancel subscription of advisor a.

Definition at line 293 of file scale.hpp.

template<class Val , class UnsVal >
ModEvent Gecode::Int::ScaleView< Val, UnsVal >::modevent ( const Delta d  )  [inline, static]

Return modification event.

Definition at line 304 of file scale.hpp.

template<class Val , class UnsVal >
Val Gecode::Int::ScaleView< Val, UnsVal >::min ( const Delta d  )  const [inline]

Return minimum value just pruned.

Definition at line 309 of file scale.hpp.

template<class Val , class UnsVal >
Val Gecode::Int::ScaleView< Val, UnsVal >::max ( const Delta d  )  const [inline]

Return maximum value just pruned.

Definition at line 314 of file scale.hpp.

template<class Val , class UnsVal >
bool Gecode::Int::ScaleView< Val, UnsVal >::any ( const Delta d  )  const [inline]

Test whether arbitrary values got pruned.

Definition at line 319 of file scale.hpp.

template<class Val , class UnsVal >
void Gecode::Int::ScaleView< Val, UnsVal >::update ( Space home,
bool  share,
ScaleView< Val, UnsVal > &  x 
) [inline]

Update this view to be a clone of view x.

Definition at line 331 of file scale.hpp.


Friends And Related Function Documentation

template<class Char , class Traits >
std::basic_ostream< Char, Traits > & operator<< ( std::basic_ostream< Char, Traits > &  os,
const ZeroIntView x 
) [related]

Print integer zero view.

Definition at line 129 of file print.hpp.


Member Data Documentation

template<class Val, class UnsVal>
int Gecode::Int::ScaleView< Val, UnsVal >::a [protected]

Scale factor.

Definition at line 751 of file view.hpp.


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