Class/Object

breeze.macros

expand

Related Docs: object expand | package macros

Permalink

macro class expand extends Annotation with StaticAnnotation

expand is a macro annotation that is kind of like @specialized, but it's more of a templating mechanism. It is pretty... alpha in that the functionality is basically there, but it is now in the least bit battle tested. Don't ask much of it, and it will do fine, ask a lot, and well...

Basically, expand takes a def with type arguments whose types are annotated with breeze.macros.expand.args and generates the cross product of all combinations. For example:

@expand
def foo[@expandArgs(Int, Double) T, @expandArgs(Int, Double) U](x: T, y: U) = x + y

will generate

def foo_T_Int_U_Int(x: Int, y: Int) = x + y
def foo_T_Int_U_Double(x: Int, y: Double) = x + y
def foo_T_Double_U_Int(x: Double, y: Int) = x + y
def foo_T_Double_U_Double(x: Double, y: Double) = x + y

The real power comes from breeze.macros.expand.sequence, which annotates an argument to the method to correlate with a type (the first argument to sequence) and then a sequence of trees which are inlined in place of references to the argument. For example:

@expand
def foo[@expandArgs(Int, Double) T](x: T, y: T)(implicit @sequence(T)({_ + _}, {_ * _}) op: XXX) = op(x,y)
/* The type of op is unimportant, though giving it a "real" type is useful. */

will generate

def foo_T_Int(x: Int, y: Int) = x + y
def foo_T_Double(x: Double, y: Double) = x * y

See breeze.linalg.DenseVectorOps for a more complete example.

Annotations
@compileTimeOnly( ... )
Linear Supertypes
StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. expand
  2. StaticAnnotation
  3. Annotation
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new expand()

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

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

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. macro def macroTransform(annottees: Any*): Any

    Permalink

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped