PurityAnalysis

This analysis determines whether a method is pure. I.e., whether the method only operates on the given state (i.e., the method is pure) or depends on other state/mutable global state; the given state may include the state of the current object that is the receiver of the call if the object/receiver is immutable.

This analysis follows the definition found on wikipedia:

[...] a function may be considered a pure function if both of the following statements about the function hold:

The function always evaluates to the same result value given the same argument value(s). The function result value cannot depend on any hidden information or state that may change while program execution proceeds or between different executions of the program, nor can it depend on any external input from I/O devices.

Hence, using true constants (e.g., Math.e) is not a problem as well as creating intermediate (mutable) data structures. Furthermore, instance method based calls can also be pure if the receiving object is (effectively final) or was created as part of the evaluation of the method.

Evaluation of the result does not cause any semantically observable side effect or output, such as mutation of mutable objects or output to I/O devices. The result value need not depend on all (or any) of the argument values. However, it must depend on nothing other than the argument values. The function may return multiple result values and these conditions must apply to all returned values for the function to be considered pure. If an argument is "call-by-reference", any parameter mutation will alter the value of the argument outside the function, which will render the function impure. However, if the referenced object is immutable it is ok.

Linear Supertypes

FPCFAnalysis, AnyRef, Any

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
implicit final val classHierarchy: ClassHierarchy

Definition Classes
FPCFAnalysis
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def determinePurity(method: Method): PropertyComputationResult

Determines the purity of the given method.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isClosedLibrary: Boolean

Definition Classes
FPCFAnalysis
final def isDesktopApplication: Boolean

Definition Classes
FPCFAnalysis
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def isJEEApplication: Boolean

Definition Classes
FPCFAnalysis
final def isOpenLibrary: Boolean

Definition Classes
FPCFAnalysis
implicit final val logContext: LogContext

Definition Classes
FPCFAnalysis
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final val project: SomeProject

Definition Classes
PurityAnalysis → FPCFAnalysis
implicit final val propertyStore: PropertyStore

Definition Classes
FPCFAnalysis
final def ps: PropertyStore

Definition Classes
FPCFAnalysis
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object PurityAnalysis | package analysis

class PurityAnalysis extends FPCFAnalysis

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

implicit final val classHierarchy: ClassHierarchy

def clone(): AnyRef

def determinePurity(method: Method): PropertyComputationResult

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isClosedLibrary: Boolean

final def isDesktopApplication: Boolean

final def isInstanceOf[T0]: Boolean

final def isJEEApplication: Boolean

final def isOpenLibrary: Boolean

implicit final val logContext: LogContext

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final val project: SomeProject

implicit final val propertyStore: PropertyStore

final def ps: PropertyStore

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from FPCFAnalysis

Inherited from AnyRef

Inherited from Any

Ungrouped