Generated on Fri Oct 19 11:25:46 2018 for Gecode by doxygen 1.6.3

Gecode::AFC Class Reference

Class for AFC (accumulated failure count) management. More...

#include <afc.hpp>

List of all members.

Public Member Functions

 ~AFC (void)
 Destructor.

Protected Attributes

int n
 Number of views.

Related Functions

(Note that these are not member functions.)



template<class Char , class Traits >
std::basic_ostream< Char,
Traits > & 
operator<< (std::basic_ostream< Char, Traits > &os, const AFC &a)
 Print AFC information (prints nothing).

Constructors and initialization



static const AFC def
 Default (empty) AFC information.
 AFC (void)
 Construct as not yet intialized.
 AFC (const AFC &a)
 Copy constructor.
AFCoperator= (const AFC &a)
 Assignment operator.
template<class Var >
 AFC (Home home, const VarArgArray< Var > &x, double d, bool share=true)
 Initialize for variables x and decay factor d.
template<class Var >
void init (Home home, const VarArgArray< Var > &x, double d, bool share=true)
 Initialize for variables x and decay factor d.
 operator bool (void) const
 Test whether already initialized.

Information access



int size (void) const
 Return number of AFC values.

Decay factor for aging



void decay (Space &home, double d)
 Set decay factor to d.
double decay (const Space &home) const
 Return decay factor.

Detailed Description

Class for AFC (accumulated failure count) management.

Definition at line 40 of file afc.hpp.


Constructor & Destructor Documentation

Gecode::AFC::AFC ( void   )  [inline]

Construct as not yet intialized.

The only member functions that can be used on a constructed but not yet initialized AFC storage is init and the assignment operator.

Definition at line 119 of file afc.hpp.

Gecode::AFC::AFC ( const AFC a  )  [inline]

Copy constructor.

Definition at line 149 of file afc.hpp.

template<class Var >
Gecode::AFC::AFC ( Home  home,
const VarArgArray< Var > &  x,
double  d,
bool  share = true 
) [inline]

Initialize for variables x and decay factor d.

If several AFC objects are created for a space or its clones, the AFC values are shared between spaces. If the values should not be shared, share should be false.

Definition at line 128 of file afc.hpp.

Gecode::AFC::~AFC ( void   )  [inline]

Destructor.

Definition at line 157 of file afc.hpp.


Member Function Documentation

AFC & Gecode::AFC::operator= ( const AFC a  )  [inline]

Assignment operator.

Definition at line 152 of file afc.hpp.

template<class Var >
void Gecode::AFC::init ( Home  home,
const VarArgArray< Var > &  x,
double  d,
bool  share = true 
) [inline]

Initialize for variables x and decay factor d.

If several AFC objects are created for a space or its clones, the AFC values are shared between spaces. If the values should not be shared, share should be false.

Definition at line 138 of file afc.hpp.

Gecode::AFC::operator bool ( void   )  const [inline]

Test whether already initialized.

Definition at line 122 of file afc.hpp.

int Gecode::AFC::size ( void   )  const [inline]

Return number of AFC values.

Definition at line 113 of file afc.hpp.

void Gecode::AFC::decay ( Space home,
double  d 
) [inline]

Set decay factor to d.

Definition at line 160 of file afc.hpp.

double Gecode::AFC::decay ( const Space home  )  const [inline]

Return decay factor.

Definition at line 167 of file afc.hpp.


Friends And Related Function Documentation

template<class Char , class Traits >
std::basic_ostream< Char, Traits > & operator<< ( std::basic_ostream< Char, Traits > &  os,
const AFC a 
) [related]

Print AFC information (prints nothing).

Definition at line 174 of file afc.hpp.


Member Data Documentation

int Gecode::AFC::n [protected]

Number of views.

Definition at line 43 of file afc.hpp.

const AFC Gecode::AFC::def [static]

Default (empty) AFC information.

Definition at line 78 of file afc.hpp.


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