Gecode::BrancherFilter< View > Class Template Reference

Class storing a branch filter function. More...

#include <brancher-filter.hpp>

Public Types
typedef View::VarType	Var
	The corresponding variable type. More...

Public Member Functions
	BrancherFilter (BranchFilter< Var > bf)
	Initialize. More...
	BrancherFilter (Space &home, bool shared, BrancherFilter &bf)
	Initialize during cloning. More...
	operator bool (void) const
	Whether filtering is enabled. More...
bool	operator() (const Space &home, View x, int i) const
	Invoke filter function. More...
bool	notice (void) const
	Whether dispose must always be called (that is, notice is needed) More...
void	dispose (Space &home)
	Delete object. More...

Protected Attributes
SharedData< BranchFilter< Var > >	f

Detailed Description

template<class View>
class Gecode::BrancherFilter< View >

Class storing a branch filter function.

Definition at line 49 of file brancher-filter.hpp.

Member Typedef Documentation

Var

template<class View>

typedef View::VarType Gecode::BrancherFilter< View >::Var

The corresponding variable type.

Definition at line 52 of file brancher-filter.hpp.

Constructor & Destructor Documentation

BrancherFilter() [1/2]

template<class View >

Gecode::BrancherFilter< View >::BrancherFilter ( BranchFilter< Var >  bf )

inline

Initialize.

Definition at line 94 of file brancher-filter.hpp.

BrancherFilter() [2/2]

template<class View >

Gecode::BrancherFilter< View >::BrancherFilter ( Space &  home, bool  shared, BrancherFilter< View > &  bf  )

inline

Initialize during cloning.

Definition at line 101 of file brancher-filter.hpp.

Member Function Documentation

operator bool()

template<class View >

Gecode::BrancherFilter< View >::operator bool ( void  ) const

inline

Whether filtering is enabled.

Definition at line 108 of file brancher-filter.hpp.

operator()()

template<class View >

bool Gecode::BrancherFilter< View >::operator() ( const Space &  home, View  x, int  i  ) const

inline

Invoke filter function.

Definition at line 114 of file brancher-filter.hpp.

notice()

template<class View >

bool Gecode::BrancherFilter< View >::notice ( void  ) const

inline

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

Definition at line 122 of file brancher-filter.hpp.

dispose()

template<class View >

void Gecode::BrancherFilter< View >::dispose ( Space &  home )

inline

Delete object.

Definition at line 128 of file brancher-filter.hpp.

Member Data Documentation

f

template<class View>

SharedData<BranchFilter<Var> > Gecode::BrancherFilter< View >::f

protected

Definition at line 54 of file brancher-filter.hpp.

---

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

• gecode/kernel/brancher-filter.hpp (Revision: 15623)