Generated on Tue May 22 09:40:55 2018 for Gecode by doxygen 1.6.3

Gecode::MeritFunction< View > Class Template Reference
[Generic merit for branchers based on view and value selection]

Merit class for user-defined merit function. More...

#include <merit.hpp>

List of all members.

Public Types

typedef BranchTraits< Var >::Merit Function
 Corresponding merit function type.

Public Member Functions

 MeritFunction (Space &home, const VarBranch< Var > &vb)
 Constructor for initialization.
 MeritFunction (Space &home, MeritFunction &mf)
 Constructor for cloning.
double operator() (const Space &home, View x, int i)
 Return degree as merit for view x at position i.
bool notice (void) const
 Whether dispose must always be called (that is, notice is needed).
void dispose (Space &home)
 Delete view merit class.

Protected Attributes

SharedData< Functionf
 The user-defined merit function.

Detailed Description

template<class View>
class Gecode::MeritFunction< View >

Merit class for user-defined merit function.

Definition at line 68 of file merit.hpp.


Member Typedef Documentation

template<class View >
typedef BranchTraits<Var>::Merit Gecode::MeritFunction< View >::Function

Corresponding merit function type.

Definition at line 72 of file merit.hpp.


Constructor & Destructor Documentation

template<class View >
Gecode::MeritFunction< View >::MeritFunction ( Space home,
const VarBranch< Var > &  vb 
) [inline]

Constructor for initialization.

Definition at line 192 of file merit.hpp.

template<class View >
Gecode::MeritFunction< View >::MeritFunction ( Space home,
MeritFunction< View > &  mf 
) [inline]

Constructor for cloning.

Definition at line 199 of file merit.hpp.


Member Function Documentation

template<class View >
double Gecode::MeritFunction< View >::operator() ( const Space home,
View  x,
int  i 
) [inline]

Return degree as merit for view x at position i.

Definition at line 204 of file merit.hpp.

template<class View >
bool Gecode::MeritFunction< View >::notice ( void   )  const [inline]

Whether dispose must always be called (that is, notice is needed).

Reimplemented from Gecode::MeritBase< View, double >.

Definition at line 211 of file merit.hpp.

template<class View >
void Gecode::MeritFunction< View >::dispose ( Space home  )  [inline]

Delete view merit class.

Reimplemented from Gecode::MeritBase< View, double >.

Definition at line 216 of file merit.hpp.


Member Data Documentation

template<class View >
SharedData<Function> Gecode::MeritFunction< View >::f [protected]

The user-defined merit function.

Definition at line 75 of file merit.hpp.


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