Generated on Wed Jan 24 2018 21:22:26 for Gecode by doxygen 1.8.13
Gecode::Search::Base< T > Class Template Reference

Base-class for search engines. More...

#include <search.hh>

Public Member Functions

virtual T * next (void)
 Return next solution (NULL, if none exists or search has been stopped) More...
 
virtual Statistics statistics (void) const
 Return statistics. More...
 
virtual bool stopped (void) const
 Check whether engine has been stopped. More...
 
virtual ~Base (void)
 Destructor. More...
 

Protected Member Functions

 Base (Engine *e=NULL)
 Constructor. More...
 

Protected Attributes

Enginee
 The actual search engine. More...
 

Friends

template<class , class >
Enginebuild (Space *, const Options &)
 Build an engine of type E for a script T. More...
 
template<class , template< class > class>
Enginebuild (Space *, const Options &)
 Build an engine of type E for a script T. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Gecode::HeapAllocated
static void * operator new (size_t s)
 Memory management. More...
 
static void operator delete (void *p)
 Free memory allocated from heap. More...
 

Detailed Description

template<class T>
class Gecode::Search::Base< T >

Base-class for search engines.

Definition at line 627 of file search.hh.

Constructor & Destructor Documentation

◆ Base()

template<class T >
Gecode::Search::Base< T >::Base ( Engine e = NULL)
inlineprotected

Constructor.

Definition at line 46 of file base.hpp.

◆ ~Base()

template<class T >
Gecode::Search::Base< T >::~Base ( void  )
inlinevirtual

Destructor.

Definition at line 65 of file base.hpp.

Member Function Documentation

◆ next()

template<class T >
T * Gecode::Search::Base< T >::next ( void  )
inlinevirtual

Return next solution (NULL, if none exists or search has been stopped)

Definition at line 50 of file base.hpp.

◆ statistics()

template<class T >
Statistics Gecode::Search::Base< T >::statistics ( void  ) const
inlinevirtual

Return statistics.

Definition at line 55 of file base.hpp.

◆ stopped()

template<class T >
bool Gecode::Search::Base< T >::stopped ( void  ) const
inlinevirtual

Check whether engine has been stopped.

Definition at line 60 of file base.hpp.

Friends And Related Function Documentation

◆ build [1/2]

template<class T>
template<class , class >
Engine* build ( Space ,
const Options  
)
friend

Build an engine of type E for a script T.

Build a parametric engine of type E for a script T.

Definition at line 62 of file build.hpp.

◆ build [2/2]

template<class T>
template<class , template< class > class>
Engine* build ( Space ,
const Options  
)
friend

Build an engine of type E for a script T.

Build a parametric engine of type E for a script T.

Definition at line 62 of file build.hpp.

Member Data Documentation

◆ e

template<class T>
Engine* Gecode::Search::Base< T >::e
protected

The actual search engine.

Definition at line 634 of file search.hh.


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