Class

scala.tools.nsc.transform

SpecializeTypes

Related Doc: package transform

Permalink

abstract class SpecializeTypes extends SubComponent with InfoTransform with TypingTransformers

Specialize code on types.

Make sure you've read the thesis:

Iulian Dragos: Compiling Scala for Performance (chapter 4)

There are some things worth noting, (possibly) not mentioned there: 0) Make sure you understand the meaning of various SpecializedInfo descriptors defined below.

1) Specializing traits by introducing bridges in specialized methods of the specialized trait may introduce problems during mixin composition. Concretely, it may cause cyclic calls and result in a stack overflow. See ticket #4351. This was solved by introducing an Abstract specialized info descriptor. Instead of generating a bridge in the trait, an abstract method is generated.

2) Specialized private members sometimes have to be switched to protected. In some cases, even this is not enough. Example:

class A[@specialized T](protected val d: T) {
  def foo(that: A[T]) = that.d
}

Specialization will generate a specialized class and a specialized method:

class A$mcI$sp(protected val d: Int) extends A[Int] {
  def foo(that: A[Int]) = foo$mcI$sp(that)
  def foo(that: A[Int]) = that.d
}

Above, A$mcI$sp cannot access d, so the method cannot be typechecked.

Source
SpecializeTypes.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SpecializeTypes
  2. TypingTransformers
  3. InfoTransform
  4. Transform
  5. SubComponent
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SpecializeTypes()

    Permalink

Type Members

  1. case class Abstract(t: Global.Symbol) extends SpecializedInfo with Product with Serializable

    Permalink

    Symbol is a specialized abstract method, either specialized or original.

    Symbol is a specialized abstract method, either specialized or original. The original t is abstract.

  2. class Duplicator extends Duplicators

    Permalink

    This duplicator additionally performs casts of expressions if that is allowed by the casts map.

  3. case class Forward(t: Global.Symbol) extends SpecializedInfo with Product with Serializable

    Permalink

    Symbol is a method that should be forwarded to 't'

  4. case class Implementation(target: Global.Symbol) extends SpecializedInfo with Product with Serializable

    Permalink

    Symbol is a specialized method whose body should be the target's method body.

  5. class ImplementationAdapter extends Global.TreeSymSubstituter

    Permalink

    A tree symbol substituter that substitutes on type skolems.

    A tree symbol substituter that substitutes on type skolems. If a type parameter is a skolem, it looks for the original symbol in the 'from' and maps it to the corresponding new symbol. The new symbol should probably be a type skolem as well (not enforced).

    All private members are made protected in order to be accessible from specialized classes.

  6. case class NormalizedMember(target: Global.Symbol) extends SpecializedInfo with Product with Serializable

    Permalink

    Symbol is a normalized member obtained by specializing 'target'.

  7. case class Overload(sym: Global.Symbol, env: TypeEnv) extends Product with Serializable

    Permalink
  8. class Phase extends InfoTransform.Phase

    Permalink
    Definition Classes
    InfoTransform
  9. case class SpecialOverload(original: Global.Symbol, env: TypeEnv) extends SpecializedInfo with Product with Serializable

    Permalink

    Symbol is a special overloaded method of 'original', in the environment env.

  10. case class SpecialOverride(target: Global.Symbol) extends SpecializedInfo with Product with Serializable

    Permalink

    Symbol is a specialized override paired with target.

  11. case class SpecialSuperAccessor(t: Global.Symbol) extends SpecializedInfo with Product with Serializable

    Permalink

    Symbol is a special overload of the super accessor.

  12. class SpecializationDuplicator extends Duplicator

    Permalink

    Introduced to fix SI-7343: Phase ordering problem between Duplicators and Specialization.

    Introduced to fix SI-7343: Phase ordering problem between Duplicators and Specialization. brief explanation: specialization rewires class parents during info transformation, and the new info then guides the tree changes. But if a symbol is created during duplication, which runs after specialization, its info is not visited and thus the corresponding tree is not specialized. One manifestation is the following: object Test { class Parent[@specialized(Int) T]

    def spec_method[@specialized(Int) T](t: T, expectedXSuper: String) = { class X extends Parent[T]() // even in the specialized variant, the local X class // doesn't extend Parent$mcI$sp, since its symbol has // been created after specialization and was not seen // by specialization's info transformer. ... } } We fix this by forcing duplication to take place before specialization.

    Note: The constructors phase (which also uses duplication) comes after erasure and uses the post-erasure typer => we must protect it from the beforeSpecialization phase shifting.

  13. class SpecializationPhase extends Phase

    Permalink
  14. class SpecializationTransformer extends Global.Transformer

    Permalink
  15. case class SpecializedAccessor(target: Global.Symbol) extends SpecializedInfo with Product with Serializable

    Permalink

    Symbol is a specialized accessor for the target field.

  16. abstract class SpecializedInfo extends AnyRef

    Permalink
  17. case class SpecializedInnerClass(target: Global.Symbol, env: TypeEnv) extends SpecializedInfo with Product with Serializable

    Permalink

    A specialized inner class that specializes original inner class target on a type parameter of the enclosing class, in the typeenv env.

  18. abstract class StdPhase extends GlobalPhase

    Permalink

    A standard phase template

    A standard phase template

    Definition Classes
    SubComponent
  19. type TypeEnv = Map[Global.Symbol, Global.Type]

    Permalink
  20. abstract class TypingTransformer extends Global.Transformer

    Permalink
    Definition Classes
    TypingTransformers

Abstract Value Members

  1. abstract val global: Global

    Permalink
    Definition Classes
    TypingTransformers
  2. abstract val runsAfter: List[String]

    Permalink

    Names of phases that must run before this phase.

    Names of phases that must run before this phase.

    Definition Classes
    SubComponent
  3. abstract val runsRightAfter: Option[String]

    Permalink

    Name of the phase that this phase must follow immediately.

    Name of the phase that this phase must follow immediately.

    Definition Classes
    SubComponent

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SpecializeTypes to any2stringadd[SpecializeTypes] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SpecializeTypes, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SpecializeTypes to ArrowAssoc[SpecializeTypes] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  6. object TypeEnv

    Permalink
  7. object UnifyError extends Throwable with ControlThrowable with Product with Serializable

    Permalink
  8. def addConcreteSpecMethod(m: Global.Symbol): Unit

    Permalink

    Add method m to the set of symbols for which we need an implementation tree in the tree transformer.

    Add method m to the set of symbols for which we need an implementation tree in the tree transformer.

    Note

    This field is part of the specializeTypes subcomponent, so any symbols that here are not garbage collected at the end of a compiler run!

  9. final def afterOwnPhase[T](op: ⇒ T): T

    Permalink
    Definition Classes
    SubComponent
    Annotations
    @inline()
  10. final def asInstanceOf[T0]: T0

    Permalink

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver object is not an instance of the erasure of type T0.

  11. final def beforeOwnPhase[T](op: ⇒ T): T

    Permalink
    Definition Classes
    SubComponent
    Annotations
    @inline()
  12. def changesBaseClasses: Boolean

    Permalink

    This phase changes base classes.

    This phase changes base classes.

    Definition Classes
    SpecializeTypesInfoTransform
  13. def clone(): AnyRef

    Permalink

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
    Note

    not specified by SLS as a member of AnyRef

  14. def concreteTypes(sym: Global.Symbol): List[Global.Type]

    Permalink

    Return the types sym should be specialized at.

    Return the types sym should be specialized at. This may be some of the primitive types or AnyRef. AnyRef means that a new type parameter T will be generated later, known to be a subtype of AnyRef (T <: AnyRef). These are in a meaningful order for stability purposes.

  15. def emptyEnv: TypeEnv

    Permalink
  16. def enabled: Boolean

    Permalink

    Is this component enabled? Default is true.

    Is this component enabled? Default is true.

    Definition Classes
    SubComponent
  17. def ensuring(cond: (SpecializeTypes) ⇒ Boolean, msg: ⇒ Any): SpecializeTypes

    Permalink
    Implicit information
    This member is added by an implicit conversion from SpecializeTypes to Ensuring[SpecializeTypes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (SpecializeTypes) ⇒ Boolean): SpecializeTypes

    Permalink
    Implicit information
    This member is added by an implicit conversion from SpecializeTypes to Ensuring[SpecializeTypes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: ⇒ Any): SpecializeTypes

    Permalink
    Implicit information
    This member is added by an implicit conversion from SpecializeTypes to Ensuring[SpecializeTypes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): SpecializeTypes

    Permalink
    Implicit information
    This member is added by an implicit conversion from SpecializeTypes to Ensuring[SpecializeTypes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean

    Permalink

    Tests whether the argument (that) is a reference to the receiver object (this).

    Tests whether the argument (that) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

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

    Permalink

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit

    Permalink

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
    Note

    not specified by SLS as a member of AnyRef

  24. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SpecializeTypes to StringFormat[SpecializeTypes] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. final def getClass(): Class[_]

    Permalink

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  26. def hasSpecializedParams(clazz: Global.Symbol): Boolean

    Permalink

    Has clazz any type parameters that need be specialized?

  27. def hashCode(): Int

    Permalink

    SubComponent are added to a HashSet and two phases are the same if they have the same name

    SubComponent are added to a HashSet and two phases are the same if they have the same name

    returns

    the hash code value for this object.

    Definition Classes
    SubComponent → AnyRef → Any
  28. def illegalSpecializedInheritance(clazz: Global.Symbol): Boolean

    Permalink
  29. val initial: Boolean

    Permalink

    True if this phase runs before all other phases.

    True if this phase runs before all other phases. Usually, parser.

    Definition Classes
    SubComponent
  30. val internal: Boolean

    Permalink

    True if this phase is not provided by a plug-in.

    True if this phase is not provided by a plug-in.

    Definition Classes
    SubComponent
  31. final def isInstanceOf[T0]: Boolean

    Permalink

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  32. def isNormalizedMember(m: Global.Symbol): Boolean

    Permalink
  33. def keepsTypeParams: Boolean

    Permalink
    Definition Classes
    SpecializeTypesInfoTransform
  34. final def ne(arg0: AnyRef): Boolean

    Permalink

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  35. def newPhase(prev: nsc.Phase): StdPhase

    Permalink

    Just to mark uncheckable

    Just to mark uncheckable

    Definition Classes
    SpecializeTypesInfoTransformTransformSubComponent
  36. def newTransformer(unit: Global.CompilationUnit): Global.Transformer

    Permalink

    The transformer factory

    The transformer factory

    Attributes
    protected
    Definition Classes
    SpecializeTypesTransform
  37. def nonConflicting(env: TypeEnv): Boolean

    Permalink

    Is any type variable in env conflicting with any if its type bounds, when type bindings in env are taken into account?

    Is any type variable in env conflicting with any if its type bounds, when type bindings in env are taken into account?

    A conflicting type environment could still be satisfiable.

  38. final def notify(): Unit

    Permalink

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  39. final def notifyAll(): Unit

    Permalink

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  40. def originalClass(clazz: Global.Symbol): Global.Symbol

    Permalink

    Return the generic class corresponding to this specialized class.

  41. def ownPhase: nsc.Phase

    Permalink

    The phase corresponding to this subcomponent in the current compiler run

    The phase corresponding to this subcomponent in the current compiler run

    Definition Classes
    SubComponent
  42. val phaseName: String

    Permalink

    the name of the phase:

    the name of the phase:

    Definition Classes
    SpecializeTypesSubComponent
  43. def phaseNewFlags: Long

    Permalink

    The following flags may be set by this phase:

    The following flags may be set by this phase:

    Definition Classes
    SpecializeTypesSubComponent
  44. def phaseNextFlags: Long

    Permalink

    New flags defined by the phase which are not valid until immediately after it

    New flags defined by the phase which are not valid until immediately after it

    Definition Classes
    SubComponent
  45. def produceTypeParameters(syms: List[Global.Symbol], nowner: Global.Symbol, env: TypeEnv): collection.immutable.List[Global.Symbol]

    Permalink

    Produces the symbols from type parameters syms of the original owner, in the given type environment env.

    Produces the symbols from type parameters syms of the original owner, in the given type environment env. The new owner is nowner.

    Non-specialized type parameters are cloned into new ones. Type parameters specialized on AnyRef have preexisting symbols.

    For instance, a @specialized(AnyRef) T, will become T$sp <: AnyRef.

  46. val requires: List[String]

    Permalink

    Names of phases required by this component.

    Names of phases required by this component. Default is Nil.

    Definition Classes
    SubComponent
  47. val runsBefore: List[String]

    Permalink

    Names of phases that must run after this phase.

    Names of phases that must run after this phase. Default is Nil.

    Definition Classes
    SubComponent
  48. def satisfiabilityConstraints(env: TypeEnv): Option[TypeEnv]

    Permalink
  49. def satisfiable(env: TypeEnv, warnings: Boolean): Boolean

    Permalink
  50. def satisfiable(env: TypeEnv): Boolean

    Permalink

    The type environment is sound w.r.t.

    The type environment is sound w.r.t. to all type bounds or only soft conflicts appear. An environment is sound if all bindings are within the bounds of the given type variable. A soft conflict is a binding that does not fall within the bounds, but whose bounds contain type variables that are @specialized, (that could become satisfiable).

  51. lazy val specializableTypes: collection.immutable.List[Global.Type]

    Permalink
  52. def specializeCalls(unit: Global.CompilationUnit): TypingTransformer { ... /* 7 definitions in type refinement */ }

    Permalink
  53. def specializeClass(clazz: Global.Symbol, outerEnv: TypeEnv): List[Global.Symbol]

    Permalink

    Specialize 'clazz', in the environment outerEnv.

    Specialize 'clazz', in the environment outerEnv. The outer environment contains bindings for specialized types of enclosing classes.

    A class C is specialized w.r.t to its own specialized type params stps, by specializing its members, and creating a new class for each combination of stps.

  54. val specializedClass: HashMap[(Global.Symbol, TypeEnv), Global.Symbol]

    Permalink

    For a given class and concrete type arguments, give its specialized class

  55. def specializedFunctionName(sym: Global.Symbol, args: List[Global.Type]): reflect.internal.Symbols.Symbol.NameType

    Permalink
  56. def specializedParams(sym: Global.Symbol): List[Global.Symbol]

    Permalink

    Return specialized type parameters.

  57. val specializedType: Global.TypeMap

    Permalink
  58. def specializedTypeVars(tpe: Global.Type): Set[Global.Symbol]

    Permalink

    Return the set of @specialized type variables mentioned by the given type.

    Return the set of @specialized type variables mentioned by the given type. It only counts type variables that appear:

    • naked
    • as arguments to type constructors in @specialized positions (arrays are considered as Array[@specialized T])
  59. def specializedTypeVars(sym: Global.Symbol): Set[Global.Symbol]

    Permalink
  60. def specializedTypeVars(tpes: List[Global.Type]): Set[Global.Symbol]

    Permalink
  61. def specializesClass(sym: Global.Symbol): Global.Symbol

    Permalink

    If the symbol is the companion of a value class, the value class.

    If the symbol is the companion of a value class, the value class. Otherwise, AnyRef.

  62. def survivingArgs(sym: Global.Symbol, args: List[Global.Type]): List[Global.Type]

    Permalink

    Given an original class symbol and a list of types its type parameters are instantiated at returns a list of type parameters that should remain in the TypeRef when instantiating a specialized type.

  63. def survivingParams(params: List[Global.Symbol], env: TypeEnv): collection.immutable.List[Global.Symbol]

    Permalink

    Type parameters that survive when specializing in the specified environment.

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

    Permalink
    Definition Classes
    AnyRef
  65. val terminal: Boolean

    Permalink

    True if this phase runs after all other phases.

    True if this phase runs after all other phases. Usually, terminal.

    Definition Classes
    SubComponent
  66. def toString(): String

    Permalink

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    AnyRef → Any
  67. def transformInfo(sym: Global.Symbol, tpe: Global.Type): Global.Type

    Permalink

    Type transformation.

    Type transformation. It is applied to all symbols, compiled or loaded. If it is a 'no-specialization' run, it is applied only to loaded symbols.

    Definition Classes
    SpecializeTypesInfoTransform
  68. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. def [B](y: B): (SpecializeTypes, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SpecializeTypes to ArrowAssoc[SpecializeTypes] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from TypingTransformers

Inherited from InfoTransform

Inherited from Transform

Inherited from SubComponent

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SpecializeTypes to any2stringadd[SpecializeTypes]

Inherited by implicit conversion StringFormat from SpecializeTypes to StringFormat[SpecializeTypes]

Inherited by implicit conversion Ensuring from SpecializeTypes to Ensuring[SpecializeTypes]

Inherited by implicit conversion ArrowAssoc from SpecializeTypes to ArrowAssoc[SpecializeTypes]

Ungrouped