Generated on Sat Feb 7 2015 02:01:41 for Gecode by doxygen 1.8.9.1
Gecode::VarImpView< Var > Class Template Reference

Base-class for variable implementation views. More...

#include <view.hpp>

Public Types

typedef Var VarType
 The variable type corresponding to the view. More...
 
typedef Var::VarImpType VarImpType
 The variable implementation type corresponding to the view. More...
 

Protected Member Functions

 VarImpView (void)
 Default constructor. More...
 
 VarImpView (VarImpType *y)
 Initialize with variable implementation y. More...
 

Protected Attributes

VarImpTypex
 Pointer to variable implementation. More...
 

View comparison

template<class VarA , class VarB >
bool same (const VarImpView< VarA > &x, const VarImpView< VarB > &y)
 Test whether views x and y are the same. More...
 
template<class ViewA , class ViewB >
bool before (const ViewA &x, const ViewB &y)
 Test whether view x comes before y (arbitrary order) More...
 

Generic view information

static bool varderived (void)
 Return whether this view is derived from a VarImpView. More...
 
VarImpTypevarimp (void) const
 Return variable implementation of view. More...
 
unsigned int degree (void) const
 Return degree (number of subscribed propagators and advisors) More...
 
double afc (const Space &home) const
 Return accumulated failure count. More...
 

Domain tests

bool assigned (void) const
 Test whether view is assigned. More...
 

View-dependent propagator support

static void schedule (Space &home, Propagator &p, ModEvent me)
 Schedule propagator p with modification event me. More...
 
static ModEvent me (const ModEventDelta &med)
 Return modification event for view type in med. More...
 
static ModEventDelta med (ModEvent me)
 Translate modification event me to modification event delta for view. More...
 

Dependencies

void subscribe (Space &home, Propagator &p, PropCond pc, bool schedule=true)
 Subscribe propagator p with propagation condition pc to view. More...
 
void cancel (Space &home, Propagator &p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc to view. More...
 
void subscribe (Space &home, Advisor &a)
 Subscribe advisor a to view. More...
 
void cancel (Space &home, Advisor &a)
 Cancel subscription of advisor a. More...
 

Delta information for advisors

static ModEvent modevent (const Delta &d)
 Return modification event. More...
 

Cloning

void update (Space &home, bool share, VarImpView< Var > &y)
 Update this view to be a clone of view y. More...
 

Detailed Description

template<class Var>
class Gecode::VarImpView< Var >

Base-class for variable implementation views.

Definition at line 117 of file view.hpp.

Member Typedef Documentation

template<class Var>
typedef Var Gecode::VarImpView< Var >::VarType

The variable type corresponding to the view.

Definition at line 120 of file view.hpp.

template<class Var>
typedef Var::VarImpType Gecode::VarImpView< Var >::VarImpType

The variable implementation type corresponding to the view.

Definition at line 122 of file view.hpp.

Constructor & Destructor Documentation

template<class Var >
Gecode::VarImpView< Var >::VarImpView ( void  )
inlineprotected

Default constructor.

Definition at line 420 of file view.hpp.

template<class Var >
Gecode::VarImpView< Var >::VarImpView ( VarImpType y)
inlineprotected

Initialize with variable implementation y.

Definition at line 424 of file view.hpp.

Member Function Documentation

template<class Var >
bool Gecode::VarImpView< Var >::varderived ( void  )
inlinestatic

Return whether this view is derived from a VarImpView.

Definition at line 428 of file view.hpp.

template<class Var >
Var::VarImpType * Gecode::VarImpView< Var >::varimp ( void  ) const
inline

Return variable implementation of view.

Definition at line 433 of file view.hpp.

template<class Var >
unsigned int Gecode::VarImpView< Var >::degree ( void  ) const
inline

Return degree (number of subscribed propagators and advisors)

Definition at line 438 of file view.hpp.

template<class Var >
double Gecode::VarImpView< Var >::afc ( const Space home) const
inline

Return accumulated failure count.

Definition at line 443 of file view.hpp.

template<class Var >
bool Gecode::VarImpView< Var >::assigned ( void  ) const
inline

Test whether view is assigned.

Definition at line 448 of file view.hpp.

template<class Var >
void Gecode::VarImpView< Var >::schedule ( Space home,
Propagator p,
ModEvent  me 
)
inlinestatic

Schedule propagator p with modification event me.

Definition at line 474 of file view.hpp.

template<class Var >
ModEvent Gecode::VarImpView< Var >::me ( const ModEventDelta med)
inlinestatic

Return modification event for view type in med.

Definition at line 479 of file view.hpp.

template<class Var >
ModEventDelta Gecode::VarImpView< Var >::med ( ModEvent  me)
inlinestatic

Translate modification event me to modification event delta for view.

Definition at line 484 of file view.hpp.

template<class Var >
void Gecode::VarImpView< Var >::subscribe ( Space home,
Propagator p,
PropCond  pc,
bool  schedule = true 
)
inline

Subscribe propagator p with propagation condition pc to view.

In case schedule is false, the propagator is just subscribed but not scheduled for execution (this must be used when creating subscriptions during propagation).

Definition at line 453 of file view.hpp.

template<class Var >
void Gecode::VarImpView< Var >::cancel ( Space home,
Propagator p,
PropCond  pc 
)
inline

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

Definition at line 459 of file view.hpp.

template<class Var >
void Gecode::VarImpView< Var >::subscribe ( Space home,
Advisor a 
)
inline

Subscribe advisor a to view.

Definition at line 464 of file view.hpp.

template<class Var >
void Gecode::VarImpView< Var >::cancel ( Space home,
Advisor a 
)
inline

Cancel subscription of advisor a.

Definition at line 469 of file view.hpp.

template<class Var >
ModEvent Gecode::VarImpView< Var >::modevent ( const Delta d)
inlinestatic

Return modification event.

Definition at line 489 of file view.hpp.

template<class Var>
void Gecode::VarImpView< Var >::update ( Space home,
bool  share,
VarImpView< Var > &  y 
)
inline

Update this view to be a clone of view y.

Definition at line 494 of file view.hpp.

Friends And Related Function Documentation

template<class VarA , class VarB >
bool same ( const VarImpView< VarA > &  x,
const VarImpView< VarB > &  y 
)
related

Test whether views x and y are the same.

template<class ViewA , class ViewB >
bool before ( const ViewA &  x,
const ViewB &  y 
)
related

Test whether view x comes before y (arbitrary order)

Definition at line 650 of file view.hpp.

Member Data Documentation

template<class Var>
VarImpType* Gecode::VarImpView< Var >::x
protected

Pointer to variable implementation.

Definition at line 125 of file view.hpp.


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