de.uka.ilkd.key.speclang

Class LoopInvariantImpl

java.lang.Object

de.uka.ilkd.key.speclang.LoopInvariantImpl

All Implemented Interfaces:

LoopInvariant, SpecificationElement

public final class LoopInvariantImpl
extends Object
implements LoopInvariant

Standard implementation of the LoopInvariant interface.

Field Summary

Fields

Modifier and Type	Field and Description
private KeYJavaType	kjt
private ImmutableList<Term>	localIns
private ImmutableList<Term>	localOuts
private LoopStatement	loop
private Map<LocationVariable,Term>	originalAtPres
private Map<LocationVariable,ImmutableList<InfFlowSpec>>	originalInfFlowSpecs
private Map<LocationVariable,Term>	originalInvariants
private Map<LocationVariable,Term>	originalModifies
private Term	originalSelfTerm
private Term	originalVariant
private IProgramMethod	pm

Constructor Summary

Constructors

Constructor and Description
LoopInvariantImpl(LoopStatement loop, IProgramMethod pm, KeYJavaType kjt, Map<LocationVariable,Term> invariants, Map<LocationVariable,Term> modifies, Map<LocationVariable,ImmutableList<InfFlowSpec>> infFlowSpecs, Term variant, Term selfTerm, ImmutableList<Term> localIns, ImmutableList<Term> localOuts, Map<LocationVariable,Term> atPres) Creates a loop invariant.
LoopInvariantImpl(LoopStatement loop, IProgramMethod pm, KeYJavaType kjt, Term selfTerm, Map<LocationVariable,Term> atPres) Creates an empty, default loop invariant for the passed loop.

Method Summary

Modifier and Type	Method and Description
LoopInvariant	configurate(Map<LocationVariable,Term> invariants, Map<LocationVariable,Term> modifies, Map<LocationVariable,ImmutableList<InfFlowSpec>> infFlowSpecs, Term variant)
LoopInvariant	create(LoopStatement loop, IProgramMethod pm, KeYJavaType kjt, Map<LocationVariable,Term> invariants, Map<LocationVariable,Term> modifies, Map<LocationVariable,ImmutableList<InfFlowSpec>> infFlowSpecs, Term variant, Term selfTerm, ImmutableList<Term> localIns, ImmutableList<Term> localOuts, Map<LocationVariable,Term> atPres)
LoopInvariant	create(LoopStatement loop, Map<LocationVariable,Term> invariants, Map<LocationVariable,Term> modifies, Map<LocationVariable,ImmutableList<InfFlowSpec>> infFlowSpecs, Term variant, Term selfTerm, ImmutableList<Term> localIns, ImmutableList<Term> localOuts, Map<LocationVariable,Term> atPres)
String	getDisplayName() Returns the displayed name.
ImmutableList<InfFlowSpec>	getInfFlowSpecs(LocationVariable heap) Returns the information flow specification clause.
ImmutableList<InfFlowSpec>	getInfFlowSpecs(LocationVariable heap, Term selfTerm, Map<LocationVariable,Term> atPres, Services services)
ImmutableList<InfFlowSpec>	getInfFlowSpecs(Services services)
Map<LocationVariable,Term>	getInternalAtPres() Returns operators internally used for the pre-heap.
Map<LocationVariable,ImmutableList<InfFlowSpec>>	getInternalInfFlowSpec()
Map<LocationVariable,Term>	getInternalInvariants() Returns the term internally used for the invariant.
Map<LocationVariable,Term>	getInternalModifies()
Term	getInternalSelfTerm() Returns the term internally used for self.
Term	getInternalVariant() Returns the term internally used for the variant.
Term	getInvariant(LocationVariable heap, Term selfTerm, Map<LocationVariable,Term> atPres, Services services) Returns the invariant formula.
Term	getInvariant(Services services)
private Map<Term,Term>	getInverseReplaceMap(Term selfTerm, Map<LocationVariable,Term> atPres, Services services)
KeYJavaType	getKJT() Returns the KeYJavaType representing the class/interface to which the specification element belongs.
LoopStatement	getLoop() Returns the loop to which the invariant belongs.
Term	getModifies()
Term	getModifies(LocationVariable heap, Term selfTerm, Map<LocationVariable,Term> atPres, Services services) Returns the modifies clause.
Term	getModifies(Term selfTerm, Map<LocationVariable,Term> atPres, Services services)
String	getName() Returns the unique internal name of the specification element.
Contract.OriginalVariables	getOrigVars() Returns the original Self Variable to replace it easier.
String	getPlainText(Services services, boolean usePrettyPrinting, boolean useUnicodeSymbols)
String	getPlainText(Services services, Iterable<LocationVariable> heapContext, boolean usePrettyPrinting, boolean useUnicodeSymbols) Returns the invariant in pretty plain text format.
private Map<Term,Term>	getReplaceMap(Term selfTerm, Map<LocationVariable,Term> atPres, Services services)
IProgramMethod	getTarget() Returns the contracted function symbol.
String	getUniqueName()
Term	getVariant(Term selfTerm, Map<LocationVariable,Term> atPres, Services services) Returns the variant term.
VisibilityModifier	getVisibility() Returns the visibility of the invariant (null for default visibility)
boolean	hasInfFlowSpec(Services services)
LoopInvariant	instantiate(Map<LocationVariable,Term> invariants, Term variant)
LoopInvariant	setInvariant(Map<LocationVariable,Term> invariants, Term selfTerm, Map<LocationVariable,Term> atPres, Services services) Returns a new loop invariant where the invariant formula has been replaced with the passed one.
LoopInvariant	setLoop(LoopStatement loop) Returns a new loop invariant where the loop reference has been replaced with the passed one.
LoopInvariant	setTarget(IProgramMethod newPM)
LoopInvariant	setTarget(KeYJavaType newKJT, IObserverFunction newPM)
String	toString()
void	visit(Visitor v) Loop invariants can be visited like source elements: This method calls the corresponding method of a visitor in order to perform some action/transformation on this element.

Methods inherited from class java.lang.Object

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

Field Detail

loop

private final LoopStatement loop

pm

private final IProgramMethod pm

kjt

private final KeYJavaType kjt

originalInvariants

private final Map<LocationVariable,Term> originalInvariants

originalModifies

private final Map<LocationVariable,Term> originalModifies

originalInfFlowSpecs

private final Map<LocationVariable,ImmutableList<InfFlowSpec>> originalInfFlowSpecs

originalVariant

private final Term originalVariant

originalSelfTerm

private final Term originalSelfTerm

localIns

private final ImmutableList<Term> localIns

localOuts

private final ImmutableList<Term> localOuts

originalAtPres

private final Map<LocationVariable,Term> originalAtPres

Constructor Detail

LoopInvariantImpl

public LoopInvariantImpl(LoopStatement loop,
                         IProgramMethod pm,
                         KeYJavaType kjt,
                         Map<LocationVariable,Term> invariants,
                         Map<LocationVariable,Term> modifies,
                         Map<LocationVariable,ImmutableList<InfFlowSpec>> infFlowSpecs,
                         Term variant,
                         Term selfTerm,
                         ImmutableList<Term> localIns,
                         ImmutableList<Term> localOuts,
                         Map<LocationVariable,Term> atPres)

Creates a loop invariant.

Parameters:

loop - the loop to which the invariant belongs

invariant - the invariant formula

modifies - the modifier set

infFlowSpecs - low variables for information flow

variant - the variant term

selfTerm - the term used for the receiver object

heapAtPre - the term used for the at pre heap

LoopInvariantImpl

public LoopInvariantImpl(LoopStatement loop,
                         IProgramMethod pm,
                         KeYJavaType kjt,
                         Term selfTerm,
                         Map<LocationVariable,Term> atPres)

Creates an empty, default loop invariant for the passed loop.

Method Detail

getReplaceMap

private Map<Term,Term> getReplaceMap(Term selfTerm,
                                     Map<LocationVariable,Term> atPres,
                                     Services services)

getInverseReplaceMap

private Map<Term,Term> getInverseReplaceMap(Term selfTerm,
                                            Map<LocationVariable,Term> atPres,
                                            Services services)

getLoop

public LoopStatement getLoop()

Description copied from interface: LoopInvariant

Returns the loop to which the invariant belongs.

Specified by:

getLoop in interface LoopInvariant

getInvariant

public Term getInvariant(LocationVariable heap,
                         Term selfTerm,
                         Map<LocationVariable,Term> atPres,
                         Services services)

Description copied from interface: LoopInvariant

Returns the invariant formula.

Specified by:

getInvariant in interface LoopInvariant

getInvariant

public Term getInvariant(Services services)

Specified by:

getInvariant in interface LoopInvariant

getModifies

public Term getModifies(LocationVariable heap,
                        Term selfTerm,
                        Map<LocationVariable,Term> atPres,
                        Services services)

Description copied from interface: LoopInvariant

Returns the modifies clause.

Specified by:

getModifies in interface LoopInvariant

getModifies

public Term getModifies(Term selfTerm,
                        Map<LocationVariable,Term> atPres,
                        Services services)

Specified by:

getModifies in interface LoopInvariant

getInfFlowSpecs

public ImmutableList<InfFlowSpec> getInfFlowSpecs(LocationVariable heap,
                                                  Term selfTerm,
                                                  Map<LocationVariable,Term> atPres,
                                                  Services services)

Specified by:

getInfFlowSpecs in interface LoopInvariant

getInfFlowSpecs

public ImmutableList<InfFlowSpec> getInfFlowSpecs(LocationVariable heap)

Description copied from interface: LoopInvariant

Returns the information flow specification clause.

Specified by:

getInfFlowSpecs in interface LoopInvariant

getInfFlowSpecs

public ImmutableList<InfFlowSpec> getInfFlowSpecs(Services services)

Specified by:

getInfFlowSpecs in interface LoopInvariant

getVariant

public Term getVariant(Term selfTerm,
                       Map<LocationVariable,Term> atPres,
                       Services services)

Description copied from interface: LoopInvariant

Returns the variant term.

Specified by:

getVariant in interface LoopInvariant

getInternalInvariants

public Map<LocationVariable,Term> getInternalInvariants()

Description copied from interface: LoopInvariant

Returns the term internally used for the invariant. Use with care - it is likely that this is *not* the right "self" for you.

Specified by:

getInternalInvariants in interface LoopInvariant

getInternalVariant

public Term getInternalVariant()

Description copied from interface: LoopInvariant

Returns the term internally used for the variant. Use with care - it is likely that this is *not* the right "self" for you.

Specified by:

getInternalVariant in interface LoopInvariant

getInternalModifies

public Map<LocationVariable,Term> getInternalModifies()

Specified by:

getInternalModifies in interface LoopInvariant

getInternalInfFlowSpec

public Map<LocationVariable,ImmutableList<InfFlowSpec>> getInternalInfFlowSpec()

Specified by:

getInternalInfFlowSpec in interface LoopInvariant

getInternalSelfTerm

public Term getInternalSelfTerm()

Description copied from interface: LoopInvariant

Returns the term internally used for self. Use with care - it is likely that this is *not* the right "self" for you.

Specified by:

getInternalSelfTerm in interface LoopInvariant

getModifies

public Term getModifies()

Specified by:

getModifies in interface LoopInvariant

getInternalAtPres

public Map<LocationVariable,Term> getInternalAtPres()

Description copied from interface: LoopInvariant

Returns operators internally used for the pre-heap.

Specified by:

getInternalAtPres in interface LoopInvariant

create

public LoopInvariant create(LoopStatement loop,
                            IProgramMethod pm,
                            KeYJavaType kjt,
                            Map<LocationVariable,Term> invariants,
                            Map<LocationVariable,Term> modifies,
                            Map<LocationVariable,ImmutableList<InfFlowSpec>> infFlowSpecs,
                            Term variant,
                            Term selfTerm,
                            ImmutableList<Term> localIns,
                            ImmutableList<Term> localOuts,
                            Map<LocationVariable,Term> atPres)

Specified by:

create in interface LoopInvariant

create

public LoopInvariant create(LoopStatement loop,
                            Map<LocationVariable,Term> invariants,
                            Map<LocationVariable,Term> modifies,
                            Map<LocationVariable,ImmutableList<InfFlowSpec>> infFlowSpecs,
                            Term variant,
                            Term selfTerm,
                            ImmutableList<Term> localIns,
                            ImmutableList<Term> localOuts,
                            Map<LocationVariable,Term> atPres)

Specified by:

create in interface LoopInvariant

instantiate

public LoopInvariant instantiate(Map<LocationVariable,Term> invariants,
                                 Term variant)

Specified by:

instantiate in interface LoopInvariant

configurate

public LoopInvariant configurate(Map<LocationVariable,Term> invariants,
                                 Map<LocationVariable,Term> modifies,
                                 Map<LocationVariable,ImmutableList<InfFlowSpec>> infFlowSpecs,
                                 Term variant)

Specified by:

configurate in interface LoopInvariant

setLoop

public LoopInvariant setLoop(LoopStatement loop)

Description copied from interface: LoopInvariant

Returns a new loop invariant where the loop reference has been replaced with the passed one.

Specified by:

setLoop in interface LoopInvariant

setTarget

public LoopInvariant setTarget(IProgramMethod newPM)

Specified by:

setTarget in interface LoopInvariant

setInvariant

public LoopInvariant setInvariant(Map<LocationVariable,Term> invariants,
                                  Term selfTerm,
                                  Map<LocationVariable,Term> atPres,
                                  Services services)

Description copied from interface: LoopInvariant

Returns a new loop invariant where the invariant formula has been replaced with the passed one. Take care: the variables used for the receiver, parameters, and local variables must stay the same!

Specified by:

setInvariant in interface LoopInvariant

visit

public void visit(Visitor v)

Description copied from interface: LoopInvariant

Loop invariants can be visited like source elements: This method calls the corresponding method of a visitor in order to perform some action/transformation on this element.

Specified by:

visit in interface LoopInvariant

toString

public String toString()

Overrides:

toString in class Object

getPlainText

public String getPlainText(Services services,
                           boolean usePrettyPrinting,
                           boolean useUnicodeSymbols)

getPlainText

public String getPlainText(Services services,
                           Iterable<LocationVariable> heapContext,
                           boolean usePrettyPrinting,
                           boolean useUnicodeSymbols)

Description copied from interface: LoopInvariant

Returns the invariant in pretty plain text format.

Specified by:

getPlainText in interface LoopInvariant

getDisplayName

public String getDisplayName()

Description copied from interface: SpecificationElement

Returns the displayed name.

Specified by:

getDisplayName in interface SpecificationElement

getTarget

public IProgramMethod getTarget()

Description copied from interface: LoopInvariant

Returns the contracted function symbol.

Specified by:

getTarget in interface LoopInvariant

getKJT

public KeYJavaType getKJT()

Description copied from interface: SpecificationElement

Returns the KeYJavaType representing the class/interface to which the specification element belongs.

Specified by:

getKJT in interface LoopInvariant

Specified by:

getKJT in interface SpecificationElement

getName

public String getName()

Description copied from interface: SpecificationElement

Returns the unique internal name of the specification element.

Specified by:

getName in interface SpecificationElement

getUniqueName

public String getUniqueName()

Specified by:

getUniqueName in interface LoopInvariant

getVisibility

public VisibilityModifier getVisibility()

Description copied from interface: SpecificationElement

Returns the visibility of the invariant (null for default visibility)

Specified by:

getVisibility in interface SpecificationElement

hasInfFlowSpec

public boolean hasInfFlowSpec(Services services)

Specified by:

hasInfFlowSpec in interface LoopInvariant

setTarget

public LoopInvariant setTarget(KeYJavaType newKJT,
                               IObserverFunction newPM)

Specified by:

setTarget in interface LoopInvariant

getOrigVars

public Contract.OriginalVariables getOrigVars()

Description copied from interface: LoopInvariant

Returns the original Self Variable to replace it easier.

Specified by:

getOrigVars in interface LoopInvariant