org.chocosolver.solver

Interface ICause

All Known Subinterfaces:

BoolVar, IntVar, IObjectiveManager<V>, IVariableMonitor<V>, IView

All Known Implementing Classes:

AbstractPropDistanceXYZ, ActivityBased, AdaptiveNeighborhood, BitsetArrayIntVarImpl, BitsetIntVarImpl, BoolNotView, BoolVarImpl, Cause, ClauseStore, ClauseStore.SignedClause, Decision, EqView, FixedBoolVarImpl, FixedIntVarImpl, IbexDecision, ImpactBased, IntBoolView, IntDecision, IntervalIntVarImpl, IntView, LeqView, MinusView, Neighbor, OffsetView, PropAbsolute, PropagationGuidedNeighborhood, Propagator, PropAllDiff, PropAllDiffAC, PropAllDiffAdaptative, PropAllDiffBC, PropAllDiffInst, PropAllDisjoint, PropAllEqual, PropAMNV, PropAmongGAC, PropAntiArborescences, PropAtLeastNValues, PropAtLeastNValues_AC, PropAtMost1Empty, PropAtMostNValues, PropAtMostNValues_BC, PropBinAC2001, PropBinAC3, PropBinAC3bitrm, PropBinAC3rm, PropBinCSP, PropBinFC, PropBitChanneling, PropBoolChannel, PropBoolMax, PropBoolMin, PropCardinality, PropCircuit_AntiArboFiltering, PropCircuit_ArboFiltering, PropCircuitSCC, PropClauseChanneling, PropCompactTable, PropCompactTableStar, PropCondAllDiff_AC, PropCondAllDiffInst, PropConditionnal, PropCostRegular, PropCount_AC, PropCountVar, PropCumulative, PropDiffN, PropDistanceXYC, PropDivXYZ, PropElement, PropElement, PropElementV_fast, PropEnumDomainChanneling, PropEQDistanceXYZ, PropEqualX_Y, PropEqualX_YC, PropEqualXC, PropEqualXY_C, PropFalse, PropFastGCC, PropGEDistanceXYZ, PropGraphCumulative, PropGreaterOrEqualX_Y, PropGreaterOrEqualX_YC, PropGreaterOrEqualXC, PropGreaterOrEqualXY_C, PropGTDistanceXYZ, PropIntBoundedMemberSet, PropIntChannel, PropIntCstMemberSet, PropIntCstNotMemberSet, PropIntEnumMemberSet, PropIntersection, PropIntersectionFilterSets, PropIntValuePrecedeChain, PropInverse, PropInverseChannelAC, PropInverseChannelBC, PropItemToLoad, PropKeysorting, PropKLoops, PropKnapsack, PropLargeCSP, PropLargeFC, PropLargeGAC2001, PropLargeGAC2001Positive, PropLargeGAC3rm, PropLargeGAC3rmPositive, PropLargeGACSTRPos, PropLargeMDDC, PropLEDistanceXYZ, PropLessOrEqualXC, PropLessOrEqualXY_C, PropLex, PropLexChain, PropLexInt, PropLoadToItem, PropLocalConDis, PropLTDistanceXYZ, PropMax, PropMaxBC, PropMaxElement, PropMember, PropMin, PropMinBC, PropMinElement, PropMultiCostRegular, PropNbEmpty, PropNogoods, PropNoSubtour, PropNotEmpty, PropNotEqualX_Y, PropNotEqualX_YC, PropNotEqualXC, PropNotEqualXY_C, PropNotMember, PropNotMemberIntSet, PropNotMemberSetInt, PropOffSet, PropOpposite, PropRegular, PropReif, PropSat, PropScalar, PropScalarMixed, PropScale, PropSetIntValuesUnion, PropSignedClause, PropSort, PropSquare, PropSubcircuit, PropSubcircuitDominatorFilter, PropSubsetEq, PropSum, PropSumBool, PropSumBoolIncr, PropSumFullBool, PropSumFullBoolIncr, PropSumOfElements, PropSymmetric, PropTableStr2, PropTimesNaive, PropTrue, PropUnion, PropXeqCReif, PropXeqYCReif, PropXinSReif, PropXltCReif, PropXltYCReif, PropXplusYeqZ, RandomNeighborhood, RealDecision, RealPropagator, RealView, ReversePropagationGuidedNeighborhood, RootDecision, ScaleView, SequenceNeighborhood, SetDecision, Solution

public interface ICause

This interface describes services of smallest element which can act on variables. As an example, propagator is a cause because it filters values from variable domain. So do decision, objective manager, etc. It has an impact on domain variables and so it can fails.

Since:

26 oct. 2010

Author:

Charles Prud'homme

Method Summary

Modifier and Type	Method and Description
default void	explain(ExplanationForSignedClause explanation, ValueSortedMap<IntVar> front, Implications implicationGraph, int pivot) Clausal explanation for this cause.
default void	forEachIntVar(Consumer<IntVar> action) Apply an action on each variable declared on the scope of this cause, if any.

Method Detail

explain

default void explain(ExplanationForSignedClause explanation,
                     ValueSortedMap<IntVar> front,
                     Implications implicationGraph,
                     int pivot)

Clausal explanation for this cause.

This method must filled explanations with inferred literals. These literals are inferred from the analysis of (a subset of) conflicting nodes stored in front, the implication graph ig and the current node in conflict, not yet contained in front.

Optionally, this method can update front by looking for a predecessor of any node that seems more relevant than the declared one.

Parameters:

explanation - explanation to compute

front - ordered map of (variable,node> in the conflict frontier of the implication graph.

implicationGraph - an implication graph

pivot - the pivot node out of front

forEachIntVar

default void forEachIntVar(Consumer<IntVar> action)

Apply an action on each variable declared on the scope of this cause, if any.

Parameters:

action - action to perform on each variable declared in this cause.