Generated on Fri Oct 19 11:25:49 2018 for Gecode by doxygen 1.6.3

Gecode::PropagatorGroup Class Reference
[Propagator and brancher groups]

Group of propagators. More...

#include <core.hpp>

List of all members.

Static Public Attributes

static PropagatorGroup all
 Group of all propagators.
static PropagatorGroup def
 Group of propagators not in any user-defined group.

Protected Member Functions

 PropagatorGroup (unsigned int gid)
 Initialize with group id gid.

Construction



 PropagatorGroup (void)
 Constructor.
 PropagatorGroup (const PropagatorGroup &g)
 Copy constructor.
PropagatorGroupoperator= (const PropagatorGroup &g)
 Assignment operator.
Home operator() (Space &home)
 To augment a space argument.

Move propagators between groups



PropagatorGroupmove (Space &home, PropagatorGroup g)
 Move propagators from group g to this group.
PropagatorGroupmove (Space &home, Propagator &p)
 Move propagator p to this group.
PropagatorGroupmove (Space &home, unsigned int id)
 Move propagator with id id to this group.

Operations on groups



bool operator== (PropagatorGroup g) const
 Test whether this group is equal to group g.
bool operator!= (PropagatorGroup g) const
 Test whether this group is different from group g.
unsigned int size (Space &home) const
 Return number of propagators in a group.
void kill (Space &home)
 Kill all propagators in a group.
void disable (Space &home)
 Disable all propagators in a group.
void enable (Space &home, bool s=true)
 Enable all propagators in a group.

Detailed Description

Group of propagators.

Definition at line 725 of file core.hpp.


Constructor & Destructor Documentation

Gecode::PropagatorGroup::PropagatorGroup ( unsigned int  gid  )  [inline, protected]

Initialize with group id gid.

Definition at line 4910 of file core.hpp.

Gecode::PropagatorGroup::PropagatorGroup ( void   )  [inline]

Constructor.

Definition at line 4907 of file core.hpp.

Gecode::PropagatorGroup::PropagatorGroup ( const PropagatorGroup g  )  [inline]

Copy constructor.

Definition at line 4914 of file core.hpp.


Member Function Documentation

PropagatorGroup & Gecode::PropagatorGroup::operator= ( const PropagatorGroup g  )  [inline]

Assignment operator.

Definition at line 4918 of file core.hpp.

Home Gecode::PropagatorGroup::operator() ( Space home  )  [inline]

To augment a space argument.

Definition at line 4923 of file core.hpp.

PropagatorGroup & Gecode::PropagatorGroup::move ( Space home,
PropagatorGroup  g 
)

Move propagators from group g to this group.

Definition at line 903 of file core.cpp.

PropagatorGroup & Gecode::PropagatorGroup::move ( Space home,
Propagator p 
) [inline]

Move propagator p to this group.

Definition at line 4937 of file core.hpp.

PropagatorGroup & Gecode::PropagatorGroup::move ( Space home,
unsigned int  id 
)

Move propagator with id id to this group.

Throws an exception of type UnknownPropagator, if no propagator with id id exists.

Definition at line 912 of file core.cpp.

bool Gecode::PropagatorGroup::operator== ( PropagatorGroup  g  )  const [inline]

Test whether this group is equal to group g.

Definition at line 4928 of file core.hpp.

bool Gecode::PropagatorGroup::operator!= ( PropagatorGroup  g  )  const [inline]

Test whether this group is different from group g.

Definition at line 4932 of file core.hpp.

unsigned int Gecode::PropagatorGroup::size ( Space home  )  const

Return number of propagators in a group.

Definition at line 926 of file core.cpp.

void Gecode::PropagatorGroup::kill ( Space home  ) 

Kill all propagators in a group.

Definition at line 937 of file core.cpp.

void Gecode::PropagatorGroup::disable ( Space home  ) 

Disable all propagators in a group.

Definition at line 950 of file core.cpp.

void Gecode::PropagatorGroup::enable ( Space home,
bool  s = true 
)

Enable all propagators in a group.

If s is true, the propagators will be scheduled for propagation if needed.

Definition at line 959 of file core.cpp.


Member Data Documentation

Group of all propagators.

Reimplemented from Gecode::Group.

Definition at line 786 of file core.hpp.

Group of propagators not in any user-defined group.

Reimplemented from Gecode::Group.

Definition at line 789 of file core.hpp.


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