Detailed Description

This class is the root class of all solution collectors.

It implements a basic query API to be used independently of the collector used.

Definition at line 4227 of file constraint_solver.h.

Classes
struct	SolutionData

Public Member Functions
	SolutionCollector (Solver const solver, const Assignment assignment)

	SolutionCollector (Solver *const solver)

	~SolutionCollector () override

void	Install () override
	Registers itself on the solver such that it gets notified of the search and propagation events. More...

std::string	DebugString () const override

void	Add (IntVar *const var)
	Add API. More...

void	Add (const std::vector< IntVar * > &vars)

void	Add (IntervalVar *const var)

void	Add (const std::vector< IntervalVar * > &vars)

void	Add (SequenceVar *const var)

void	Add (const std::vector< SequenceVar * > &vars)

void	AddObjective (IntVar *const objective)

void	EnterSearch () override
	Beginning of the search. More...

int	solution_count () const
	Returns how many solutions were stored during the search. More...

Assignment *	solution (int n) const
	Returns the nth solution. More...

int64_t	wall_time (int n) const
	Returns the wall time in ms for the nth solution. More...

int64_t	branches (int n) const
	Returns the number of branches when the nth solution was found. More...

int64_t	failures (int n) const
	Returns the number of failures encountered at the time of the nth solution. More...

int64_t	objective_value (int n) const
	Returns the objective value of the nth solution. More...

int64_t	Value (int n, IntVar *const var) const
	This is a shortcut to get the Value of 'var' in the nth solution. More...

int64_t	StartValue (int n, IntervalVar *const var) const
	This is a shortcut to get the StartValue of 'var' in the nth solution. More...

int64_t	EndValue (int n, IntervalVar *const var) const
	This is a shortcut to get the EndValue of 'var' in the nth solution. More...

int64_t	DurationValue (int n, IntervalVar *const var) const
	This is a shortcut to get the DurationValue of 'var' in the nth solution. More...

int64_t	PerformedValue (int n, IntervalVar *const var) const
	This is a shortcut to get the PerformedValue of 'var' in the nth solution. More...

const std::vector< int > &	ForwardSequence (int n, SequenceVar *const var) const
	This is a shortcut to get the ForwardSequence of 'var' in the nth solution. More...

const std::vector< int > &	BackwardSequence (int n, SequenceVar *const var) const
	This is a shortcut to get the BackwardSequence of 'var' in the nth solution. More...

const std::vector< int > &	Unperformed (int n, SequenceVar *const var) const
	This is a shortcut to get the list of unperformed of 'var' in the nth solution. More...

virtual void	RestartSearch ()
	Restart the search. More...

virtual void	ExitSearch ()
	End of the search. More...

virtual void	BeginNextDecision (DecisionBuilder *const b)
	Before calling DecisionBuilder::Next. More...

virtual void	EndNextDecision (DecisionBuilder const b, Decision const d)
	After calling DecisionBuilder::Next, along with the returned decision. More...

virtual void	ApplyDecision (Decision *const d)
	Before applying the decision. More...

virtual void	RefuteDecision (Decision *const d)
	Before refuting the decision. More...

virtual void	AfterDecision (Decision *const d, bool apply)
	Just after refuting or applying the decision, apply is true after Apply. More...

virtual void	BeginFail ()
	Just when the failure occurs. More...

virtual void	EndFail ()
	After completing the backtrack. More...

virtual void	BeginInitialPropagation ()
	Before the initial propagation. More...

virtual void	EndInitialPropagation ()
	After the initial propagation. More...

virtual bool	AcceptSolution ()
	This method is called when a solution is found. More...

virtual bool	AtSolution ()
	This method is called when a valid solution is found. More...

virtual void	NoMoreSolutions ()
	When the search tree is finished. More...

virtual bool	LocalOptimum ()
	When a local optimum is reached. More...

virtual bool	AcceptDelta (Assignment delta, Assignment deltadelta)

virtual void	AcceptNeighbor ()
	After accepting a neighbor during local search. More...

virtual void	AcceptUncheckedNeighbor ()
	After accepting an unchecked neighbor during local search. More...

virtual bool	IsUncheckedSolutionLimitReached ()
	Returns true if the limit of solutions has been reached including unchecked solutions. More...

virtual void	PeriodicCheck ()
	Periodic call to check limits in long running methods. More...

virtual int	ProgressPercent ()
	Returns a percentage representing the propress of the search before reaching limits. More...

virtual void	Accept (ModelVisitor *const visitor) const
	Accepts the given model visitor. More...

Solver *	solver () const

Static Public Attributes
static constexpr int	kNoProgress = -1

Protected Member Functions
void	PushSolution ()
	Push the current state as a new solution. More...

void	Push (const SolutionData &data)

void	PopSolution ()
	Remove and delete the last popped solution. More...

SolutionData	BuildSolutionDataForCurrentState ()

void	FreeSolution (Assignment *solution)

void	check_index (int n) const

void	ListenToEvent (Solver::MonitorEvent event)

Protected Attributes
std::unique_ptr< Assignment >	prototype_

std::vector< SolutionData >	solution_data_

std::vector< Assignment * >	recycle_solutions_

Constructor & Destructor Documentation

◆ SolutionCollector() [1/2]

SolutionCollector	(	Solver *const	solver,
		const Assignment *	assignment
	)

Definition at line 2281 of file search.cc.

◆ SolutionCollector() [2/2]

SolutionCollector ( Solver *const solver )

explicit

Definition at line 2287 of file search.cc.

◆ ~SolutionCollector()

~SolutionCollector ( )

override

Definition at line 2290 of file search.cc.

Member Function Documentation

◆ Accept()

void Accept ( ModelVisitor *const visitor ) const

virtualinherited

Accepts the given model visitor.

Reimplemented in RegularLimit, and OptimizeVar.

Definition at line 2929 of file constraint_solver.cc.

◆ AcceptDelta()

bool AcceptDelta	(	Assignment *	delta,
		Assignment *	deltadelta
	)

virtualinherited

Reimplemented in OptimizeVar.

Definition at line 2923 of file constraint_solver.cc.

◆ AcceptNeighbor()

void AcceptNeighbor ( )

virtualinherited

After accepting a neighbor during local search.

Definition at line 2926 of file constraint_solver.cc.

◆ AcceptSolution()

bool AcceptSolution ( )

virtualinherited

This method is called when a solution is found.

It asserts whether the solution is valid. A value of false indicates that the solution should be discarded.

Reimplemented in OptimizeVar.

Definition at line 2919 of file constraint_solver.cc.

◆ AcceptUncheckedNeighbor()

void AcceptUncheckedNeighbor ( )

virtualinherited

After accepting an unchecked neighbor during local search.

Reimplemented in SearchLog.

Definition at line 2927 of file constraint_solver.cc.

◆ Add() [1/6]

void Add ( const std::vector< IntervalVar * > & vars )

Definition at line 2319 of file search.cc.

◆ Add() [2/6]

void Add ( const std::vector< IntVar * > & vars )

Definition at line 2307 of file search.cc.

◆ Add() [3/6]

void Add ( const std::vector< SequenceVar * > & vars )

Definition at line 2331 of file search.cc.

◆ Add() [4/6]

void Add ( IntervalVar *const var )

Definition at line 2313 of file search.cc.

◆ Add() [5/6]

void Add ( IntVar *const var )

Add API.

Definition at line 2301 of file search.cc.

◆ Add() [6/6]

void Add ( SequenceVar *const var )

Definition at line 2325 of file search.cc.

◆ AddObjective()

void AddObjective ( IntVar *const objective )

Definition at line 2337 of file search.cc.

◆ AfterDecision()

void AfterDecision	(	Decision *const	d,
		bool	apply
	)

virtualinherited

Just after refuting or applying the decision, apply is true after Apply.

This is called only if the Apply() or Refute() methods have not failed.

Definition at line 2914 of file constraint_solver.cc.

◆ ApplyDecision()

void ApplyDecision ( Decision *const d )

virtualinherited

Before applying the decision.

Reimplemented in SearchLog.

Definition at line 2912 of file constraint_solver.cc.

◆ AtSolution()

bool AtSolution ( )

virtualinherited

This method is called when a valid solution is found.

If the return value is true, then search will resume after. If the result is false, then search will stop there.

Reimplemented in SearchLog, ImprovementSearchLimit, and OptimizeVar.

Definition at line 2920 of file constraint_solver.cc.

◆ BackwardSequence()

const std::vector< int > & BackwardSequence	(	int	n,
		SequenceVar *const	var
	)		const

This is a shortcut to get the BackwardSequence of 'var' in the nth solution.

The backward sequence is the list of ranked interval variables starting from the end of the sequence.

Definition at line 2452 of file search.cc.

◆ BeginFail()

void BeginFail ( )

virtualinherited

Just when the failure occurs.

Reimplemented in DemonProfiler, and SearchLog.

Definition at line 2915 of file constraint_solver.cc.

◆ BeginInitialPropagation()

void BeginInitialPropagation ( )

virtualinherited

Before the initial propagation.

Reimplemented in SearchLog.

Definition at line 2917 of file constraint_solver.cc.

◆ BeginNextDecision()

void BeginNextDecision ( DecisionBuilder *const b )

virtualinherited

Before calling DecisionBuilder::Next.

Reimplemented in OptimizeVar, and SearchLimit.

Definition at line 2909 of file constraint_solver.cc.

◆ branches()

int64_t branches ( int n ) const

Returns the number of branches when the nth solution was found.

Definition at line 2412 of file search.cc.

◆ BuildSolutionDataForCurrentState()

SolutionCollector::SolutionData BuildSolutionDataForCurrentState ( )

protected

Definition at line 2364 of file search.cc.

◆ check_index()

void check_index ( int n ) const

protected

Definition at line 2395 of file search.cc.

◆ DebugString()

std::string DebugString ( ) const

inlineoverridevirtual

Reimplemented from BaseObject.

Definition at line 4233 of file constraint_solver.h.

◆ DurationValue()

int64_t DurationValue	(	int	n,
		IntervalVar *const	var
	)		const

This is a shortcut to get the DurationValue of 'var' in the nth solution.

Definition at line 2435 of file search.cc.

◆ EndFail()

void EndFail ( )

virtualinherited

After completing the backtrack.

Definition at line 2916 of file constraint_solver.cc.

◆ EndInitialPropagation()

void EndInitialPropagation ( )

virtualinherited

After the initial propagation.

Reimplemented in SearchLog.

Definition at line 2918 of file constraint_solver.cc.

◆ EndNextDecision()

void EndNextDecision	(	DecisionBuilder *const	b,
		Decision *const	d
	)

virtualinherited

After calling DecisionBuilder::Next, along with the returned decision.

Reimplemented in SymmetryManager.

Definition at line 2910 of file constraint_solver.cc.

◆ EndValue()

int64_t EndValue	(	int	n,
		IntervalVar *const	var
	)		const

This is a shortcut to get the EndValue of 'var' in the nth solution.

Definition at line 2439 of file search.cc.

◆ EnterSearch()

void EnterSearch ( )

overridevirtual

Beginning of the search.

Reimplemented from SearchMonitor.

Definition at line 2343 of file search.cc.

◆ ExitSearch()

void ExitSearch ( )

virtualinherited

End of the search.

Reimplemented in LocalSearchProfiler, SearchLog, and RegularLimit.

Definition at line 2908 of file constraint_solver.cc.

◆ failures()

int64_t failures ( int n ) const

Returns the number of failures encountered at the time of the nth solution.

Definition at line 2417 of file search.cc.

◆ ForwardSequence()

const std::vector< int > & ForwardSequence	(	int	n,
		SequenceVar *const	var
	)		const

This is a shortcut to get the ForwardSequence of 'var' in the nth solution.

The forward sequence is the list of ranked interval variables starting from the start of the sequence.

Definition at line 2447 of file search.cc.

◆ FreeSolution()

void FreeSolution ( Assignment * solution )

protected

Definition at line 2389 of file search.cc.

◆ Install()

void Install ( )

overridevirtual

Registers itself on the solver such that it gets notified of the search and propagation events.

Override to incrementally install listeners for specific events.

Reimplemented from SearchMonitor.

Definition at line 2297 of file search.cc.

◆ IsUncheckedSolutionLimitReached()

virtual bool IsUncheckedSolutionLimitReached ( )

inlinevirtualinherited

Returns true if the limit of solutions has been reached including unchecked solutions.

Reimplemented in RegularLimit.

Definition at line 3827 of file constraint_solver.h.

◆ ListenToEvent()

void ListenToEvent ( Solver::MonitorEvent event )

protectedinherited

Definition at line 2938 of file constraint_solver.cc.

◆ LocalOptimum()

bool LocalOptimum ( )

virtualinherited

When a local optimum is reached.

If 'true' is returned, the last solution is discarded and the search proceeds with the next one.

Definition at line 2922 of file constraint_solver.cc.

◆ NoMoreSolutions()

void NoMoreSolutions ( )

virtualinherited

When the search tree is finished.

Reimplemented in SearchLog.

Definition at line 2921 of file constraint_solver.cc.

◆ objective_value()

int64_t objective_value ( int n ) const

Returns the objective value of the nth solution.

Definition at line 2422 of file search.cc.

◆ PerformedValue()

int64_t PerformedValue	(	int	n,
		IntervalVar *const	var
	)		const

This is a shortcut to get the PerformedValue of 'var' in the nth solution.

Definition at line 2443 of file search.cc.

◆ PeriodicCheck()

void PeriodicCheck ( )

virtualinherited

Periodic call to check limits in long running methods.

Reimplemented in SearchLimit.

Definition at line 2928 of file constraint_solver.cc.

◆ PopSolution()

void PopSolution ( )

protected

Remove and delete the last popped solution.

Definition at line 2356 of file search.cc.

◆ ProgressPercent()

virtual int ProgressPercent ( )

inlinevirtualinherited

Returns a percentage representing the propress of the search before reaching limits.

Reimplemented in RegularLimit.

Definition at line 3834 of file constraint_solver.h.

◆ Push()

void Push ( const SolutionData & data )

inlineprotected

Definition at line 4309 of file constraint_solver.h.

◆ PushSolution()

void PushSolution ( )

protected

Push the current state as a new solution.

Definition at line 2352 of file search.cc.

◆ RefuteDecision()

void RefuteDecision ( Decision *const d )

virtualinherited

Before refuting the decision.

Reimplemented in SymmetryManager, SearchLog, SearchLimit, and OptimizeVar.

Definition at line 2913 of file constraint_solver.cc.

◆ RestartSearch()

void RestartSearch ( )

virtualinherited

Restart the search.

Reimplemented in LocalSearchProfiler, and DemonProfiler.

Definition at line 2907 of file constraint_solver.cc.

◆ solution()

Assignment * solution ( int n ) const

Returns the nth solution.

Definition at line 2400 of file search.cc.

◆ solution_count()

int solution_count ( ) const

Returns how many solutions were stored during the search.

Definition at line 2405 of file search.cc.

◆ solver()

Solver* solver ( ) const

inlineinherited

Definition at line 3844 of file constraint_solver.h.

◆ StartValue()

int64_t StartValue	(	int	n,
		IntervalVar *const	var
	)		const

This is a shortcut to get the StartValue of 'var' in the nth solution.

Definition at line 2431 of file search.cc.

◆ Unperformed()

const std::vector< int > & Unperformed	(	int	n,
		SequenceVar *const	var
	)		const

This is a shortcut to get the list of unperformed of 'var' in the nth solution.

Definition at line 2457 of file search.cc.

◆ Value()

int64_t Value	(	int	n,
		IntVar *const	var
	)		const

This is a shortcut to get the Value of 'var' in the nth solution.

Definition at line 2427 of file search.cc.

◆ wall_time()

int64_t wall_time ( int n ) const

Returns the wall time in ms for the nth solution.

Definition at line 2407 of file search.cc.

Member Data Documentation

◆ kNoProgress

constexpr int kNoProgress = -1

staticconstexprinherited

Definition at line 3758 of file constraint_solver.h.

◆ prototype_

std::unique_ptr<Assignment> prototype_

protected

Definition at line 4316 of file constraint_solver.h.

◆ recycle_solutions_

std::vector<Assignment*> recycle_solutions_

protected

Definition at line 4318 of file constraint_solver.h.

◆ solution_data_

std::vector<SolutionData> solution_data_

protected

Definition at line 4317 of file constraint_solver.h.

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

Detailed Description

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ SolutionCollector() [1/2]

◆ SolutionCollector() [2/2]

◆ ~SolutionCollector()

Member Function Documentation

◆ Accept()

◆ AcceptDelta()

◆ AcceptNeighbor()

◆ AcceptSolution()

◆ AcceptUncheckedNeighbor()

◆ Add() [1/6]

◆ Add() [2/6]

◆ Add() [3/6]

◆ Add() [4/6]

◆ Add() [5/6]

◆ Add() [6/6]

◆ AddObjective()

◆ AfterDecision()

◆ ApplyDecision()

◆ AtSolution()

◆ BackwardSequence()

◆ BeginFail()

◆ BeginInitialPropagation()

◆ BeginNextDecision()

◆ branches()

◆ BuildSolutionDataForCurrentState()

◆ check_index()

◆ DebugString()

◆ DurationValue()

◆ EndFail()

◆ EndInitialPropagation()

◆ EndNextDecision()

◆ EndValue()

◆ EnterSearch()

◆ ExitSearch()

◆ failures()

◆ ForwardSequence()

◆ FreeSolution()

◆ Install()

◆ IsUncheckedSolutionLimitReached()

◆ ListenToEvent()

◆ LocalOptimum()

◆ NoMoreSolutions()

◆ objective_value()

◆ PerformedValue()

◆ PeriodicCheck()

◆ PopSolution()

◆ ProgressPercent()

◆ Push()

◆ PushSolution()

◆ RefuteDecision()

◆ RestartSearch()

◆ solution()

◆ solution_count()

◆ solver()

◆ StartValue()

◆ Unperformed()

◆ Value()

◆ wall_time()

Member Data Documentation

◆ kNoProgress

◆ prototype_

◆ recycle_solutions_

◆ solution_data_