Generated on for Gecode by doxygen 1.17.0
Gecode::Search Namespace Reference

Search engines More...

Namespaces

namespace  Config
 Search configuration
namespace  Meta
 Meta search engine implementations
namespace  Par
namespace  Parallel
 Parallel search engine implementations
namespace  Seq
namespace  Sequential
 Sequential search engine implementations

Classes

class  AStarBuilder
 An A* engine builder. More...
class  BabBuilder
 A BAB engine builder. More...
class  Base
 Base-class for search engines. More...
class  Beam
 Candidates for the next layer of CABS. More...
class  Builder
 A class for building search engines. More...
class  CABSBuilder
 A CABS engine builder. More...
class  Cutoff
 Base class for cutoff generators for restart-based meta engine. More...
class  CutoffAppend
 Cutoff generator appending two cutoff generators. More...
class  CutoffConstant
 Cutoff generator for constant sequence. More...
class  CutoffGeometric
 Cutoff generator for the geometric sequence. More...
class  CutoffLinear
 Cutoff generator for linear sequence. More...
class  CutoffLuby
 Cutoff generator for the Luby sequence. More...
class  CutoffMerge
 Cutoff generator merging two cutoff generators. More...
class  CutoffRandom
 Cutoff generator for the random sequence. More...
class  CutoffRepeat
 Cutoff generator that repeats a cutoff from another cutoff generator. More...
class  DfsBuilder
 A DFS engine builder. More...
class  EdgeTraceRecorder
 Recorder for a search tracer with edge information. More...
class  Engine
 Search engine implementation interface More...
class  Entries
 Stack of entries owning their spaces. More...
class  Entry
 Open node of a heuristic search engine. More...
class  FailStop
 Stop-object based on number of failures More...
class  HeuristicGuidance
 Guidance for heuristic search engines (experimental). More...
class  Incumbent
 Best solution found so far. More...
class  InvalidWorkerRequest
 Exception: Invalid requested number of search workers More...
class  LdsBuilder
 A DFS engine builder. More...
class  MixedBest
 Exception: Mixed non-best and best solution search requested More...
class  NoAssets
 Exception: No assets requested for portfolio-based search More...
class  NoBest
 Exception: Best solution search is not supported More...
class  NodeStop
 Stop-object based on number of nodes More...
class  NoGoodsProp
 No-good propagator. More...
class  NoNGL
 Class for a sentinel no-good literal. More...
class  NoTraceRecorder
 Empty trace recorder. More...
class  Options
 Search engine options More...
class  PbsBuilder
 A PBS engine builder. More...
class  PbsCutoff
 Cutoff of a portfolio asset, the assets share the sequence of values. More...
class  PbsCutoffs
 Cutoff sequence shared by the assets of a portfolio. More...
struct  PbsOwnsCutoff
 Whether engine E takes ownership of the cutoff in its options. More...
struct  PbsOwnsCutoff< PBS< T, E > >
 A portfolio takes ownership of the cutoff if its assets do. More...
struct  PbsOwnsCutoff< RBS< T, E > >
 Restart-based search takes ownership of the cutoff. More...
class  Priority
 Order of open nodes: whether a is preferred to b. More...
class  Queue
 Priority queue of open nodes for A*. More...
class  RbsBuilder
 A RBS engine builder. More...
class  RestartStop
 Stop-object based on number of restarts More...
class  Statistics
 Search engine statistics More...
class  Stop
 Base-class for Stop-object. More...
class  TimeStop
 Stop-object based on time More...
class  TraceRecorder
 Simple recorder for a search tracer. More...
class  UninitializedCutoff
 Exception: Uninitialized cutoff for restart-based search More...
class  UninitializedGuidance
 Exception: Missing guidance for heuristic search More...
class  UninitializedWorkerControl
 Exception: Request through an empty worker control More...
class  UnsupportedTracer
 Exception: Search engine does not support tracing More...
class  Worker
 Search worker statistics More...
class  WorkerControl
 External control for the requested number of search workers. More...
class  WorkerControlAccess
 Internal access to worker-control state. More...
class  WorkerControlInUse
 Exception: Worker control is already bound or used in an unsupported engine More...
class  WorkerToEngine
 Virtualize a worker to an engine. More...
class  WrapTraceRecorder
 Recorder for engine events (for access control). More...

Functions

template<class T, class E>
Engine * build (Space *s, const Options &opt)
 Build an engine of type E for a script T.
template<class T, template< class > class E>
Engine * build (Space *s, const Options &opt)
 Build a parametric engine of type E for a script T.
Engine * astarengine (Space *s, const Options &o)
 Create A* engine.
Engine * babengine (Space *s, const Options &o)
 Create branch and bound engine.
Engine * cabsengine (Space *s, const Options &o)
 Create CABS engine.
Engine * dfsengine (Space *s, const Options &o)
 Create depth-first engine.
bool better (HeuristicGuidance::Sense s, std::int64_t a, std::int64_t b)
 Whether bound a is better than bound b for objective direction s.
Engine * ldsengine (Space *s, const Options &o)
 Create lds engine.
NGL * disposenext (NGL *ngl, Space &home, Propagator &p, bool c)
 Help function to cancel and dispose a no-good literal.
void pbscleanup (Engine **slaves, Stop **stops, unsigned int n_slaves, Space *master)
 Dispose partially constructed portfolio assets.
void pbscleanup (SEBs &sebs)
 Dispose builders consumed by an explicit portfolio.
void pbscontrol (const Options &opt)
 Validate worker-control placement for a homogeneous portfolio.
int pbsadmitted (const SEBs &sebs, const Options &opt)
 Return the number of explicit builders admitted by this portfolio.
void pbscontrol (const SEBs &sebs, const Options &opt)
 Validate worker-control placement for an explicit portfolio.
template<class E>
PbsCutoffs * make_pbs_cutoffs (const Options &opt, unsigned int n_slaves)
 Return the cutoffs shared by the assets of a portfolio.
void release_pbs_cutoffs (PbsCutoffs *cs, bool built)
 Release the cutoffs cs held while building.
template<class T, template< class > class E>
Engine * pbsseq (T *master, const Search::Statistics &stat, Options &opt)
template<class T, template< class > class E>
Engine * pbsseq (T *master, SEBs &sebs, const Search::Statistics &stat, Options &opt, bool best)
template<class T, template< class > class E>
Engine * pbspar (T *master, const Search::Statistics &stat, Options &opt)
template<class T, template< class > class E>
Engine * pbspar (T *master, SEBs &sebs, const Search::Statistics &stat, Options &opt, bool best)
template<class VarArgs, class Post>
void relax (Home home, const VarArgs &x, const VarArgs &sx, Rnd r, double p, Post &post)
 Relax variables in x from solution sx with probability p.
Space * snapshot (Space *s, const Options &o)
 Clone space s depending on options o.

Detailed Description

Search engines

Function Documentation

◆ build() [1/2]

template<class T, class E>
Engine * Gecode::Search::build ( Space * s,
const Options & opt )
inline

Build an engine of type E for a script T.

Definition at line 55 of file build.hpp.

◆ build() [2/2]

template<class T, template< class > class E>
Engine * Gecode::Search::build ( Space * s,
const Options & opt )

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

Build an engine of type E for a script T.

Definition at line 65 of file build.hpp.

◆ astarengine()

Engine * Gecode::Search::astarengine ( Space * s,
const Options & o )

Create A* engine.

Definition at line 90 of file astar.cpp.

◆ babengine()

Engine * Gecode::Search::babengine ( Space * s,
const Options & o )

Create branch and bound engine.

Definition at line 45 of file bab.cpp.

◆ cabsengine()

Engine * Gecode::Search::cabsengine ( Space * s,
const Options & o )

Create CABS engine.

Definition at line 142 of file cabs.cpp.

◆ dfsengine()

Engine * Gecode::Search::dfsengine ( Space * s,
const Options & o )

Create depth-first engine.

Definition at line 45 of file dfs.cpp.

◆ better()

bool Gecode::Search::better ( HeuristicGuidance::Sense s,
std::int64_t a,
std::int64_t b )
inline

Whether bound a is better than bound b for objective direction s.

Definition at line 48 of file heuristic.hh.

◆ ldsengine()

Engine * Gecode::Search::ldsengine ( Space * s,
const Options & o )

Create lds engine.

Definition at line 45 of file lds.cpp.

◆ disposenext()

NGL * Gecode::Search::disposenext ( NGL * ngl,
Space & home,
Propagator & p,
bool c )
inline

Help function to cancel and dispose a no-good literal.

Definition at line 40 of file nogoods.cpp.

◆ pbscleanup() [1/2]

void Gecode::Search::pbscleanup ( Engine ** slaves,
Stop ** stops,
unsigned int n_slaves,
Space * master )
inline

Dispose partially constructed portfolio assets.

Definition at line 43 of file pbs.hpp.

◆ pbscleanup() [2/2]

void Gecode::Search::pbscleanup ( SEBs & sebs)
inline

Dispose builders consumed by an explicit portfolio.

Definition at line 54 of file pbs.hpp.

◆ pbscontrol() [1/2]

void Gecode::Search::pbscontrol ( const Options & opt)
inline

Validate worker-control placement for a homogeneous portfolio.

Definition at line 61 of file pbs.hpp.

◆ pbsadmitted()

int Gecode::Search::pbsadmitted ( const SEBs & sebs,
const Options & opt )
inline

Return the number of explicit builders admitted by this portfolio.

Definition at line 69 of file pbs.hpp.

◆ pbscontrol() [2/2]

void Gecode::Search::pbscontrol ( const SEBs & sebs,
const Options & opt )
inline

Validate worker-control placement for an explicit portfolio.

Definition at line 79 of file pbs.hpp.

◆ make_pbs_cutoffs()

template<class E>
PbsCutoffs * Gecode::Search::make_pbs_cutoffs ( const Options & opt,
unsigned int n_slaves )
inline

Return the cutoffs shared by the assets of a portfolio.

Returns nullptr if the assets of engine E do not take ownership of the cutoff in opt, or if there are fewer than two assets.

Definition at line 212 of file pbs.hpp.

◆ release_pbs_cutoffs()

void Gecode::Search::release_pbs_cutoffs ( PbsCutoffs * cs,
bool built )
inline

Release the cutoffs cs held while building.

The flag built tells whether building has succeeded.

Definition at line 227 of file pbs.hpp.

◆ pbsseq() [1/2]

template<class T, template< class > class E>
Engine * Gecode::Search::pbsseq ( T * master,
const Search::Statistics & stat,
Options & opt )

Definition at line 301 of file pbs.hpp.

◆ pbsseq() [2/2]

template<class T, template< class > class E>
Engine * Gecode::Search::pbsseq ( T * master,
SEBs & sebs,
const Search::Statistics & stat,
Options & opt,
bool best )

Definition at line 354 of file pbs.hpp.

◆ pbspar() [1/2]

template<class T, template< class > class E>
Engine * Gecode::Search::pbspar ( T * master,
const Search::Statistics & stat,
Options & opt )

Definition at line 402 of file pbs.hpp.

◆ pbspar() [2/2]

template<class T, template< class > class E>
Engine * Gecode::Search::pbspar ( T * master,
SEBs & sebs,
const Search::Statistics & stat,
Options & opt,
bool best )

Definition at line 455 of file pbs.hpp.

◆ relax()

template<class VarArgs, class Post>
void Gecode::Search::relax ( Home home,
const VarArgs & x,
const VarArgs & sx,
Rnd r,
double p,
Post & post )
inline

Relax variables in x from solution sx with probability p.

Definition at line 51 of file relax.hh.

◆ snapshot()

Space * Gecode::Search::snapshot ( Space * s,
const Options & o )
inline

Clone space s depending on options o.

Definition at line 71 of file support.hh.