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

Group of branchers. More...

#include <core.hpp>

List of all members.

Static Public Attributes
static BrancherGroup	all
	Group of all branchers.
static BrancherGroup	def
	Group of branchers not in any user-defined group.
Protected Member Functions
	BrancherGroup (unsigned int gid)
	Initialize with group id gid.
Construction
	BrancherGroup (void)
	Constructor.
	BrancherGroup (const BrancherGroup &g)
	Copy constructor.
BrancherGroup &	operator= (const BrancherGroup &g)
	Assignment operator.
Home	operator() (Space &home)
	To augment a space argument.
Move branchers between groups
BrancherGroup &	move (Space &home, BrancherGroup g)
	Move branchers from group g to this group.
BrancherGroup &	move (Space &home, Brancher &b)
	Move brancher b to this group.
BrancherGroup &	move (Space &home, unsigned int id)
	Move brancher with id id to this group.
Operations on groups
bool	operator== (BrancherGroup g) const
	Test whether this group is equal to group g.
bool	operator!= (BrancherGroup g) const
	Test whether this group is different from group g.
unsigned int	size (Space &home) const
	Return number of branchers in a group.
void	kill (Space &home)
	Kill all branchers in a group.

---

Detailed Description

Group of branchers.

Definition at line 796 of file core.hpp.

---

Constructor & Destructor Documentation

Gecode::BrancherGroup::BrancherGroup

(

unsigned int

gid

)

[inline, protected]

Initialize with group id gid.

Definition at line 4940 of file core.hpp.

Gecode::BrancherGroup::BrancherGroup

(

void

)

[inline]

Constructor.

Definition at line 4937 of file core.hpp.

Gecode::BrancherGroup::BrancherGroup

(

const BrancherGroup &

g

)

[inline]

Copy constructor.

Definition at line 4944 of file core.hpp.

---

Member Function Documentation

BrancherGroup & Gecode::BrancherGroup::operator=

(

const BrancherGroup &

g

)

[inline]

Assignment operator.

Definition at line 4948 of file core.hpp.

Home Gecode::BrancherGroup::operator()

(

Space &

home

)

[inline]

To augment a space argument.

Definition at line 4953 of file core.hpp.

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

Move branchers from group g to this group.

Definition at line 981 of file core.cpp.

BrancherGroup & Gecode::BrancherGroup::move	(	Space &	home,
		Brancher &	b
	)			[inline]

Move brancher b to this group.

Definition at line 4967 of file core.hpp.

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

Move brancher with id id to this group.

Throws an exception of type UnknownBrancher, if no brancher with id id exists.

Definition at line 990 of file core.cpp.

bool Gecode::BrancherGroup::operator==

(

BrancherGroup

g

)

const [inline]

Test whether this group is equal to group g.

Definition at line 4958 of file core.hpp.

bool Gecode::BrancherGroup::operator!=

(

BrancherGroup

g

)

const [inline]

Test whether this group is different from group g.

Definition at line 4962 of file core.hpp.

unsigned int Gecode::BrancherGroup::size

(

Space &

home

)

const

Return number of branchers in a group.

Definition at line 1004 of file core.cpp.

void Gecode::BrancherGroup::kill

(

Space &

home

)

Kill all branchers in a group.

Definition at line 1015 of file core.cpp.

---

Member Data Documentation

BrancherGroup Gecode::BrancherGroup::all [static]

Group of all branchers.

Reimplemented from Gecode::Group.

Definition at line 844 of file core.hpp.

BrancherGroup Gecode::BrancherGroup::def [static]

Group of branchers not in any user-defined group.

Reimplemented from Gecode::Group.

Definition at line 847 of file core.hpp.

---

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

• gecode/kernel/core.hpp
• gecode/kernel/core.cpp