Package daikon.inv.binary.twoSequence

Class SuperSet

Object

Invariant

BinaryInvariant

TwoSequence

SuperSet

All Implemented Interfaces:

Serializable, Cloneable

public class SuperSet
extends TwoSequence

Represents two sequences of long values where one of the sequences is a subset of the other; that is each element of one sequence appears in the other. Prints as either x[] is a subset of y[] or as x[] is a superset of y[].

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 TwoSequence

swap

Fields inherited from class Invariant

checkedMergeOverridden, CONFIDENCE_JUSTIFIED, CONFIDENCE_NEVER, CONFIDENCE_UNJUSTIFIED, 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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SuperSet()
protected	SuperSet(PptSlice ppt)

Method Summary

Modifier and Type	Method	Description
InvariantStatus	add_modified(long[] a1, long[] a2, int count)	Default implementation simply calls check.
InvariantStatus	check_modified(long[] a1, long[] a2, 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.
static @Nullable SuperSet	find(PptSlice ppt)
String	format()	Returns a high-level printed representation of the invariant, for user output.
String	format_csharp_contract()
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.
NISuppressionSet	get_ni_suppressions()	returns the ni-suppressions for SuperSet
static SuperSet	get_proto()	Returns the prototype invariant for SuperSet
SuperSet	instantiate_dyn(PptSlice slice)	Instantiates (creates) an invariant of the same class on the specified slice.
boolean	instantiate_ok(VarInfo[] vis)	Returns true if it makes sense to instantiate this invariant over the specified variables.
@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.
static @Nullable DiscardInfo	isObviousSubSet(Invariant inv, VarInfo subvar, VarInfo supervar)
boolean	isSameFormula(Invariant other)	Return true if both invariants are the same class and the order of the variables (swap) is the same.
String	repr()	Returns a representation of the class.
protected Invariant	resurrect_done_swapped()	Swaps the variables by inverting the state of swap.

Methods inherited from class TwoSequence

add, add_unmodified, check, check_unmodified, get_swap, resurrect_done, resurrect_done_unswapped, valid_types, var1, var1, var2, var2

Methods inherited from class BinaryInvariant

add_unordered, check_unordered, find, is_symmetric

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_classname, format_too_few_samples, format_unimplemented, formatFuzzy, get_comparability, getConfidence, getGuardingList, getGuardingList, hasUninterestingConstant, instantiate, is_false, is_ni_suppressed, isActive, isAllPrestate, isEqualityComparison, isExact, isExclusiveFormula, isObvious, isObviousDynamically, isObviousDynamically, isObviousDynamically_SomeInEquality, isObviousDynamically_SomeInEqualityHelper, 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_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 SubSet invariants should be considered.

Constructor Detail

SuperSet

protected SuperSet(PptSlice ppt)

SuperSet

protected SuperSet()

Method Detail

get_proto

public static SuperSet get_proto()

Returns the prototype invariant for SuperSet

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_ok

public boolean instantiate_ok(VarInfo[] vis)

Description copied from class: Invariant

Returns true if it makes sense to instantiate this invariant over the specified variables. Checks details beyond what is provided by Invariant.valid_types(daikon.VarInfo[]). This should never be called without calling valid_types() first (implementations should be able to presume that valid_types() returns true).

This method does not have to be overridden; the default implementation in Invariant returns true.

Overrides:

instantiate_ok in class Invariant

See Also:

Invariant.valid_types(VarInfo[])

instantiate_dyn

public SuperSet instantiate_dyn( SuperSet 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

resurrect_done_swapped

protected Invariant resurrect_done_swapped()

Description copied from class: TwoSequence

Swaps the variables by inverting the state of swap.

Overrides:

resurrect_done_swapped in class TwoSequence

repr

public String repr(@GuardSatisfied SuperSet this)

Description copied from class: TwoSequence

Returns a representation of the class. This includes the classname, variables, and swap state.

Overrides:

repr in class TwoSequence

Returns:

a string representation of this

format_using

@SideEffectFree
public String format_using(@GuardSatisfied SuperSet 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

format

@SideEffectFree
public String format(@GuardSatisfied SuperSet this)

Description copied from class: Invariant

Returns a high-level printed representation of the invariant, for user output. format produces normal output, while the Invariant.repr() formatting routine produces low-level, detailed output for debugging, and Invariant.repr_prob() also prints the confidence.

Overrides:

format in class Invariant

Returns:

a string representation of this

format_csharp_contract

public String format_csharp_contract(@GuardSatisfied SuperSet this)

format_esc

public String format_esc(@GuardSatisfied SuperSet this)

format_simplify

public String format_simplify(@GuardSatisfied SuperSet this)

format_java_family

public String format_java_family(@GuardSatisfied SuperSet this,
                                 OutputFormat format)

check_modified

public InvariantStatus check_modified(long[] a1,
                                      long[] a2,
                                      int count)

Description copied from class: TwoSequence

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 TwoSequence

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[] a1,
                                    long[] a2,
                                    int count)

Description copied from class: TwoSequence

Default implementation simply calls check. Subclasses can override.

Overrides:

add_modified in class TwoSequence

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.

Overrides:

computeConfidence in class TwoSequence

Returns:

confidence of this invariant

See Also:

Invariant.getConfidence()

isObviousSubSet

@Pure
public static @Nullable DiscardInfo isObviousSubSet(Invariant inv,
                                                    VarInfo subvar,
                                                    VarInfo supervar)

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

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.

find

public static @Nullable SuperSet find(PptSlice ppt)

isSameFormula

@Pure
public boolean isSameFormula(Invariant other)

Description copied from class: TwoSequence

Return true if both invariants are the same class and the order of the variables (swap) is the same.

Overrides:

isSameFormula in class TwoSequence

Parameters:

other - the invariant to compare to this one

Returns:

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

get_ni_suppressions

@Pure
public NISuppressionSet get_ni_suppressions()

returns the ni-suppressions for SuperSet

Overrides:

get_ni_suppressions in class Invariant

Returns:

the set of non-instantiating suppressions for this invariant