Generated on Thu Mar 16 2017 03:24:28 for Gecode by doxygen 1.8.13
Gecode::Home Class Reference

Home class for posting propagators More...

#include <core.hpp>

Protected Attributes

Spaces
 The space where the propagator is to be posted. More...
 
Propagatorp
 A propagator (possibly) that is currently being rewritten. More...
 
PropagatorGroup pg
 A propagator group. More...
 
BrancherGroup bg
 A brancher group. More...
 

Conversion

 Home (Space &s, Propagator *p=NULL, PropagatorGroup pg=PropagatorGroup::def, BrancherGroup bg=BrancherGroup::def)
 Initialize the home with space s and propagator p and group g. More...
 
Homeoperator= (const Home &h)
 Assignment operator. More...
 
 operator Space & (void)
 Retrieve the space of the home. More...
 

Extended information

Home operator() (Propagator &p)
 Return a home extended by propagator to be rewritten. More...
 
Home operator() (PropagatorGroup pg)
 Return a home extended by a propagator group. More...
 
Home operator() (BrancherGroup bg)
 Return a home extended by a brancher group. More...
 
Propagatorpropagator (void) const
 Return propagator (or NULL) for currently rewritten propagator. More...
 
PropagatorGroup propagatorgroup (void) const
 Return propagator group. More...
 
BrancherGroup branchergroup (void) const
 Return brancher group. More...
 

Forwarding of common space operations

bool failed (void) const
 Check whether corresponding space is failed. More...
 
void fail (void)
 Mark space as failed. More...
 
void notice (Actor &a, ActorProperty p, bool duplicate=false)
 Notice actor property. More...
 

Detailed Description

Home class for posting propagators

Definition at line 905 of file core.hpp.

Constructor & Destructor Documentation

◆ Home()

Gecode::Home::Home ( Space s,
Propagator p = NULL,
PropagatorGroup  pg = PropagatorGroup::def,
BrancherGroup  bg = BrancherGroup::def 
)
inline

Initialize the home with space s and propagator p and group g.

Definition at line 3291 of file core.hpp.

Member Function Documentation

◆ operator=()

Home & Gecode::Home::operator= ( const Home h)
inline

Assignment operator.

Definition at line 3295 of file core.hpp.

◆ operator Space &()

Gecode::Home::operator Space & ( void  )
inline

Retrieve the space of the home.

Definition at line 3300 of file core.hpp.

◆ operator()() [1/3]

Home Gecode::Home::operator() ( Propagator p)
inline

Return a home extended by propagator to be rewritten.

Definition at line 3304 of file core.hpp.

◆ operator()() [2/3]

Home Gecode::Home::operator() ( PropagatorGroup  pg)
inline

Return a home extended by a propagator group.

Definition at line 3308 of file core.hpp.

◆ operator()() [3/3]

Home Gecode::Home::operator() ( BrancherGroup  bg)
inline

Return a home extended by a brancher group.

Definition at line 3312 of file core.hpp.

◆ propagator()

Propagator * Gecode::Home::propagator ( void  ) const
inline

Return propagator (or NULL) for currently rewritten propagator.

Definition at line 3320 of file core.hpp.

◆ propagatorgroup()

PropagatorGroup Gecode::Home::propagatorgroup ( void  ) const
inline

Return propagator group.

Definition at line 3324 of file core.hpp.

◆ branchergroup()

BrancherGroup Gecode::Home::branchergroup ( void  ) const
inline

Return brancher group.

Definition at line 3328 of file core.hpp.

◆ failed()

bool Gecode::Home::failed ( void  ) const
inline

Check whether corresponding space is failed.

Definition at line 3967 of file core.hpp.

◆ fail()

void Gecode::Home::fail ( void  )
inline

Mark space as failed.

Definition at line 3958 of file core.hpp.

◆ notice()

void Gecode::Home::notice ( Actor a,
ActorProperty  p,
bool  duplicate = false 
)
inline

Notice actor property.

Definition at line 3253 of file core.hpp.

Member Data Documentation

◆ s

Space& Gecode::Home::s
protected

The space where the propagator is to be posted.

Definition at line 909 of file core.hpp.

◆ p

Propagator* Gecode::Home::p
protected

A propagator (possibly) that is currently being rewritten.

Definition at line 911 of file core.hpp.

◆ pg

PropagatorGroup Gecode::Home::pg
protected

A propagator group.

Definition at line 913 of file core.hpp.

◆ bg

BrancherGroup Gecode::Home::bg
protected

A brancher group.

Definition at line 915 of file core.hpp.


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