Package daikon.inv.unary.scalar

Class Positive

Object

Invariant

UnaryInvariant

SingleScalar

Positive

All Implemented Interfaces:

Serializable, Cloneable

public class Positive
extends SingleScalar

Represents the invariant x > 0 where x is a long scalar. This exists only as an example for the purposes of the manual. It isn't actually used (it is replaced by the more general invariant LowerBound).

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.

Fields inherited from class Invariant

checkedMergeOverridden, 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

Modifier and Type	Method	Description
InvariantStatus	add_modified(long v, int count)	Similar to SingleScalar.check_modified(long, int) except that it can change the state of the invariant if necessary.
InvariantStatus	check_modified(long v, int count)	Presents a sample to the invariant.
protected double	computeConfidence()	This method computes the confidence that this invariant occurred by chance.
boolean	enabled()	Returns whether or not this class of invariants is currently enabled.
String	format_using(OutputFormat format)	Return a printed representation of this invariant, in the given format.
static Positive	get_proto()	Returns the prototype invariant.
Positive	instantiate_dyn(PptSlice slice)	Instantiates (creates) an invariant of the same class on the specified slice.
boolean	isSameFormula(Invariant other)	Returns true iff the two invariants represent the same mathematical formula.

Methods inherited from class SingleScalar

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, clone_and_permute, conf_is_ge, confidence_and, confidence_and, confidence_or, createGuardedInvariant, createGuardingPredicate, enoughSamples, falsify, find, format, format_classname, format_too_few_samples, format_unimplemented, formatFuzzy, get_comparability, get_ni_suppressions, getConfidence, getGuardingList, getGuardingList, hasUninterestingConstant, instantiate, instantiate_ok, is_false, is_ni_suppressed, isActive, isAllPrestate, isEqualityComparison, isExact, isExclusiveFormula, isObvious, isObviousDynamically, isObviousDynamically, isObviousDynamically_SomeInEquality, isObviousDynamically_SomeInEqualityHelper, isObviousStatically, isObviousStatically, isObviousStatically_AllInEquality, isObviousStatically_SomeInEquality, isObviousStatically_SomeInEqualityHelper, isReflexive, isSameInvariant, isValidEscExpression, isValidExpression, isWorthPrinting, justified, log, log, logDetail, logOn, match, merge, mergeFormulasOk, permute, prob_and, prob_and, prob_is_ge, prob_or, repCheck, repr, repr_prob, resurrect, simplify_format_double, simplify_format_long, simplify_format_string, state_match, toString, toString, transfer, usesVar, usesVar, usesVarDerived, varNames

Methods inherited from class Object

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

Field Detail

dkconfig_enabled

public static boolean dkconfig_enabled

Boolean. True iff Positive invariants should be considered.

Method Detail

get_proto

public static Positive get_proto()

Returns the prototype invariant.

enabled

public boolean enabled()

Description copied from class: Invariant

Returns whether or not this class of invariants is currently enabled.

Its implementation is almost always return dkconfig_enabled;.

Specified by:

enabled in class Invariant

instantiate_dyn

public Positive instantiate_dyn( Positive this,
                                PptSlice slice)

Description copied from class: Invariant

Instantiates (creates) an invariant of the same class on the specified slice. Must be overridden in each class. Must be used rather than Invariant.clone() so that checks in Invariant.instantiate(daikon.PptSlice) for reasonable invariants are done.

The implementation of this method is almost always return new <em>InvName</em>(slice);

Specified by:

instantiate_dyn in class Invariant

Returns:

the new invariant

format_using

@SideEffectFree
public String format_using(@GuardSatisfied Positive this,
                           OutputFormat format)

Description copied from class: Invariant

Return a printed representation of this invariant, in the given format.

Specified by:

format_using in class Invariant

check_modified

public InvariantStatus check_modified(long v,
                                      int count)

Description copied from class: SingleScalar

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 class SingleScalar

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

add_modified

public InvariantStatus add_modified(long v,
                                    int count)

Description copied from class: SingleScalar

Similar to SingleScalar.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 call SingleScalar.check_modified(long, int). This method need not check for falsification; that is done by the caller.

Specified by:

add_modified in class SingleScalar

computeConfidence

protected double computeConfidence()

Description copied from class: Invariant

This method computes the confidence that this invariant occurred by chance. Clients should call Invariant.getConfidence() instead.

This method need not check the value of field "falsified", as the caller does that.

Specified by:

computeConfidence in class Invariant

Returns:

confidence of this invariant

See Also:

Invariant.getConfidence()

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 class Invariant

Parameters:

other - the invariant to compare to this one

Returns:

true iff the two invariants represent the same mathematical formula. Does not consider