org.chocosolver.solver.explanations

Class Explanation

java.lang.Object

org.chocosolver.solver.explanations.Explanation

public class Explanation
extends Object

An explanation is simply a set of causes and decisions explaining a situation, for instance a conflict. It is related to the explanation engine (replacement of Explanation) Created by cprudhom on 09/12/14. Project: choco.

Constructor Summary

Constructors

Constructor and Description
Explanation(boolean saveCauses)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addCause(ICause cause) Add a cause, which explains, partially, the situation
void	addCausesAndDecisions(Explanation explanation) Merge all causes and decisions from explanation in this.
void	addDecicion(Decision decision) Add a decision, which explains, partially, the situation
void	addRules(Rules someRules) Merge 'someRules' into this rules
void	clear() Clear the explanation, to enable reusing it.
void	copyRules(Rules rules, int i) Copy the rules The rules define which events should be filtered from the event store.
Explanation	duplicate() Duplicate the current explanation
Set<ICause>	getCauses() Return a unmodifiable copy of the set of causes
BitSet	getDecisions() Return a unmodifiable copy of the set of decisions
int	getEvtstrIdx() Get the event store idx at which the last analysis ends
Rules	getRules() Return the rules, may be null
boolean	isComplete() Indicates whether or not the explanation is complete
int	nbCauses() Return the number of causes explaining the situation
int	nbDecisions() Return the number of decisions explaining the situation
void	postNogood(PropNogoods ngstore, gnu.trove.list.TIntList ps)
void	remove(Decision decision) Remove one decision from the set of decisions explaining the situation
boolean	remove(ICause cause) Remove one cause from the set of causes explaining the situation
void	setEvtstrIdx(int evtstrIdx) Set the event store idx, where the last analysis ends
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Explanation

public Explanation(boolean saveCauses)

Method Detail

addCause

public boolean addCause(ICause cause)

Add a cause, which explains, partially, the situation

Parameters:

cause - a cause

Returns:

true if this was an unknown cause

addDecicion

public void addDecicion(Decision decision)

Add a decision, which explains, partially, the situation

Parameters:

decision - a decision

nbCauses

public int nbCauses()

Return the number of causes explaining the situation

Returns:

an int

nbDecisions

public int nbDecisions()

Return the number of decisions explaining the situation

Returns:

an int

addCausesAndDecisions

public void addCausesAndDecisions(Explanation explanation)

Merge all causes and decisions from explanation in this.

Parameters:

explanation - a given explanation

addRules

public void addRules(Rules someRules)

Merge 'someRules' into this rules

Parameters:

someRules - the rules to add

remove

public boolean remove(ICause cause)

Remove one cause from the set of causes explaining the situation

Parameters:

cause - a cause to remove

Returns:

true if the explanation changed

remove

public void remove(Decision decision)

Remove one decision from the set of decisions explaining the situation

Parameters:

decision - a decision to remove

getDecisions

public BitSet getDecisions()

Return a unmodifiable copy of the set of decisions

getCauses

public Set<ICause> getCauses()

Return a unmodifiable copy of the set of causes

isComplete

public boolean isComplete()

Indicates whether or not the explanation is complete

copyRules

public void copyRules(Rules rules,
             int i)

Copy the rules The rules define which events should be filtered from the event store.

Parameters:

rules - set of rules (when not complete)

getEvtstrIdx

public int getEvtstrIdx()

Get the event store idx at which the last analysis ends

Returns:

an event store index

setEvtstrIdx

public void setEvtstrIdx(int evtstrIdx)

Set the event store idx, where the last analysis ends

Parameters:

evtstrIdx - an event store index

getRules

public Rules getRules()

Return the rules, may be null

Returns:

the rules or null

duplicate

public Explanation duplicate()

Duplicate the current explanation

Returns:

a new explanation

clear

public void clear()

Clear the explanation, to enable reusing it.

toString

public String toString()

Overrides:

toString in class Object

postNogood

public void postNogood(PropNogoods ngstore,
              gnu.trove.list.TIntList ps)