Generated on Sat Jan 20 2018 22:21:22 for Gecode by doxygen 1.8.13
Gecode::VarBranch< Var > Class Template Reference

Variable branching information. More...

#include <branch-var.hpp>

Public Types

typedef BranchTraits< Var >::Merit MeritFunction
 Corresponding merit function. More...
 

Public Member Functions

 VarBranch (void)
 Initialize. More...
 
 VarBranch (BranchTbl t)
 Initialize with tie-break limit function t. More...
 
 VarBranch (Rnd r)
 Initialize with random number generator r. More...
 
 VarBranch (double d, BranchTbl t)
 Initialize with decay factor d and tie-break limit function t. More...
 
 VarBranch (AFC a, BranchTbl t)
 Initialize with AFC a and tie-break limit function t. More...
 
 VarBranch (Action a, BranchTbl t)
 Initialize with action a and tie-break limit function t. More...
 
 VarBranch (CHB c, BranchTbl t)
 Initialize with CHB c and tie-break limit function t. More...
 
 VarBranch (MeritFunction f, BranchTbl t)
 Initialize with merit function f and tie-break limit function t. More...
 
BranchTbl tbl (void) const
 Return tie-break limit function. More...
 
Rnd rnd (void) const
 Return random number generator. More...
 
double decay (void) const
 Return decay factor. More...
 
AFC afc (void) const
 Return AFC. More...
 
void afc (AFC a)
 Set AFC to a. More...
 
Action action (void) const
 Return action. More...
 
void action (Action a)
 Set action to a. More...
 
CHB chb (void) const
 Return CHB. More...
 
void chb (CHB chb)
 Set CHB to chb. More...
 
MeritFunction merit (void) const
 Return merit function. More...
 

Protected Attributes

BranchTbl _tbl
 Tie-breaking limit function. More...
 
Rnd _rnd
 Random number generator. More...
 
double _decay
 Decay information for AFC and action. More...
 
AFC _afc
 AFC information. More...
 
Action _act
 Action information. More...
 
CHB _chb
 CHB information. More...
 
MeritFunction _mf
 Merit function. More...
 

Detailed Description

template<class Var>
class Gecode::VarBranch< Var >

Variable branching information.

Definition at line 59 of file branch-var.hpp.

Member Typedef Documentation

◆ MeritFunction

template<class Var>
typedef BranchTraits<Var>::Merit Gecode::VarBranch< Var >::MeritFunction

Corresponding merit function.

Definition at line 62 of file branch-var.hpp.

Constructor & Destructor Documentation

◆ VarBranch() [1/8]

template<class Var >
Gecode::VarBranch< Var >::VarBranch ( void  )
inline

Initialize.

Definition at line 120 of file branch-var.hpp.

◆ VarBranch() [2/8]

template<class Var >
Gecode::VarBranch< Var >::VarBranch ( BranchTbl  t)
inline

Initialize with tie-break limit function t.

Definition at line 125 of file branch-var.hpp.

◆ VarBranch() [3/8]

template<class Var >
Gecode::VarBranch< Var >::VarBranch ( Rnd  r)
inline

Initialize with random number generator r.

Definition at line 159 of file branch-var.hpp.

◆ VarBranch() [4/8]

template<class Var >
Gecode::VarBranch< Var >::VarBranch ( double  d,
BranchTbl  t 
)
inline

Initialize with decay factor d and tie-break limit function t.

Definition at line 130 of file branch-var.hpp.

◆ VarBranch() [5/8]

template<class Var >
Gecode::VarBranch< Var >::VarBranch ( AFC  a,
BranchTbl  t 
)
inline

Initialize with AFC a and tie-break limit function t.

Definition at line 135 of file branch-var.hpp.

◆ VarBranch() [6/8]

template<class Var >
Gecode::VarBranch< Var >::VarBranch ( Action  a,
BranchTbl  t 
)
inline

Initialize with action a and tie-break limit function t.

Definition at line 143 of file branch-var.hpp.

◆ VarBranch() [7/8]

template<class Var >
Gecode::VarBranch< Var >::VarBranch ( CHB  c,
BranchTbl  t 
)
inline

Initialize with CHB c and tie-break limit function t.

Definition at line 151 of file branch-var.hpp.

◆ VarBranch() [8/8]

template<class Var >
Gecode::VarBranch< Var >::VarBranch ( MeritFunction  f,
BranchTbl  t 
)
inline

Initialize with merit function f and tie-break limit function t.

Definition at line 167 of file branch-var.hpp.

Member Function Documentation

◆ tbl()

template<class Var >
BranchTbl Gecode::VarBranch< Var >::tbl ( void  ) const
inline

Return tie-break limit function.

Definition at line 172 of file branch-var.hpp.

◆ rnd()

template<class Var >
Rnd Gecode::VarBranch< Var >::rnd ( void  ) const
inline

Return random number generator.

Definition at line 178 of file branch-var.hpp.

◆ decay()

template<class Var >
double Gecode::VarBranch< Var >::decay ( void  ) const
inline

Return decay factor.

Definition at line 184 of file branch-var.hpp.

◆ afc() [1/2]

template<class Var >
AFC Gecode::VarBranch< Var >::afc ( void  ) const
inline

Return AFC.

Definition at line 190 of file branch-var.hpp.

◆ afc() [2/2]

template<class Var >
void Gecode::VarBranch< Var >::afc ( AFC  a)
inline

Set AFC to a.

Definition at line 196 of file branch-var.hpp.

◆ action() [1/2]

template<class Var >
Action Gecode::VarBranch< Var >::action ( void  ) const
inline

Return action.

Definition at line 202 of file branch-var.hpp.

◆ action() [2/2]

template<class Var >
void Gecode::VarBranch< Var >::action ( Action  a)
inline

Set action to a.

Definition at line 208 of file branch-var.hpp.

◆ chb() [1/2]

template<class Var >
CHB Gecode::VarBranch< Var >::chb ( void  ) const
inline

Return CHB.

Definition at line 214 of file branch-var.hpp.

◆ chb() [2/2]

template<class Var >
void Gecode::VarBranch< Var >::chb ( CHB  chb)
inline

Set CHB to chb.

Definition at line 220 of file branch-var.hpp.

◆ merit()

template<class Var >
VarBranch< Var >::MeritFunction Gecode::VarBranch< Var >::merit ( void  ) const
inline

Return merit function.

Definition at line 226 of file branch-var.hpp.

Member Data Documentation

◆ _tbl

template<class Var>
BranchTbl Gecode::VarBranch< Var >::_tbl
protected

Tie-breaking limit function.

Definition at line 65 of file branch-var.hpp.

◆ _rnd

template<class Var>
Rnd Gecode::VarBranch< Var >::_rnd
protected

Random number generator.

Definition at line 67 of file branch-var.hpp.

◆ _decay

template<class Var>
double Gecode::VarBranch< Var >::_decay
protected

Decay information for AFC and action.

Definition at line 69 of file branch-var.hpp.

◆ _afc

template<class Var>
AFC Gecode::VarBranch< Var >::_afc
protected

AFC information.

Definition at line 71 of file branch-var.hpp.

◆ _act

template<class Var>
Action Gecode::VarBranch< Var >::_act
protected

Action information.

Definition at line 73 of file branch-var.hpp.

◆ _chb

template<class Var>
CHB Gecode::VarBranch< Var >::_chb
protected

CHB information.

Definition at line 75 of file branch-var.hpp.

◆ _mf

template<class Var>
MeritFunction Gecode::VarBranch< Var >::_mf
protected

Merit function.

Definition at line 77 of file branch-var.hpp.


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