Gecode::Home Class Reference

Home class for posting propagators More...

#include <gecode/kernel/core.hpp>

Protected Attributes
Space &	s
	The space where the propagator is to be posted.
Propagator *	p
	A propagator (possibly) that is currently being rewritten.
PropagatorGroup	pg
	A propagator group.
BrancherGroup	bg
	A brancher group.

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

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

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

Detailed Description

Home class for posting propagators

Definition at line 863 of file core.hpp.

Constructor & Destructor Documentation

Home() [1/2]

Gecode::Home::Home ( Space & s, Propagator * p = nullptr, PropagatorGroup pg = PropagatorGroup::def, BrancherGroup bg = BrancherGroup::def )

inline

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

Definition at line 3368 of file core.hpp.

Home() [2/2]

Gecode::Home::Home ( const Home & h )

inline

Copy constructor.

Definition at line 3372 of file core.hpp.

Member Function Documentation

operator=()

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

inline

Assignment operator.

Definition at line 3375 of file core.hpp.

operator Space &()

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

inline

Retrieve the space of the home.

Definition at line 3380 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 3384 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 3388 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 3392 of file core.hpp.

propagator()

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

inline

Return propagator (or nullptr) for currently rewritten propagator.

Definition at line 3408 of file core.hpp.

propagatorgroup()

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

inline

Return propagator group.

Definition at line 3412 of file core.hpp.

branchergroup()

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

inline

Return brancher group.

Definition at line 3416 of file core.hpp.

failed()

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

inline

Check whether corresponding space is failed.

Definition at line 4185 of file core.hpp.

fail()

void Gecode::Home::fail ( void )

inline

Mark space as failed.

Definition at line 4176 of file core.hpp.

notice()

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

inline

Notice actor property.

Definition at line 3301 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 867 of file core.hpp.

p

Propagator* Gecode::Home::p

protected

A propagator (possibly) that is currently being rewritten.

Definition at line 869 of file core.hpp.

pg

PropagatorGroup Gecode::Home::pg

protected

A propagator group.

Definition at line 871 of file core.hpp.

bg

BrancherGroup Gecode::Home::bg

protected

A brancher group.

Definition at line 873 of file core.hpp.

---

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

• gecode/kernel/core.hpp