org.chocosolver.solver

Interface ICause

All Superinterfaces:

Serializable

All Known Subinterfaces:

IVariableMonitor<V>, IView

All Known Implementing Classes:

ActivityBased, BoolEqView, BoolNotView, Cause, Decision, EqView, ImpactBased, IntDecision, IntMetaDecision, IntView, MinusView, ObjectiveManager, OffsetView, PropAbsolute, Propagator, PropAllDiff, PropAllDiffAC, PropAllDiffAdaptative, PropAllDiffBC, PropAllDiffInst, PropAllDisjoint, PropAllEqual, PropAMNV, PropAmongGAC, PropAmongGAC_GoodImpl, 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, PropCondAllDiff_AC, PropCondAllDiffInst, PropConditionnal, PropCostRegular, PropCount_AC, PropCountVar, PropDiffN, PropDistanceXYC, PropDistanceXYZ, PropDivXYZ, PropElement, PropElement, PropElementV_fast, PropEnumDomainChanneling, PropEqualX_Y, PropEqualX_YC, PropEqualXC, PropEqualXY_C, PropFalse, PropFastGCC, PropFullCumulative, PropGraphCumulative, PropGreaterOrEqualX_Y, PropGreaterOrEqualX_YC, PropGreaterOrEqualXC, PropGreaterOrEqualXY_C, PropIntBoundedMemberSet, PropIntChannel, PropIntEnumMemberSet, PropIntersection, PropIntValuePrecedeChain, PropInverse, PropInverseChannelAC, PropInverseChannelBC, PropKeysorting, PropKLoops, PropKnapsack, PropLargeCSP, PropLargeFC, PropLargeGAC2001, PropLargeGAC2001Positive, PropLargeGAC3rm, PropLargeGAC3rmPositive, PropLargeGACSTRPos, PropLargeMDDC, PropLessOrEqualXC, PropLessOrEqualXY_C, PropLex, PropLexChain, PropMax, PropMaxBC, PropMaxElement, PropMemberBound, PropMemberEnum, PropMin, PropMinBC, PropMinElement, PropMultiCostRegular, PropNbEmpty, PropNogoods, PropNoSubtour, PropNotEmpty, PropNotEqualX_Y, PropNotEqualX_YC, PropNotEqualXC, PropNotEqualXY_C, PropNotMemberBound, PropNotMemberEnum, PropNotMemberIntSet, PropNotMemberSetInt, PropOffSet, PropOpposite, PropRegular, PropReif, PropSat, PropScalar, PropScale, PropSetIntValuesUnion, PropSort, PropSquare, PropSubcircuit, PropSubcircuit_AntiArboFiltering, PropSubCircuitSCC, PropSubsetEq, PropSum, PropSumBool, PropSumBoolIncr, PropSumOfElements, PropSymmetric, PropTableStr2, PropTimesNaive, PropTimesXY, PropTimesZ, PropTrue, PropUnion, RealDecision, RealPropagator, RealView, RootDecision, ScaleView, SetDecision, Solution

public interface ICause
extends Serializable

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.

Important: when the why(org.chocosolver.solver.explanations.RuleStore, org.chocosolver.solver.variables.IntVar, org.chocosolver.solver.variables.events.IEventType, int) method needs to evaluate the incoming event, one may be aware that in some cases (for instance, BoolVar), the original event can promoted. Hence, if a cause can only explain bound modifications, it should also either consider the INSTANTIATION or the strengthen mask.

Since:

26 oct. 2010

Author:

Charles Prud'homme

Method Summary

Modifier and Type	Method and Description
boolean	why(RuleStore ruleStore, IntVar var, IEventType evt, int value) Add new rules to the rule store

Method Detail

why

boolean why(RuleStore ruleStore,
            IntVar var,
            IEventType evt,
            int value)

Add new rules to the rule store

Parameters:

ruleStore - the rule store

var - the modified variable

evt - the undergoing event

value - the value (for REMOVE only)

Returns:

true if at least one rule has been added to the rule store