Generated on Thu Mar 22 10:39:53 2012 for Gecode by doxygen 1.6.3

Gecode::DerivedView< View > Class Template Reference
[Programming views for variables]

Base-class for derived views. More...

#include <view.hpp>

List of all members.

Public Types

typedef View::VarImpType VarImpType
 The variable implementation type belonging to the View.
typedef View::VarType VarType
 The variable type belonging to the View.

Protected Member Functions

 DerivedView (void)
 Default constructor.
 DerivedView (const View &y)
 Initialize with view y.

Protected Attributes

View x
 View from which this view is derived.

Generic view information



static bool varderived (void)
 Return whether this view is derived from a VarImpView.
VarImpTypevarimp (void) const
 Return variable implementation of view.
View base (void) const
 Return view from which this view is derived.
unsigned int degree (void) const
 Return degree (number of subscribed propagators).
double afc (void) const
 Return accumulated failure count (plus degree).

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)
 Translate modification event me to modification event delta for view.

Delta information for advisors



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

Domain tests



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

Dependencies



void subscribe (Space &home, Propagator &p, PropCond pc, bool schedule=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.

Cloning



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

Detailed Description

template<class View>
class Gecode::DerivedView< View >

Base-class for derived views.

Definition at line 208 of file view.hpp.


Member Typedef Documentation

template<class View>
typedef View::VarImpType Gecode::DerivedView< View >::VarImpType

The variable implementation type belonging to the View.

Definition at line 211 of file view.hpp.

template<class View>
typedef View::VarType Gecode::DerivedView< View >::VarType

The variable type belonging to the View.

Definition at line 213 of file view.hpp.


Constructor & Destructor Documentation

template<class View >
Gecode::DerivedView< View >::DerivedView ( void   )  [inline, protected]

Default constructor.

Definition at line 505 of file view.hpp.

template<class View>
Gecode::DerivedView< View >::DerivedView ( const View &  y  )  [inline, protected]

Initialize with view y.

Definition at line 509 of file view.hpp.


Member Function Documentation

template<class View >
bool Gecode::DerivedView< View >::varderived ( void   )  [inline, static]

Return whether this view is derived from a VarImpView.

Definition at line 514 of file view.hpp.

template<class View >
View::VarImpType * Gecode::DerivedView< View >::varimp ( void   )  const [inline]

Return variable implementation of view.

Definition at line 520 of file view.hpp.

template<class View >
View Gecode::DerivedView< View >::base ( void   )  const [inline]

Return view from which this view is derived.

Definition at line 526 of file view.hpp.

template<class View >
unsigned int Gecode::DerivedView< View >::degree ( void   )  const [inline]

Return degree (number of subscribed propagators).

Definition at line 532 of file view.hpp.

template<class View >
double Gecode::DerivedView< View >::afc ( void   )  const [inline]

Return accumulated failure count (plus degree).

Definition at line 537 of file view.hpp.

template<class View >
bool Gecode::DerivedView< View >::assigned ( void   )  const [inline]

Test whether view is assigned.

Definition at line 542 of file view.hpp.

template<class View >
void Gecode::DerivedView< View >::schedule ( Space home,
Propagator p,
ModEvent  me 
) [inline, static]

Schedule propagator p with modification event me.

Reimplemented in Gecode::Set::SingletonView, Gecode::Set::ComplementView< View >, and Gecode::Set::CachedView< View >.

Definition at line 548 of file view.hpp.

template<class View >
ModEvent Gecode::DerivedView< View >::me ( const ModEventDelta med  )  [inline, static]

Return modification event for view type in med.

Reimplemented in Gecode::Set::SingletonView, Gecode::Set::ComplementView< View >, and Gecode::Set::CachedView< View >.

Definition at line 553 of file view.hpp.

template<class View >
ModEventDelta Gecode::DerivedView< View >::med ( ModEvent  me  )  [inline, static]
template<class View >
void Gecode::DerivedView< View >::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).

Reimplemented in Gecode::Set::SingletonView, Gecode::Set::ComplementView< View >, and Gecode::Set::CachedView< View >.

Definition at line 564 of file view.hpp.

template<class View >
void Gecode::DerivedView< View >::cancel ( Space home,
Propagator p,
PropCond  pc 
) [inline]

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

Reimplemented in Gecode::Set::SingletonView, Gecode::Set::ComplementView< View >, and Gecode::Set::CachedView< View >.

Definition at line 570 of file view.hpp.

template<class View >
void Gecode::DerivedView< View >::subscribe ( Space home,
Advisor a 
) [inline]

Subscribe advisor a to view.

Reimplemented in Gecode::Set::SingletonView, Gecode::Set::ComplementView< View >, and Gecode::Set::CachedView< View >.

Definition at line 575 of file view.hpp.

template<class View >
void Gecode::DerivedView< View >::cancel ( Space home,
Advisor a 
) [inline]

Cancel subscription of advisor a.

Reimplemented in Gecode::Set::SingletonView, Gecode::Set::ComplementView< View >, and Gecode::Set::CachedView< View >.

Definition at line 580 of file view.hpp.

template<class View >
ModEvent Gecode::DerivedView< View >::modevent ( const Delta d  )  [inline, static]

Return modification event.

Reimplemented in Gecode::Set::SingletonView, Gecode::Set::ComplementView< View >, and Gecode::Set::CachedView< View >.

Definition at line 585 of file view.hpp.

template<class View>
void Gecode::DerivedView< View >::update ( Space home,
bool  share,
DerivedView< View > &  y 
) [inline]

Update this view to be a clone of view y.

Definition at line 590 of file view.hpp.


Member Data Documentation

template<class View>
View Gecode::DerivedView< View >::x [protected]

View from which this view is derived.

Definition at line 216 of file view.hpp.


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