Object
- Invariant
- - UnaryInvariant
  - - SingleSequence
    - - SingleScalarSequence
      - CommonSequence

All Implemented Interfaces:

Serializable, Cloneable
```
public class CommonSequence
extends SingleScalarSequence
```
Represents sequences of long values that contain a common subset. Prints as {e1, e2, e3, ...} subset of x[].

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 boolean dkconfig_hashcode_seqs
Boolean.
- Fields inherited from class SingleSequence
  dkconfig_SeqIndexDisableAll
- 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

Constructor Summary

Constructors
Modifier Constructor Description

protected CommonSequence()

protected CommonSequence(PptSlice ppt)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`InvariantStatus`	`add_modified(long @Interned [] a, int count)`	Similar to `SingleScalarSequence.check_modified(long[], int)` except that it can change the state of the invariant if necessary.
`InvariantStatus`	`check_modified(long @Interned [] a, 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_csharp_contract()`
`String`	`format_daikon()`
`String`	`format_using(OutputFormat format)`	Return a printed representation of this invariant, in the given format.
`static CommonSequence`	`get_proto()`	Returns the prototype invariant for CommonSequence
`protected CommonSequence`	`instantiate_dyn(PptSlice slice)`	Instantiates (creates) an invariant of the same class on the specified slice.
`boolean`	`instantiate_ok(VarInfo[] vis)`	Sequences of hashcode values won't be consistent and are thus not printed by default.
`boolean`	`isSameFormula(Invariant other)`	Returns true iff the two invariants represent the same mathematical formula.
`@Nullable CommonSequence`	`merge(List<Invariant> invs, PptSlice parent_ppt)`	Merge the invariants in invs to form a new invariant.
`String`	`repr()`	For printing invariants, there are two interfaces: repr gives a low-level representation (`Invariant.repr_prob()` also prints the confidence), and `Invariant.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, 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, 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, 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 CommonSequence invariants should be considered.
  - dkconfig_hashcode_seqs
```
public static boolean dkconfig_hashcode_seqs
```
    Boolean. Set to true to consider common sequences over hashcodes (pointers).
- Constructor Detail
  - CommonSequence
```
protected CommonSequence(PptSlice ppt)
```
  - CommonSequence
```
protected CommonSequence()
```
- Method Detail
  - get_proto
```
public static CommonSequence get_proto()
```
    Returns the prototype invariant for CommonSequence
  - 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)
```
    Sequences of hashcode values won't be consistent and are thus not printed by default.
    
    Overrides:
    
    instantiate_ok in class Invariant
    
    See Also:
    
    Invariant.valid_types(VarInfo[])
  - instantiate_dyn
```
protected CommonSequence instantiate_dyn( CommonSequence 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
  - repr
```
public String repr(@GuardSatisfied CommonSequence 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), and Invariant.format() gives a high-level representation for user output.
    
    Overrides:
    
    repr in class Invariant
    
    Returns:
    
    a string representation of this
  - format_using
```
@SideEffectFree
public String format_using(@GuardSatisfied CommonSequence 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_daikon
```
public String format_daikon(@GuardSatisfied CommonSequence this)
```
  - format_csharp_contract
```
public String format_csharp_contract(@GuardSatisfied CommonSequence this)
```
  - check_modified
```
public InvariantStatus check_modified(long @Interned [] a,
                                      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 class SingleScalarSequence
    
    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 @Interned [] a,
                                    int count)
```
    Description copied from class: SingleScalarSequence
    
    Similar to SingleScalarSequence.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 SingleScalarSequence.check_modified(long[], int). This method need not check for falsification; that is done by the caller.
    
    Specified by:
    
    add_modified in class SingleScalarSequence
  - 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
  - merge
```
public @Nullable CommonSequence merge( CommonSequence this,
                                      List<Invariant> invs,
                                      PptSlice parent_ppt)
```
    Description copied from class: Invariant
    
    Merge the invariants in invs to form a new invariant. This implementation merely returns a clone of the first invariant in the list. This is correct for simple invariants whose equation or statistics don't depend on the actual samples seen. It should be overriden for more complex invariants (eg, bound, oneof, linearbinary, etc).
    
    Overrides:
    
    merge in class Invariant
    
    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

Modifier and Type	Field	Description
`static boolean`	`dkconfig_enabled`	Boolean.
`static boolean`	`dkconfig_hashcode_seqs`	Boolean.

Modifier	Constructor	Description
`protected`	`CommonSequence()`
`protected`	`CommonSequence(PptSlice ppt)`

Class CommonSequence

Nested Class Summary

Nested classes/interfaces inherited from class Invariant

Field Summary

Fields inherited from class SingleSequence

Fields inherited from class Invariant

Constructor Summary

Method Summary

Methods inherited from class SingleScalarSequence

Methods inherited from class UnaryInvariant

Methods inherited from class Invariant

Methods inherited from class Object

Field Detail

dkconfig_enabled

dkconfig_hashcode_seqs

Constructor Detail

CommonSequence

CommonSequence

Method Detail

get_proto

enabled

instantiate_ok

instantiate_dyn

repr

format_using

format_daikon

format_csharp_contract

check_modified

add_modified

computeConfidence

isSameFormula

merge