Trait/Object

de.sciss.lucre.matrix.Matrix

Var

Related Docs: object Var | package Matrix

Permalink

trait Var[S <: Sys[S]] extends Matrix[S] with matrix.Var[S, Matrix[S]] with Publisher[S, Matrix.Var.Update[S]]

Linear Supertypes
matrix.Var[S, Matrix[S]], Node[S], Source[S.Tx, Matrix[S]], Sink[S.Tx, Matrix[S]], Matrix[S], Obj[S], Mutable[S.ID, S.Tx], Identifiable[S.ID], Elem[S], Publisher[S, Var.Update[S]], Disposable[S.Tx], Writable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Var
  2. Var
  3. Node
  4. Source
  5. Sink
  6. Matrix
  7. Obj
  8. Mutable
  9. Identifiable
  10. Elem
  11. Publisher
  12. Disposable
  13. Writable
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def apply()(implicit tx: S.Tx): Matrix[S]

    Permalink
    Definition Classes
    Source
  2. abstract def changed: EventLike[S, Var.Update[S]]

    Permalink
    Definition Classes
    Publisher
  3. abstract def dimensions(implicit tx: S.Tx): Vec[Matrix[S]]

    Permalink

    The sequence of underlying dimension matrices.

    The sequence of underlying dimension matrices. The part of each dimension covered by this matrix is reflected by the corresponding entry in ranges!

    In other words, the reductions and transformations associated with the current (and possibly any number of preceding) matrices are not reflected in the returned objects! To read the dimensional values with respect to the actual matrix coordinates, the getDimensionKey method can be used.

    Definition Classes
    Matrix
  4. abstract def disposeData()(implicit tx: S.Tx): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Node
  5. abstract def getDimensionKey(index: Int, useChannels: Boolean)(implicit tx: S.Tx): Key

    Permalink

    Produces a matrix key for the dimension of a given index.

    Produces a matrix key for the dimension of a given index. Since a dimension is 1-dimensional, the key will either have a streaming-index of zero (when useChannels is false), resulting in a 1-channel reader with shape(index) frames; or it will have a streaming-index of -1 (when useChannels is true), resulting in an n-channel reader with one frame, where n == shape(index).

    index

    the index of the dimension, from zero until rank

    useChannels

    if true produces multi-channel file of one frame, if false produces monophonic file of several frames.

    Definition Classes
    Matrix
  6. abstract def getKey(streamDim: Int)(implicit tx: S.Tx): Key

    Permalink

    The key of a matrix is an immutable value that represents its current state, possibly prepared with a transposition to be streamed along one of its dimensions.

    The key of a matrix is an immutable value that represents its current state, possibly prepared with a transposition to be streamed along one of its dimensions.

    streamDim

    the index of the dimension to stream the matrix data through, or -1 to read the whole matrix in one frame.

    Definition Classes
    Matrix
  7. abstract def name(implicit tx: S.Tx): String

    Permalink

    A matrix has a name.

    A matrix has a name. For example, when coming from a NetCDF data source, the matrix name corresponds to a variable name.

    Definition Classes
    Matrix
  8. abstract def ranges(implicit tx: S.Tx): Vec[Range]

    Permalink

    The ranges specify the regions inside the underlying dimension matrices covered by this matrix.

    The ranges specify the regions inside the underlying dimension matrices covered by this matrix. For example if a 4 x 5 matrix is reduced in its first dimension using a slice 1 to 2 operator, then the _dimension_ will have a size of four, but the first range will be 1 to 2 (and thus size 2).

    Definition Classes
    Matrix
  9. abstract def shape(implicit tx: S.Tx): Vec[Int]

    Permalink

    The shape is the vector of dimensional sizes.

    The shape is the vector of dimensional sizes. This is equivalent to ranges.map(_.size). Note that the dimensions themselves may be larger.

    Definition Classes
    Matrix
  10. abstract def targets: Targets[S]

    Permalink
    Attributes
    protected
    Definition Classes
    Node
  11. abstract def units(implicit tx: S.Tx): String

    Permalink

    The units of the matrix cells, or an empty string to indicate that no units are specified.

    The units of the matrix cells, or an empty string to indicate that no units are specified.

    Definition Classes
    Matrix
  12. abstract def update(v: Matrix[S])(implicit tx: S.Tx): Unit

    Permalink
    Definition Classes
    Sink
  13. abstract def writeData(out: DataOutput): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Node

Concrete 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. final def attr(implicit tx: S.Tx): AttrMap[S]

    Permalink
    Definition Classes
    Obj
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def dispose()(implicit tx: S.Tx): Unit

    Permalink
    Definition Classes
    NodeDisposable
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  10. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  13. final def id: S.ID

    Permalink
    Definition Classes
    NodeIdentifiable
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. def rank(implicit tx: S.Tx): Int

    Permalink

    The rank is the number of dimensions.

    The rank is the number of dimensions.

    Definition Classes
    Matrix
  19. def reader(streamDim: Int)(implicit tx: S.Tx, resolver: Resolver[S]): Reader

    Permalink
    Definition Classes
    Matrix
  20. def reducedDimensions(implicit tx: S.Tx): Vec[Matrix[S]]

    Permalink
    Definition Classes
    Matrix
  21. def reducedRanges(implicit tx: S.Tx): Vec[Range]

    Permalink
    Definition Classes
    Matrix
  22. def reducedRank(implicit tx: S.Tx): Int

    Permalink
    Definition Classes
    Matrix
  23. def reducedShape(implicit tx: S.Tx): Vec[Int]

    Permalink
    Definition Classes
    Matrix
  24. def size(implicit tx: S.Tx): Long

    Permalink

    The size is the number of matrix cells, that is the product of the shape.

    The size is the number of matrix cells, that is the product of the shape.

    Definition Classes
    Matrix
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. def toString(): String

    Permalink
    Definition Classes
    Node → AnyRef → Any
  27. final def tpe: Type

    Permalink
    Definition Classes
    MatrixObjElem
  28. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def write(out: DataOutput): Unit

    Permalink
    Definition Classes
    Node → Writable

Inherited from matrix.Var[S, Matrix[S]]

Inherited from Node[S]

Inherited from Source[S.Tx, Matrix[S]]

Inherited from Sink[S.Tx, Matrix[S]]

Inherited from Matrix[S]

Inherited from Obj[S]

Inherited from Mutable[S.ID, S.Tx]

Inherited from Identifiable[S.ID]

Inherited from Elem[S]

Inherited from Publisher[S, Var.Update[S]]

Inherited from Disposable[S.Tx]

Inherited from Writable

Inherited from AnyRef

Inherited from Any

Ungrouped