Generated on Tue Feb 11 2025 17:33:26 for Gecode by doxygen 1.12.0

Base-class for constant views. More...

#include <view.hpp>

Public Types

typedef View::VarImpType VarImpType
 The variable implementation type corresponding to the constant view.
 
typedef View::VarType VarType
 The variable type corresponding to the constant view.
 

Generic view information

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

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 reschedule (Space &home, Propagator &p, PropCond pc)
 Re-schedule propagator p with propagation condition pc.
 
void subscribe (Space &home, Advisor &a, bool fail=false)
 Subscribe advisor a to view.
 
void cancel (Space &home, Advisor &a, bool fail=false)
 Cancel subscription of advisor a.
 

Cloning

void update (Space &home, ConstView &y)
 Update this view to be a clone of view y.
 

Ordering

bool operator< (const ConstView &y) const
 Whether this view comes before view y (arbitray order)
 

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.
 

Delta information for advisors

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

Detailed Description

template<class View>
class Gecode::ConstView< View >

Base-class for constant views.

Definition at line 45 of file view.hpp.

Member Typedef Documentation

◆ VarImpType

template<class View >
View::VarImpType Gecode::ConstView< View >::VarImpType

The variable implementation type corresponding to the constant view.

Definition at line 48 of file view.hpp.

◆ VarType

template<class View >
View::VarType Gecode::ConstView< View >::VarType

The variable type corresponding to the constant view.

Definition at line 50 of file view.hpp.

Member Function Documentation

◆ degree()

template<class View >
unsigned int Gecode::ConstView< View >::degree ( void ) const
inline

Return degree (number of subscribed propagators and advisors)

Definition at line 384 of file view.hpp.

◆ afc()

template<class View >
double Gecode::ConstView< View >::afc ( void ) const
inline

Return accumulated failure count.

Definition at line 389 of file view.hpp.

◆ varderived()

template<class View >
bool Gecode::ConstView< View >::varderived ( void )
inlinestatic

Return whether this view is derived from a VarImpView.

Definition at line 394 of file view.hpp.

◆ varimp()

template<class View >
View::VarImpType * Gecode::ConstView< View >::varimp ( void ) const
inline

Return dummy variable implementation of view.

Definition at line 399 of file view.hpp.

◆ assigned()

template<class View >
bool Gecode::ConstView< View >::assigned ( void ) const
inline

Test whether view is assigned.

Definition at line 411 of file view.hpp.

◆ schedule()

template<class View >
void Gecode::ConstView< View >::schedule ( Space & home,
Propagator & p,
ModEvent me )
inlinestatic

Schedule propagator p with modification event me.

Definition at line 440 of file view.hpp.

◆ me()

template<class View >
ModEvent Gecode::ConstView< View >::me ( const ModEventDelta & med)
inlinestatic

Return modification event for view type in med.

Definition at line 445 of file view.hpp.

◆ med()

template<class View >
ModEventDelta Gecode::ConstView< View >::med ( ModEvent me)
inlinestatic

Translate modification event me to modification event delta for view.

Definition at line 450 of file view.hpp.

◆ subscribe() [1/2]

template<class View >
void Gecode::ConstView< 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).

Definition at line 416 of file view.hpp.

◆ cancel() [1/2]

template<class View >
void Gecode::ConstView< View >::cancel ( Space & home,
Propagator & p,
PropCond pc )
inline

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

Definition at line 423 of file view.hpp.

◆ reschedule()

template<class View >
void Gecode::ConstView< View >::reschedule ( Space & home,
Propagator & p,
PropCond pc )
inline

Re-schedule propagator p with propagation condition pc.

Definition at line 427 of file view.hpp.

◆ subscribe() [2/2]

template<class View >
void Gecode::ConstView< View >::subscribe ( Space & home,
Advisor & a,
bool fail = false )
inline

Subscribe advisor a to view.

If fail is true, run the advisor also on failure. This feature is undocumented.

Definition at line 432 of file view.hpp.

◆ cancel() [2/2]

template<class View >
void Gecode::ConstView< View >::cancel ( Space & home,
Advisor & a,
bool fail = false )
inline

Cancel subscription of advisor a.

Definition at line 436 of file view.hpp.

◆ modevent()

template<class View >
ModEvent Gecode::ConstView< View >::modevent ( const Delta & d)
inlinestatic

Return modification event.

Definition at line 455 of file view.hpp.

◆ update()

template<class View >
void Gecode::ConstView< View >::update ( Space & home,
ConstView< View > & y )
inline

Update this view to be a clone of view y.

Definition at line 461 of file view.hpp.

◆ operator<()

template<class View >
bool Gecode::ConstView< View >::operator< ( const ConstView< View > & y) const
inline

Whether this view comes before view y (arbitray order)

Definition at line 464 of file view.hpp.


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