Module org.chocosolver

Package org.chocosolver.solver.search.loop.monitors

Class SearchMonitorList

java.lang.Object

org.chocosolver.solver.search.loop.monitors.SearchMonitorList

All Implemented Interfaces:

IMonitorClose, IMonitorContradiction, IMonitorDownBranch, IMonitorInitialize, IMonitorOpenNode, IMonitorRestart, IMonitorSolution, IMonitorUpBranch, ISearchMonitor

public final class SearchMonitorList
extends Object
implements IMonitorClose, IMonitorContradiction, IMonitorDownBranch, IMonitorInitialize, IMonitorOpenNode, IMonitorRestart, IMonitorSolution, IMonitorUpBranch

Since:

09/05/11

Author:

Charles Prud'homme

Constructor Summary

Constructors

Constructor	Description
SearchMonitorList()

Method Summary

Modifier and Type	Method	Description
void	add(ISearchMonitor sm)	Adds a search monitor to this list
void	afterClose()	Actions to execute after closing the search
void	afterDownBranch(boolean left)	Action to perform after going down in the tree search
void	afterInitialize(boolean correct)	Actions to execute after initialisation of the solver
void	afterOpenNode()	Actions to execute after opening a node
void	afterRestart()	Actions to execute after restarting the search
void	afterUpBranch()	Actions to execute after going up in the tree search
void	beforeClose()	Actions to execute before closing the search
void	beforeDownBranch(boolean left)	Action to perform before going down in the tree search
void	beforeInitialize()	Actions to execute before initialisation of the solver
void	beforeOpenNode()	Actions to execute before opening a node
void	beforeRestart()	Actions to execute before restarting the search
void	beforeUpBranch()	Actions to execute before going up in the tree search
boolean	contains(ISearchMonitor sm)	Checks if this list contains a search monitor.
void	onContradiction(ContradictionException cex)
void	onSolution()
void	remove(ISearchMonitor sm)	Removes a search monitor for this list.
void	reset()	Clears all internal lists of search monitors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchMonitorList

public SearchMonitorList()

Method Detail

beforeInitialize

public void beforeInitialize()

Description copied from interface: IMonitorInitialize

Actions to execute before initialisation of the solver

Specified by:

beforeInitialize in interface IMonitorInitialize

afterInitialize

public void afterInitialize(boolean correct)

Description copied from interface: IMonitorInitialize

Actions to execute after initialisation of the solver

Specified by:

afterInitialize in interface IMonitorInitialize

Parameters:

correct - equals false if initialization failed, true otherwise.

beforeOpenNode

public void beforeOpenNode()

Description copied from interface: IMonitorOpenNode

Actions to execute before opening a node

Specified by:

beforeOpenNode in interface IMonitorOpenNode

afterOpenNode

public void afterOpenNode()

Description copied from interface: IMonitorOpenNode

Actions to execute after opening a node

Specified by:

afterOpenNode in interface IMonitorOpenNode

onSolution

public void onSolution()

Specified by:

onSolution in interface IMonitorSolution

beforeDownBranch

public void beforeDownBranch(boolean left)

Description copied from interface: IMonitorDownBranch

Action to perform before going down in the tree search

Specified by:

beforeDownBranch in interface IMonitorDownBranch

Parameters:

left - set to true to specify that this is a left branch

afterDownBranch

public void afterDownBranch(boolean left)

Description copied from interface: IMonitorDownBranch

Action to perform after going down in the tree search

Specified by:

afterDownBranch in interface IMonitorDownBranch

Parameters:

left - set to true to specify that this is a left branch

beforeUpBranch

public void beforeUpBranch()

Description copied from interface: IMonitorUpBranch

Actions to execute before going up in the tree search

Specified by:

beforeUpBranch in interface IMonitorUpBranch

afterUpBranch

public void afterUpBranch()

Description copied from interface: IMonitorUpBranch

Actions to execute after going up in the tree search

Specified by:

afterUpBranch in interface IMonitorUpBranch

onContradiction

public void onContradiction(ContradictionException cex)

Specified by:

onContradiction in interface IMonitorContradiction

beforeRestart

public void beforeRestart()

Description copied from interface: IMonitorRestart

Actions to execute before restarting the search

Specified by:

beforeRestart in interface IMonitorRestart

afterRestart

public void afterRestart()

Description copied from interface: IMonitorRestart

Actions to execute after restarting the search

Specified by:

afterRestart in interface IMonitorRestart

beforeClose

public void beforeClose()

Description copied from interface: IMonitorClose

Actions to execute before closing the search

Specified by:

beforeClose in interface IMonitorClose

afterClose

public void afterClose()

Description copied from interface: IMonitorClose

Actions to execute after closing the search

Specified by:

afterClose in interface IMonitorClose

add

public void add(ISearchMonitor sm)

Adds a search monitor to this list

Parameters:

sm - a search monitor

contains

public boolean contains(ISearchMonitor sm)

Checks if this list contains a search monitor.

Parameters:

sm - a search monitor

Returns:

true if this list contains sm, false otherwise.

remove

public void remove(ISearchMonitor sm)

Removes a search monitor for this list.

Parameters:

sm - a search monitor.

reset

public void reset()

Clears all internal lists of search monitors.