Packages

  • package root
    Definition Classes
    root
  • package scalation

    The scalation package specifies system-wide constants for directory paths.

    The scalation package specifies system-wide constants for directory paths. Sub-packages may wish to define 'BASE-DIR = DATA_DIR + ⁄ + <package>' in their own 'package.scala' files. For maintainability, directory paths should only be specified in 'package.scala' files.

    Definition Classes
    root
  • package tenalgebra
    Definition Classes
    scalation
  • Tensor3D
  • Tensor3DTest

class Tensor3D extends Error with Serializable

The Tensor3D class is a simple implementation of a 3-dimensional tensor. The first two dimensions must be fixed and known, while the third dimension may be dynamically allocated by the user. The third dimension should only vary with the second dimension, not the first. -----------------------------------------------------------------------------

Linear Supertypes
Serializable, Serializable, Error, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tensor3D
  2. Serializable
  3. Serializable
  4. Error
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Tensor3D(dim1: Int, dim2: Int, dim3: Int, v: Array[Array[Array[Double]]] = null)

    dim1

    size of the 1st level/dimension (sheet) of the tensor

    dim2

    size of the 2nd level/dimension (row) of the tensor

    dim3

    size of the 3rd level/dimension (column) of the tensor

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def *(b: MatrixD, c: MatrixD, d: MatrixD): Tensor3D

    Multiply (multilinear product) 'this' tensor by three matrices 'b', 'c' and 'd'.

    Multiply (multilinear product) 'this' tensor by three matrices 'b', 'c' and 'd'.

    this * (a, b, c)

    b

    the first matrix to multiply by (requires 'leDimensions')

    c

    the second matrix to multiply by (requires 'leDimensions')

    d

    the thrid matrix to multiply by (requires 'leDimensions')

    See also

    www.stat.uchicago.edu/~lekheng/work/icm1.pdf - equation 15.1

  4. def *(s: Double): Tensor3D

    Multiply 'this' tensor by scalar 's'.

    Multiply 'this' tensor by scalar 's'.

    s

    the scalar to multiply by

  5. def **(b: Tensor3D): Tensor3D

    Multiply elementwise (Hadamard product) 'this' tensor by tensor 'b'.

    Multiply elementwise (Hadamard product) 'this' tensor by tensor 'b'.

    b

    the tensor to add (requires 'leDimensions')

  6. def +(b: Tensor3D): Tensor3D

    Add 'this' tensor and tensor 'b'.

    Add 'this' tensor and tensor 'b'.

    b

    the tensor to add (requires 'leDimensions')

  7. def -(b: Tensor3D): Tensor3D

    From 'this' tensor subtract tensor 'b'.

    From 'this' tensor subtract tensor 'b'.

    b

    the tensor to add (requires 'leDimensions')

  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def apply(i: Int): MatriD

    Retrieve the 'i' matrix from the tensor.

    Retrieve the 'i' matrix from the tensor.

    i

    1st dimension index of the tensor

  10. def apply(i: Int, j: Int): VectoD

    Retrieve the 'i, j' vector from the tensor.

    Retrieve the 'i, j' vector from the tensor.

    i

    1st dimension index of the tensor

    j

    2nd dimension index of the tensor

  11. def apply(i: Int, j: Int, k: Int): Double

    Retrieve the 'i, j, k' element from the tensor.

    Retrieve the 'i, j, k' element from the tensor.

    i

    1st dimension (sheet) index of the tensor

    j

    2nd dimension (row) index of the tensor

    k

    3rd dimension (column) index of the tensor

  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  14. val dim1: Int
  15. val dim2: Int
  16. val dim3: Int
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. var fString: String

    Format string used for printing vector values (change using 'setFormat')

    Format string used for printing vector values (change using 'setFormat')

    Attributes
    protected
  20. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def flaw(method: String, message: String): Unit

    Show the flaw by printing the error message.

    Show the flaw by printing the error message.

    method

    the method where the error occurred

    message

    the error message

    Definition Classes
    Error
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def leDimensions(b: Tensor3D): Boolean

    Check whether the dimensions of 'this' tensor are less than or equal to 'le' those of the other tensor 'b'.

    Check whether the dimensions of 'this' tensor are less than or equal to 'le' those of the other tensor 'b'.

    b

    the other matrix

  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def set(x: Double): Unit

    Set all the tensor element values to 'x'.

    Set all the tensor element values to 'x'.

    x

    the value to set all elements to

  30. def setFormat(newFormat: String): Unit

    Set the format to the 'newFormat'.

    Set the format to the 'newFormat'.

    newFormat

    the new format string

  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String

    Convert 'this' tensor to a string with a double line break after each sheet and a single line break after each row.

    Convert 'this' tensor to a string with a double line break after each sheet and a single line break after each row.

    Definition Classes
    Tensor3D → AnyRef → Any
  33. def toString2: String

    Convert 'this' tensor to a string with a line break after each sheet.

  34. def update(i: Int, j: Int, k: Int, x: Double): Unit

    Update a single element of the tensor to the given value.

    Update a single element of the tensor to the given value.

    i

    1st dimension index of the tensor

    j

    2nd dimension index of the tensor

    k

    3rd dimension index of the tensor

    x

    the value to be updated at the above position in the tensor

  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Error

Inherited from AnyRef

Inherited from Any

Ungrouped