Generated on Thu Mar 16 2017 03:24:29 for Gecode by doxygen 1.8.13
Gecode::ViewValBrancher< View, n, Val, a > Class Template Reference

Generic brancher by view and value selection. More...

#include <brancher-view-val.hpp>

Public Member Functions

virtual const Choicechoice (Space &home)
 Return choice. More...
 
virtual const Choicechoice (const Space &home, Archive &e)
 Return choice. More...
 
virtual ExecStatus commit (Space &home, const Choice &c, unsigned int b)
 Perform commit for choice c and alternative b. More...
 
virtual NGLngl (Space &home, const Choice &c, unsigned int b) const
 Create no-good literal for choice c and alternative b. More...
 
virtual void print (const Space &home, const Choice &c, unsigned int b, std::ostream &o) const
 Print branch for choice c and alternative b. More...
 
virtual Actorcopy (Space &home, bool share)
 Perform cloning. More...
 
virtual size_t dispose (Space &home)
 Delete brancher and return its size. More...
 
- Public Member Functions inherited from Gecode::ViewBrancher< View, n >
virtual bool status (const Space &home) const
 Check status of brancher, return true if alternatives left. More...
 
- Public Member Functions inherited from Gecode::Brancher
unsigned int id (void) const
 Return brancher id. More...
 
BrancherGroup group (void) const
 Return group brancher belongs to. More...
 
void group (BrancherGroup g)
 Add brancher to group g. More...
 
void kill (Space &home)
 Kill brancher. More...
 
- Public Member Functions inherited from Gecode::Actor
virtual ~Actor (void)
 To avoid warnings. More...
 

Static Public Member Functions

static void post (Home home, ViewArray< View > &x, ViewSel< View > *vs[n], ValSelCommitBase< View, Val > *vsc, BranchFilter bf, VarValPrint vvp)
 Brancher post function. More...
 
- Static Public Member Functions inherited from Gecode::Actor
static void * operator new (size_t s)
 Not used. More...
 
static void operator delete (void *p)
 Not used. More...
 
static void * operator new (size_t s, Space &home)
 Allocate memory from space. More...
 
static void operator delete (void *p, Space &home)
 No-op for exceptions. More...
 

Protected Types

typedef void(* VarValPrint) (const Space &home, const Brancher &b, unsigned int alt, typename View::VarType x, int i, const Val &m, std::ostream &o)
 Function type for printing variable and value selection. More...
 
- Protected Types inherited from Gecode::ViewBrancher< View, n >
typedef BranchTraits< typename View::VarType >::Filter BranchFilter
 The branch filter that corresponds to the var type. More...
 

Protected Member Functions

 ViewValBrancher (Space &home, bool share, ViewValBrancher &b)
 Constructor for cloning b. More...
 
 ViewValBrancher (Home home, ViewArray< View > &x, ViewSel< View > *vs[n], ValSelCommitBase< View, Val > *vsc, BranchFilter bf, VarValPrint vvp)
 Constructor for creation. More...
 
- Protected Member Functions inherited from Gecode::ViewBrancher< View, n >
Pos pos (Space &home)
 Return position information. More...
 
View view (const Pos &p) const
 Return view according to position information p. More...
 
 ViewBrancher (Space &home, bool shared, ViewBrancher< View, n > &b)
 Constructor for cloning b. More...
 
 ViewBrancher (Home home, ViewArray< View > &x, ViewSel< View > *vs[n], BranchFilter bf)
 Constructor for creation. More...
 
- Protected Member Functions inherited from Gecode::Brancher
 Brancher (Home home)
 Constructor for creation. More...
 
 Brancher (Space &home, bool share, Brancher &b)
 Constructor for cloning b. More...
 

Protected Attributes

ValSelCommitBase< View, Val > * vsc
 Value selection and commit object. More...
 
VarValPrint vvp
 Print function. More...
 
- Protected Attributes inherited from Gecode::ViewBrancher< View, n >
ViewArray< View > x
 Views to branch on. More...
 
int start
 Unassigned views start at x[start]. More...
 
ViewSel< View > * vs [n]
 View selection objects. More...
 
BranchFilter bf
 Branch filter function. More...
 

Detailed Description

template<class View, int n, class Val, unsigned int a>
class Gecode::ViewValBrancher< View, n, Val, a >

Generic brancher by view and value selection.

Implements view-based branching for an array of views (of type View) and value (of type Val).

Definition at line 97 of file brancher-view-val.hpp.

Member Typedef Documentation

◆ VarValPrint

template<class View, int n, class Val, unsigned int a>
typedef void(* Gecode::ViewValBrancher< View, n, Val, a >::VarValPrint) (const Space &home, const Brancher &b, unsigned int alt, typename View::VarType x, int i, const Val &m, std::ostream &o)
protected

Function type for printing variable and value selection.

Definition at line 105 of file brancher-view-val.hpp.

Constructor & Destructor Documentation

◆ ViewValBrancher() [1/2]

template<class View , int n, class Val , unsigned int a>
Gecode::ViewValBrancher< View, n, Val, a >::ViewValBrancher ( Space home,
bool  share,
ViewValBrancher< View, n, Val, a > &  b 
)
inlineprotected

Constructor for cloning b.

Definition at line 257 of file brancher-view-val.hpp.

◆ ViewValBrancher() [2/2]

template<class View , int n, class Val , unsigned int a>
Gecode::ViewValBrancher< View, n, Val, a >::ViewValBrancher ( Home  home,
ViewArray< View > &  x,
ViewSel< View > *  vs[n],
ValSelCommitBase< View, Val > *  vsc,
BranchFilter  bf,
VarValPrint  vvp 
)
inlineprotected

Constructor for creation.

Definition at line 233 of file brancher-view-val.hpp.

Member Function Documentation

◆ choice() [1/2]

template<class View , int n, class Val , unsigned int a>
const Choice * Gecode::ViewValBrancher< View, n, Val, a >::choice ( Space home)
virtual

◆ choice() [2/2]

template<class View , int n, class Val , unsigned int a>
const Choice * Gecode::ViewValBrancher< View, n, Val, a >::choice ( const Space home,
Archive e 
)
virtual

Return choice.

Implements Gecode::Brancher.

Reimplemented in Gecode::Int::LDSB::LDSBBrancher< View, n, Val, a >.

Definition at line 277 of file brancher-view-val.hpp.

◆ commit()

template<class View , int n, class Val , unsigned int a>
ExecStatus Gecode::ViewValBrancher< View, n, Val, a >::commit ( Space home,
const Choice c,
unsigned int  b 
)
virtual

Perform commit for choice c and alternative b.

Implements Gecode::Brancher.

Reimplemented in Gecode::Int::LDSB::LDSBBrancher< View, n, Val, a >, and Gecode::Set::LDSB::LDSBSetBrancher< View, n, Val, a >.

Definition at line 287 of file brancher-view-val.hpp.

◆ ngl()

template<class View , int n, class Val , unsigned int a>
NGL * Gecode::ViewValBrancher< View, n, Val, a >::ngl ( Space home,
const Choice c,
unsigned int  b 
) const
virtual

Create no-good literal for choice c and alternative b.

Reimplemented from Gecode::Brancher.

Definition at line 300 of file brancher-view-val.hpp.

◆ print()

template<class View , int n, class Val , unsigned int a>
void Gecode::ViewValBrancher< View, n, Val, a >::print ( const Space home,
const Choice c,
unsigned int  b,
std::ostream &  o 
) const
virtual

Print branch for choice c and alternative b.

Prints an explanation of the alternative b of choice c on the stream o.

Reimplemented from Gecode::Brancher.

Definition at line 310 of file brancher-view-val.hpp.

◆ copy()

template<class View , int n, class Val , unsigned int a>
Actor * Gecode::ViewValBrancher< View, n, Val, a >::copy ( Space home,
bool  share 
)
virtual

◆ dispose()

template<class View , int n, class Val , unsigned int a>
size_t Gecode::ViewValBrancher< View, n, Val, a >::dispose ( Space home)
inlinevirtual

Delete brancher and return its size.

Reimplemented from Gecode::ViewBrancher< View, n >.

Reimplemented in Gecode::Int::LDSB::LDSBBrancher< View, n, Val, a >.

Definition at line 324 of file brancher-view-val.hpp.

◆ post()

template<class View , int n, class Val , unsigned int a>
void Gecode::ViewValBrancher< View, n, Val, a >::post ( Home  home,
ViewArray< View > &  x,
ViewSel< View > *  vs[n],
ValSelCommitBase< View, Val > *  vsc,
BranchFilter  bf,
VarValPrint  vvp 
)
inlinestatic

Brancher post function.

Definition at line 247 of file brancher-view-val.hpp.

Member Data Documentation

◆ vsc

template<class View, int n, class Val, unsigned int a>
ValSelCommitBase<View,Val>* Gecode::ViewValBrancher< View, n, Val, a >::vsc
protected

Value selection and commit object.

Definition at line 103 of file brancher-view-val.hpp.

◆ vvp

template<class View, int n, class Val, unsigned int a>
VarValPrint Gecode::ViewValBrancher< View, n, Val, a >::vvp
protected

Print function.

Definition at line 111 of file brancher-view-val.hpp.


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