Package daikon.inv.unary.sequence
Class EltUpperBound
- Object
-
- Invariant
-
- UnaryInvariant
-
- SingleSequence
-
- SingleScalarSequence
-
- EltUpperBound
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class EltUpperBound extends SingleScalarSequence
Represents the invariant that each element of a sequence of long values is less than or equal to a constant. Prints asx[] elements <= c
.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class Invariant
Invariant.ClassVarnameComparator, Invariant.ClassVarnameFormulaComparator, Invariant.InvariantComparatorForPrinting, Invariant.Match
-
-
Field Summary
Fields Modifier and Type Field Description static boolean
dkconfig_enabled
Boolean.static long
dkconfig_maximal_interesting
Long integer.static long
dkconfig_minimal_interesting
Long integer.-
Fields inherited from class SingleSequence
dkconfig_SeqIndexDisableAll
-
Fields inherited from class Invariant
CONFIDENCE_JUSTIFIED, CONFIDENCE_NEVER, CONFIDENCE_UNJUSTIFIED, debug, debugFlow, debugGuarding, debugIsObvious, debugIsWorthPrinting, debugPrint, debugPrintEquality, dkconfig_confidence_limit, dkconfig_fuzzy_ratio, dkconfig_simplify_define_predicates, falsified, invariantEnabledDefault, isGuardingPredicate, min_mod_non_missing_samples, ppt, PROBABILITY_JUSTIFIED, PROBABILITY_NEVER, PROBABILITY_UNJUSTIFIED
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description InvariantStatus
add_modified(long @Interned [] value, int count)
Similar toSingleScalarSequence.check_modified(long[], int)
except that it can change the state of the invariant if necessary.InvariantStatus
check_modified(long @Interned [] value, int count)
Presents a sample to the invariant.EltUpperBound
clone()
Do nothing special, Overridden to remove exception from declaration.protected double
computeConfidence()
This method computes the confidence that this invariant occurred by chance.boolean
enabled()
returns whether or not this invariant is enabledboolean
enoughSamples()
Returns true if the invariant has enough samples to have its computed constants well-formed.static @Nullable EltUpperBound
find(PptSlice ppt)
String
format_csharp_contract()
String
format_daikon()
String
format_esc()
String
format_java_family(OutputFormat format)
String
format_simplify()
String
format_using(OutputFormat format)
Return a printed representation of this invariant, in the given format.static EltUpperBound
get_proto()
Returns the prototype invariant for EltUpperBoundboolean
hasUninterestingConstant()
An invariant that includes an uninteresting constant (say, "size(x[]) < 237") is likely to be an artifact of the way the program was tested, rather than a statement that would in fact hold over all possible executions.EltUpperBound
instantiate_dyn(PptSlice slice)
instantiate an invariant on the specified sliceboolean
instantiate_ok(VarInfo[] vis)
EltUpperBound is only valid on integral types.boolean
isExact()
Subclasses should override.boolean
isExclusiveFormula(Invariant other)
Returns true iff the two invariants represent mutually exclusive mathematical formulas -- that is, if one of them is true, then the other must be false.@Nullable DiscardInfo
isObviousDynamically(VarInfo[] vis)
Return non-null if this invariant is necessarily true from a fact that can be determined dynamically (after checking data) -- for the given varInfos rather than the varInfos of this.@Nullable DiscardInfo
isObviousStatically(VarInfo[] vis)
Return true if this invariant is necessarily true from a fact that can be determined statically -- for the given varInfos rather than the varInfos of this.boolean
isSameFormula(Invariant other)
Returns true iff the two invariants represent the same mathematical formula.long
max()
@Nullable Invariant
merge(List<Invariant> invs, PptSlice parent_ppt)
Merge the invariants in invs to form a new invariant.boolean
mergeFormulasOk()
Bound can merge different formulas from lower points to create a single formula at an upper point.String
repr()
For printing invariants, there are two interfaces: repr gives a low-level representation (Invariant.repr_prob()
also prints the confidence), andInvariant.format()
gives a high-level representation for user output.-
Methods inherited from class SingleScalarSequence
add, add_unmodified, check, check_unmodified, valid_types, valid_types_static, var
-
Methods inherited from class UnaryInvariant
resurrect_done
-
Methods inherited from class Invariant
add_sample, asInvClass, checkRep, clear_falsified, clone_and_permute, conf_is_ge, confidence_and, confidence_and, confidence_or, createGuardedInvariant, createGuardingPredicate, falsify, find, format, format_classname, format_too_few_samples, format_unimplemented, formatFuzzy, get_comparability, get_ni_suppressions, getConfidence, getGuardingList, getGuardingList, instantiate, is_false, is_ni_suppressed, isActive, isAllPrestate, isEqualityComparison, isObvious, isObviousDynamically, isObviousDynamically_SomeInEquality, isObviousDynamically_SomeInEqualityHelper, isObviousStatically, isObviousStatically_AllInEquality, isObviousStatically_SomeInEquality, isObviousStatically_SomeInEqualityHelper, isReflexive, isSameInvariant, isValidEscExpression, isValidExpression, isWorthPrinting, justified, log, log, logDetail, logOn, match, permute, prob_and, prob_and, prob_is_ge, prob_or, repCheck, repr_prob, resurrect, simplify_format_double, simplify_format_long, simplify_format_string, state_match, toString, toString, transfer, usesVar, usesVar, usesVarDerived, varNames
-
-
-
-
Field Detail
-
dkconfig_enabled
public static boolean dkconfig_enabled
Boolean. True iff EltUpperBound invariants should be considered.
-
dkconfig_minimal_interesting
public static long dkconfig_minimal_interesting
Long integer. Together with the correspondingmaximal_interesting
parameter, specifies the range of the computed constant that is ``interesting'' --- the range that should be reported. For instance, settingminimal_interesting
to -1 andmaximal_interesting
to 2 would only permit output of EltUpperBound invariants whose cutoff was one of (-1,0,1,2).
-
dkconfig_maximal_interesting
public static long dkconfig_maximal_interesting
Long integer. Together with the correspondingminimal_interesting
parameter, specifies the range of the computed constant that is ``interesting'' --- the range that should be reported. For instance, settingminimal_interesting
to -1 andmaximal_interesting
to 2 would only permit output of EltUpperBound invariants whose cutoff was one of (-1,0,1,2).
-
-
Method Detail
-
get_proto
public static EltUpperBound get_proto()
Returns the prototype invariant for EltUpperBound
-
enabled
public boolean enabled()
returns whether or not this invariant is enabled
-
instantiate_ok
public boolean instantiate_ok(VarInfo[] vis)
EltUpperBound is only valid on integral types.- Overrides:
instantiate_ok
in classInvariant
- See Also:
Invariant.valid_types(VarInfo[])
-
instantiate_dyn
public EltUpperBound instantiate_dyn( EltUpperBound this, PptSlice slice)
instantiate an invariant on the specified slice- Specified by:
instantiate_dyn
in classInvariant
- Returns:
- the new invariant
-
clone
@SideEffectFree public EltUpperBound clone(@GuardSatisfied EltUpperBound this)
Description copied from class:Invariant
Do nothing special, Overridden to remove exception from declaration.
-
max
public long max()
-
repr
public String repr(@GuardSatisfied EltUpperBound this)
Description copied from class:Invariant
For printing invariants, there are two interfaces: repr gives a low-level representation (Invariant.repr_prob()
also prints the confidence), andInvariant.format()
gives a high-level representation for user output.
-
format_using
@SideEffectFree public String format_using(@GuardSatisfied EltUpperBound this, OutputFormat format)
Description copied from class:Invariant
Return a printed representation of this invariant, in the given format.- Specified by:
format_using
in classInvariant
-
format_daikon
public String format_daikon(@GuardSatisfied EltUpperBound this)
-
format_esc
public String format_esc(@GuardSatisfied EltUpperBound this)
-
format_csharp_contract
public String format_csharp_contract(@GuardSatisfied EltUpperBound this)
-
format_java_family
public String format_java_family(@GuardSatisfied EltUpperBound this, OutputFormat format)
-
format_simplify
public String format_simplify(@GuardSatisfied EltUpperBound this)
-
add_modified
public InvariantStatus add_modified(long @Interned [] value, int count)
Description copied from class:SingleScalarSequence
Similar toSingleScalarSequence.check_modified(long[], int)
except that it can change the state of the invariant if necessary. If the invariant doesn't have any state, then the implementation should simply callSingleScalarSequence.check_modified(long[], int)
. This method need not check for falsification; that is done by the caller.- Specified by:
add_modified
in classSingleScalarSequence
-
check_modified
public InvariantStatus check_modified(long @Interned [] value, int count)
Description copied from class:SingleScalarSequence
Presents a sample to the invariant. Returns whether the sample is consistent with the invariant. Does not change the state of the invariant.- Specified by:
check_modified
in classSingleScalarSequence
count
- how many identical samples were observed in a row. For example, three calls to check_modified with a count parameter of 1 is equivalent to one call to check_modified with a count parameter of 3.- Returns:
- whether or not the sample is consistent with the invariant
-
enoughSamples
public boolean enoughSamples(@GuardSatisfied EltUpperBound this)
Description copied from class:Invariant
Returns true if the invariant has enough samples to have its computed constants well-formed. Is overridden in classes like LinearBinary/Ternary and Upper/LowerBound.- Overrides:
enoughSamples
in classInvariant
- Returns:
- true if the invariant has enough samples to have its computed constants well-formed
-
computeConfidence
protected double computeConfidence()
Description copied from class:Invariant
This method computes the confidence that this invariant occurred by chance. Clients should callInvariant.getConfidence()
instead.This method need not check the value of field "falsified", as the caller does that.
- Specified by:
computeConfidence
in classInvariant
- Returns:
- confidence of this invariant
- See Also:
Invariant.getConfidence()
-
isExact
@Pure public boolean isExact()
Description copied from class:Invariant
Subclasses should override. An exact invariant indicates that given all but one variable value, the last one can be computed. (I think that's correct, anyway.) Examples are IntComparison (when only equality is possible), LinearBinary, FunctionUnary. OneOf is treated differently, as an interface. The result of this method does not depend on whether the invariant is justified, destroyed, etc.
-
isSameFormula
@Pure public boolean isSameFormula(Invariant other)
Description copied from class:Invariant
Returns true iff the two invariants represent the same mathematical formula. Does not consider the context such as variable names, confidences, sample counts, value counts, or related quantities. As a rule of thumb, if two invariants format the same, this method returns true. Furthermore, in many cases, if an invariant does not involve computed constants (as "x>c" and "y=ax+b" do for constants a, b, and c), then this method vacuously returns true.- Specified by:
isSameFormula
in classInvariant
- Parameters:
other
- the invariant to compare to this one- Returns:
- true iff the two invariants represent the same mathematical formula. Does not consider
-
hasUninterestingConstant
public boolean hasUninterestingConstant()
Description copied from class:Invariant
An invariant that includes an uninteresting constant (say, "size(x[]) < 237") is likely to be an artifact of the way the program was tested, rather than a statement that would in fact hold over all possible executions.- Overrides:
hasUninterestingConstant
in classInvariant
-
isObviousStatically
@Pure public @Nullable DiscardInfo isObviousStatically(VarInfo[] vis)
Description copied from class:Invariant
Return true if this invariant is necessarily true from a fact that can be determined statically -- for the given varInfos rather than the varInfos of this. Conceptually, this means "is this invariant statically obvious if its VarInfos were switched with vis?" Intended to be overridden by subclasses. Should only do static checking.Precondition: vis.length == this.ppt.var_infos.length
- Overrides:
isObviousStatically
in classInvariant
- Parameters:
vis
- the VarInfos this invariant is obvious over. The position and data type of the variables is the *same* as that of this.ppt.var_infos.
-
isObviousDynamically
@Pure public @Nullable DiscardInfo isObviousDynamically(VarInfo[] vis)
Description copied from class:Invariant
Return non-null if this invariant is necessarily true from a fact that can be determined dynamically (after checking data) -- for the given varInfos rather than the varInfos of this. Conceptually, this means, "Is this invariant dynamically obvious if its VarInfos were switched with vis?" Intended to be overriden by subclasses so they can filter invariants after checking; the overriding method should first call "super.isObviousDynamically(vis)". Since this method is dynamic, it should only be called after all processing.- Overrides:
isObviousDynamically
in classInvariant
-
isExclusiveFormula
@Pure public boolean isExclusiveFormula(Invariant other)
Description copied from class:Invariant
Returns true iff the two invariants represent mutually exclusive mathematical formulas -- that is, if one of them is true, then the other must be false. This method does not consider the context such as variable names, confidences, sample counts, value counts, or related quantities.- Overrides:
isExclusiveFormula
in classInvariant
- Parameters:
other
- the other invariant to compare to this one- Returns:
- true iff the two invariants represent mutually exclusive mathematical formulas
-
find
public static @Nullable EltUpperBound find(PptSlice ppt)
-
mergeFormulasOk
public boolean mergeFormulasOk()
Bound can merge different formulas from lower points to create a single formula at an upper point. See merge() below.- Overrides:
mergeFormulasOk
in classInvariant
- Returns:
- true if invariants with different formulas can be merged
-
merge
public @Nullable Invariant merge(List<Invariant> invs, PptSlice parent_ppt)
Merge the invariants in invs to form a new invariant. Each must be a EltUpperBound invariant. This code finds all of the min/max values in each invariant, applies them to a new parent invariant and returns the merged invariant (if any).- Overrides:
merge
in classInvariant
- Parameters:
invs
- list of invariants to merge. The invariants must all be of the same type and should come from the children of parent_ppt. They should also all be permuted to match the variable order in parent_ppt.parent_ppt
- slice that will contain the new invariant- Returns:
- the merged invariant or null if the invariants didn't represent the same invariant
-
-