trait ComputationSpecification[A] extends AnyRef
Specification of the properties and the life-cycle methods of a fixpoint computation (FPC) which are required when computing the correct scheduling order and actually executing the fixpoint computation.
- Source
- ComputationSpecification.scala
- Note
The PropertyStore can be used without using ComputationSpecifications and AnalysisScenarios; both latter classes just provide convenience functionality that ensures that common issues are identified early on/are avoided.
- Alphabetic
- By Inheritance
- ComputationSpecification
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- abstract type InitializationData
The type of the data used by the analysis at initialization time.
The type of the data used by the analysis at initialization time. For analyses without special initialization requirements this type is
Null
.
Abstract Value Members
- abstract def afterPhaseCompletion(ps: PropertyStore, analysis: A): Unit
Called after phase completion.
- abstract def afterPhaseScheduling(ps: PropertyStore, analysis: A): Unit
Called back after all analyses of a specific phase have been schedule (i.e., before calling waitOnPhaseCompletion).
- abstract def beforeSchedule(ps: PropertyStore): Unit
Called directly before the analyses belonging to a phase are effectively scheduled.
Called directly before the analyses belonging to a phase are effectively scheduled. I.e., after phase setup, but potentially after other analyses'
beforeSchedule
method is called. - abstract def computationType: ComputationType
Specifies the kind of the computation that is performed.
Specifies the kind of the computation that is performed. The kind restricts in which way the analysis is allowed to interact with the property store/other analyses.
- abstract def derivesCollaboratively: Set[PropertyBounds]
- abstract def derivesEagerly: Set[PropertyBounds]
Returns the set of property kinds eagerly derived by the underlying analysis.
- abstract def derivesLazily: Option[PropertyBounds]
Returns the kind of the property that is lazily (on-demand) derived.
- abstract def init(ps: PropertyStore): InitializationData
Called directly after the analysis is registered with an analysis scheduler; in particular before any analysis belonging to the same analysis scenario is scheduled – independent of the batch in which it will run.
Called directly after the analysis is registered with an analysis scheduler; in particular before any analysis belonging to the same analysis scenario is scheduled – independent of the batch in which it will run.
This enables further initialization of the computations that will eventually be executed. For example to initialize global configuration information.
A computation specification does not have to call any methods of the property store that may trigger or schedule computations; i.e., it must – in particular – not call the methods
apply
,schedule*
,register*
orwaitOnPhaseCompletion
.- returns
The initialization data that is later on passed to schedule.
- abstract def schedule(ps: PropertyStore, i: InitializationData): A
Called by the scheduler to let the analysis register itself or to start execution.
- abstract def uses(ps: PropertyStore): Set[PropertyBounds]
Returns the kinds of properties which are queried by this analysis.
Returns the kinds of properties which are queried by this analysis.
- Note
This set consists only of property kinds which are directly used by the analysis.
,Self usages should also be documented.
,This method is called after org.opalj.fpcf.ComputationSpecification#init(ps:org\.opalj\.fpcf\.PropertyStore)* was called for all analyses belonging to an analysis scenario. (E.g., it can be used to collect the set of used property bounds based on the configuration choices made in other analyses.)
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def derives: Iterator[PropertyBounds]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def name: String
Identifies this computation specification; typically the name of the class which implements the underlying analysis.
Identifies this computation specification; typically the name of the class which implements the underlying analysis.
The default name is the name of
this
class.This method should be overridden.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- ComputationSpecification → AnyRef → Any
- def toString(ps: PropertyStore): String
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated