Package org.jacop.jasat.modules

Class DebugModule

java.lang.Object

org.jacop.jasat.modules.DebugModule

All Implemented Interfaces:

SolverComponent, AssertionListener, BackjumpListener, ClauseListener, ConflictListener, ExplanationListener, ForgetListener, PropagateListener, SolutionListener, StartStopListener

public final class DebugModule
extends java.lang.Object
implements AssertionListener, BackjumpListener, ConflictListener, PropagateListener, SolutionListener, ForgetListener, ExplanationListener, ClauseListener, StartStopListener

module used for debug : it logs every event it is informed of

Version:

4.8

Field Summary

Fields

Modifier and Type	Field	Description
private Core	core
private MapClause	mapClause

Constructor Summary

Constructors

Constructor	Description
DebugModule()

Method Summary

Modifier and Type	Method	Description
void	initialize(Core core)	initializes the component with the given solver.
void	onAssertion(int literal, int level)	Called when a variable is set
void	onBackjump(int oldLevel, int newLevel)	Called when the solver backtracks.
void	onClauseAdd(int[] clause, int clauseId, boolean isModelClause)	called when the given clause is added.
void	onClauseRemoval(int clauseId)	called when the clause with unique Id @param clauseId is removed
void	onConflict(MapClause conflictClause, int level)	called when a conflict occurs
void	onExplain(MapClause explanation)	called when the conflict clause is explained
void	onForget()	called when the solver's forget() method is applied.
void	onPropagate(int literal, int clauseId)	called when a propagation occurs
void	onRestart(int level)	called when the solver restarts.
void	onSolution(boolean satisfiable)	a handler called when a solution is found.
void	onStart()	called when the solver starts search.
void	onStop()	called when the solver stop search, for any reason
private void	printBlank()
private void	printClause(java.lang.String prefix, MapClause mapClause)
private void	printLine(boolean start)
private void	printTrail(java.lang.String prefix, MapClause clause)

Methods inherited from class java.lang.Object

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

Field Detail

core

private Core core

mapClause

private MapClause mapClause

Constructor Detail

DebugModule

public DebugModule()

Method Detail

onRestart

public void onRestart(int level)

Description copied from interface: BackjumpListener

called when the solver restarts.

components that want to be warned about restarts should put themselves in Core.restartModules.

Specified by:

onRestart in interface BackjumpListener

Parameters:

level - the level at which the solver was before restarting

onConflict

public void onConflict(MapClause conflictClause,
                       int level)

Description copied from interface: ConflictListener

called when a conflict occurs

Specified by:

onConflict in interface ConflictListener

Parameters:

conflictClause - the conflict (unsatisfiable) clause

level - the level at which the conflict occurred

onBackjump

public void onBackjump(int oldLevel,
                       int newLevel)

Description copied from interface: BackjumpListener

Called when the solver backtracks. It will also be called when the solver restarts.

components that want to be warned about backjumps should put themselves in Core.backjumpModules.

Specified by:

onBackjump in interface BackjumpListener

Parameters:

oldLevel - the level at which the solver was before backtracking

newLevel - the level to which the solver backtracks

onAssertion

public void onAssertion(int literal,
                        int level)

Description copied from interface: AssertionListener

Called when a variable is set

Specified by:

onAssertion in interface AssertionListener

Parameters:

literal - the literal that is set propagation, false otherwise

level - the search level

onPropagate

public void onPropagate(int literal,
                        int clauseId)

Description copied from interface: PropagateListener

called when a propagation occurs

Specified by:

onPropagate in interface PropagateListener

Parameters:

literal - the literal propagated

clauseId - the unique ID of the unit clause

onSolution

public void onSolution(boolean satisfiable)

Description copied from interface: SolutionListener

a handler called when a solution is found.

Specified by:

onSolution in interface SolutionListener

Parameters:

satisfiable - true when the solution is Satisfiable, false if it is Unsatisfiable.

onExplain

public void onExplain(MapClause explanation)

Description copied from interface: ExplanationListener

called when the conflict clause is explained

Specified by:

onExplain in interface ExplanationListener

Parameters:

explanation - the explanation clause

onClauseAdd

public void onClauseAdd(int[] clause,
                        int clauseId,
                        boolean isModelClause)

Description copied from interface: ClauseListener

called when the given clause is added.

Specified by:

onClauseAdd in interface ClauseListener

Parameters:

clause - the clause

clauseId - the clause's unique Id

isModelClause - is this clause a model clause ?

onClauseRemoval

public void onClauseRemoval(int clauseId)

Description copied from interface: ClauseListener

called when the clause with unique Id @param clauseId is removed

Specified by:

onClauseRemoval in interface ClauseListener

Parameters:

clauseId - the id

onForget

public void onForget()

Description copied from interface: ForgetListener

called when the solver's forget() method is applied.

Specified by:

onForget in interface ForgetListener

onStart

public void onStart()

Description copied from interface: StartStopListener

called when the solver starts search. It will be called only once.

Specified by:

onStart in interface StartStopListener

onStop

public void onStop()

Description copied from interface: StartStopListener

called when the solver stop search, for any reason

Specified by:

onStop in interface StartStopListener

printLine

private void printLine(boolean start)

printBlank

private void printBlank()

printTrail

private void printTrail(java.lang.String prefix,
                        MapClause clause)

printClause

private void printClause(java.lang.String prefix,
                         MapClause mapClause)

initialize

public void initialize(Core core)

Description copied from interface: SolverComponent

initializes the component with the given solver. May be called only once. This method must register the component to the solver for the run.

Specified by:

initialize in interface SolverComponent

Parameters:

core - core component to initialize