Gecode::VarBranch< Var > Class Template Reference
Functionality by programming task » Programming models » Generic branching support

Variable branching information. More...

`#include <var.hpp>`

## Public Types

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

## Public Member Functions

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

## Protected Attributes

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

## Detailed Description

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

Variable branching information.

Definition at line 55 of file var.hpp.

## Member Typedef Documentation

## MeritFunction

template<class Var>

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

Corresponding merit function.

Definition at line 58 of file var.hpp.

## Constructor & Destructor Documentation

## VarBranch() [1/8]

template<class Var>

Gecode::VarBranch< Var >::VarBranch | ( | void |  | ) |

inline

Initialize.

Definition at line 116 of file 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 121 of file var.hpp.

## VarBranch() [3/8]

template<class Var>

Gecode::VarBranch< Var >::VarBranch | ( | Rnd | r | ) |

inline

Initialize with random number generator r.

Definition at line 155 of file 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 126 of file 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 131 of file 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 139 of file 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 147 of file 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 163 of file 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 168 of file var.hpp.

## rnd()

template<class Var>

Rnd Gecode::VarBranch< Var >::rnd | ( | void |  | ) | const

inline

Return random number generator.

Definition at line 174 of file var.hpp.

## decay()

template<class Var>

double Gecode::VarBranch< Var >::decay | ( | void |  | ) | const

inline

Return decay factor.

Definition at line 180 of file var.hpp.

## afc() [1/2]

template<class Var>

AFC Gecode::VarBranch< Var >::afc | ( | void |  | ) | const

inline

Return AFC.

Definition at line 186 of file var.hpp.

## afc() [2/2]

template<class Var>

void Gecode::VarBranch< Var >::afc | ( | AFC | a | ) |

inline

Set AFC to a.

Definition at line 192 of file var.hpp.

## action() [1/2]

template<class Var>

Action Gecode::VarBranch< Var >::action | ( | void |  | ) | const

inline

Return action.

Definition at line 198 of file var.hpp.

## action() [2/2]

template<class Var>

void Gecode::VarBranch< Var >::action | ( | Action | a | ) |

inline

Set action to a.

Definition at line 204 of file var.hpp.

## chb() [1/2]

template<class Var>

CHB Gecode::VarBranch< Var >::chb | ( | void |  | ) | const

inline

Return CHB.

Definition at line 210 of file var.hpp.

## chb() [2/2]

template<class Var>

void Gecode::VarBranch< Var >::chb | ( | CHB | chb | ) |

inline

Set CHB to chb.

Definition at line 216 of file var.hpp.

## merit()

template<class Var>

VarBranch< Var >::MeritFunction Gecode::VarBranch< Var >::merit | ( | void |  | ) | const

inline

Return merit function.

Definition at line 222 of file var.hpp.

## Member Data Documentation

## _tbl

template<class Var>

BranchTbl Gecode::VarBranch< Var >::_tbl

protected

Tie-breaking limit function.

Definition at line 61 of file var.hpp.

## _rnd

template<class Var>

Rnd Gecode::VarBranch< Var >::_rnd

protected

Random number generator.

Definition at line 63 of file var.hpp.

## _decay

template<class Var>

double Gecode::VarBranch< Var >::_decay

protected

Decay information for AFC and action.

Definition at line 65 of file var.hpp.

## _afc

template<class Var>

AFC Gecode::VarBranch< Var >::_afc

protected

AFC information.

Definition at line 67 of file var.hpp.

## _act

template<class Var>

Action Gecode::VarBranch< Var >::_act

protected

Action information.

Definition at line 69 of file var.hpp.

## _chb

template<class Var>

CHB Gecode::VarBranch< Var >::_chb

protected

CHB information.

Definition at line 71 of file var.hpp.

## _mf

template<class Var>

MeritFunction Gecode::VarBranch< Var >::_mf

protected

Merit function.

Definition at line 73 of file var.hpp.

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

- gecode/kernel/branch/var.hpp