Trait/Object

de.sciss.lucre.matrix

Matrix

Related Docs: object Matrix | package matrix

Permalink

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

Linear Supertypes
Obj[S], Mutable[S.ID, S.Tx], Identifiable[S.ID], Elem[S], Publisher[S, Update[S]], Disposable[S.Tx], Writable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Matrix
  2. Obj
  3. Mutable
  4. Identifiable
  5. Elem
  6. Publisher
  7. Disposable
  8. Writable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def changed: EventLike[S, Update[S]]

    Permalink
    Definition Classes
    Publisher
  2. 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.

  3. abstract def dispose()(implicit tx: S.Tx): Unit

    Permalink
    Definition Classes
    Disposable
  4. 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.

  5. 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.

  6. abstract def id: S.ID

    Permalink
    Definition Classes
    Identifiable
  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.

  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).

  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.

  10. 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.

  11. abstract def write(out: DataOutput): Unit

    Permalink
    Definition Classes
    Writable

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 eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  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. def rank(implicit tx: S.Tx): Int

    Permalink

    The rank is the number of dimensions.

  17. def reader(streamDim: Int)(implicit tx: S.Tx, resolver: Resolver[S]): Reader

    Permalink
  18. def reducedDimensions(implicit tx: S.Tx): Vec[Matrix[S]]

    Permalink
  19. def reducedRanges(implicit tx: S.Tx): Vec[Range]

    Permalink
  20. def reducedRank(implicit tx: S.Tx): Int

    Permalink
  21. def reducedShape(implicit tx: S.Tx): Vec[Int]

    Permalink
  22. def size(implicit tx: S.Tx): Long

    Permalink

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

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

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

    Permalink
    Definition Classes
    Obj → AnyRef → Any
  25. final def tpe: Type

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

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

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

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

Inherited from Obj[S]

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

Inherited from Identifiable[S.ID]

Inherited from Elem[S]

Inherited from Publisher[S, Update[S]]

Inherited from Disposable[S.Tx]

Inherited from Writable

Inherited from AnyRef

Inherited from Any

Ungrouped