org.chocosolver.solver.search.loop

Interface ISearchLoop

All Superinterfaces:

Serializable

All Known Implementing Classes:

SearchLoop

public interface ISearchLoop
extends Serializable

Since:

6 oct. 2010

Author:

Charles Prud'homme

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOWN_LEFT_BRANCH
static int	DOWN_RIGHT_BRANCH
static int	INIT
static int	INITIAL_PROPAGATION
static String	MSG_CUT
static String	MSG_FIRST_SOL
static String	MSG_INIT
static String	MSG_LIMIT
static String	MSG_ROOT
static String	MSG_SEARCH_INIT
static int	OPEN_NODE
static int	RESTART
static int	RESUME
static int	UP_BRANCH

Method Summary

Methods

Modifier and Type	Method and Description
void	forceAlive(boolean b)
int	getCurrentDepth()
Decision	getLastDecision()
ObjectiveManager	getObjectiveManager()
int	getSearchWorldIndex()
SearchMonitorList	getSMList()
AbstractStrategy	getStrategy()
int	getTimeStamp() Deprecated.
boolean	hasEndedUnexpectedly()
boolean	hasReachedLimit()
void	interrupt(String msgNgood) Force the search to stop
boolean	isDefaultSearchUsed() Indicate if the default searcg strategy is used
boolean	isSearchCompleted() Indicate if the search strategy is completed with one over all variables
void	launch(boolean stopAtFirst) Launch the resolution of the problem described in a Solver.
void	makeCompleteStrategy(boolean isComplete) Complete (or not) the declared search strategy with one over all variables
void	moveTo(int nextState)
void	overridePreviousWorld(int i)
void	plugSearchMonitor(ISearchMonitor sm) Branch a search monitor
void	reachLimit()
void	reset() This method enables to solve a problem another time: It backtracks up to the root node of the search tree, it sets the objective manager to null, it resets the measures to 0, and sets the propagation engine to NO_NoPropagationEngine.
void	restart() Sets the following action in the search to be a restart instruction.
void	restoreRootNode() Retrieves the state of the root node (after the initial propagation) Has an immediate effect
void	resume() Resume the resolution of the problem described in a Solver.
void	set(AbstractStrategy strategy)
void	setLastDecision(Decision cobdec)
void	setObjectiveManager(ObjectiveManager om)

Field Detail

INIT

static final int INIT

See Also:

Constant Field Values

INITIAL_PROPAGATION

static final int INITIAL_PROPAGATION

See Also:

Constant Field Values

OPEN_NODE

static final int OPEN_NODE

See Also:

Constant Field Values

DOWN_LEFT_BRANCH

static final int DOWN_LEFT_BRANCH

See Also:

Constant Field Values

DOWN_RIGHT_BRANCH

static final int DOWN_RIGHT_BRANCH

See Also:

Constant Field Values

UP_BRANCH

static final int UP_BRANCH

See Also:

Constant Field Values

RESTART

static final int RESTART

See Also:

Constant Field Values

RESUME

static final int RESUME

See Also:

Constant Field Values

MSG_LIMIT

static final String MSG_LIMIT

See Also:

Constant Field Values

MSG_ROOT

static final String MSG_ROOT

See Also:

Constant Field Values

MSG_CUT

static final String MSG_CUT

See Also:

Constant Field Values

MSG_FIRST_SOL

static final String MSG_FIRST_SOL

See Also:

Constant Field Values

MSG_INIT

static final String MSG_INIT

See Also:

Constant Field Values

MSG_SEARCH_INIT

static final String MSG_SEARCH_INIT

See Also:

Constant Field Values

Method Detail

launch

void launch(boolean stopAtFirst)

Launch the resolution of the problem described in a Solver.

Parameters:

stopAtFirst - should stop at first solution

resume

void resume()

Resume the resolution of the problem described in a Solver.

reset

void reset()

This method enables to solve a problem another time:

• It backtracks up to the root node of the search tree,
• it sets the objective manager to null,
• it resets the measures to 0,
• and sets the propagation engine to NO_NoPropagationEngine.

restart

void restart()

Sets the following action in the search to be a restart instruction. Note that the restart may not be immediate

restoreRootNode

void restoreRootNode()

Retrieves the state of the root node (after the initial propagation) Has an immediate effect

interrupt

void interrupt(String msgNgood)

Force the search to stop

Parameters:

msgNgood - a message to motivate the interruption -- for logging only

plugSearchMonitor

void plugSearchMonitor(ISearchMonitor sm)

Branch a search monitor

Parameters:

sm - a search monitor

set

void set(AbstractStrategy strategy)

setObjectiveManager

void setObjectiveManager(ObjectiveManager om)

reachLimit

void reachLimit()

makeCompleteStrategy

void makeCompleteStrategy(boolean isComplete)

Complete (or not) the declared search strategy with one over all variables

Parameters:

isComplete - set to true to complete the current search strategy

getObjectiveManager

ObjectiveManager getObjectiveManager()

getStrategy

AbstractStrategy getStrategy()

hasReachedLimit

boolean hasReachedLimit()

hasEndedUnexpectedly

boolean hasEndedUnexpectedly()

getTimeStamp

@Deprecated
int getTimeStamp()

Deprecated.

getLastDecision

Decision getLastDecision()

getCurrentDepth

int getCurrentDepth()

isDefaultSearchUsed

boolean isDefaultSearchUsed()

Indicate if the default searcg strategy is used

Returns:

false if a search strategy is used

isSearchCompleted

boolean isSearchCompleted()

Indicate if the search strategy is completed with one over all variables

Returns:

false if no strategy over all variables complete the declared one

getSMList

SearchMonitorList getSMList()

forceAlive

void forceAlive(boolean b)

setLastDecision

void setLastDecision(Decision cobdec)

overridePreviousWorld

void overridePreviousWorld(int i)

moveTo

void moveTo(int nextState)

getSearchWorldIndex

int getSearchWorldIndex()