Matrix

Abstract Value Members

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

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

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.
abstract def dispose()(implicit tx: S.Tx): Unit

Definition Classes
Disposable
abstract def getDimensionKey(index: Int, useChannels: Boolean)(implicit tx: S.Tx): Key

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.
abstract def getKey(streamDim: Int)(implicit tx: S.Tx): Key

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.
abstract def id: S.ID

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

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.
abstract def ranges(implicit tx: S.Tx): Vec[Range]

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).
abstract def shape(implicit tx: S.Tx): Vec[Int]

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.
abstract def units(implicit tx: S.Tx): String

The units of the matrix cells, or an empty string to indicate that no units are specified.
abstract def write(out: DataOutput): Unit

Definition Classes
Writable

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def attr(implicit tx: S.Tx): AttrMap[S]

Definition Classes
Obj
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
Identifiable → 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
Identifiable → AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

The rank is the number of dimensions.
def reader(streamDim: Int)(implicit tx: S.Tx, resolver: Resolver[S]): Reader
def reducedDimensions(implicit tx: S.Tx): Vec[Matrix[S]]
def reducedRanges(implicit tx: S.Tx): Vec[Range]
def reducedRank(implicit tx: S.Tx): Int
def reducedShape(implicit tx: S.Tx): Vec[Int]
def size(implicit tx: S.Tx): Long

The size is the number of matrix cells, that is the product of the shape.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Obj → AnyRef → Any
final def tpe: Type

Definition Classes
Matrix → Obj → Elem
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( ... )

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

Abstract Value Members

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

abstract def dimensions(implicit tx: S.Tx): Vec[Matrix[S]]

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

abstract def getDimensionKey(index: Int, useChannels: Boolean)(implicit tx: S.Tx): Key

abstract def getKey(streamDim: Int)(implicit tx: S.Tx): Key

abstract def id: S.ID

abstract def name(implicit tx: S.Tx): String

abstract def ranges(implicit tx: S.Tx): Vec[Range]

abstract def shape(implicit tx: S.Tx): Vec[Int]

abstract def units(implicit tx: S.Tx): String

abstract def write(out: DataOutput): Unit

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

final def attr(implicit tx: S.Tx): AttrMap[S]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def rank(implicit tx: S.Tx): Int

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

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

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

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

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

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

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

def toString(): String

final def tpe: Type

final def wait(): Unit

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

final def wait(arg0: Long): Unit

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