Packages

class HMatrix3[T] extends Error

The HMatrix3 class is a simple implementation of a 3-dimensional hypermatrix. 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. Caveat: currently this is a very limited implementation of hypermatrices. -----------------------------------------------------------------------------

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

Instance Constructors

  1. new HMatrix3(dim1: Int, dim2: Int, dims3: Array[Int])(implicit arg0: ClassTag[T], arg1: Numeric[T])

    Construct a 3-dimensional hypermatrix, where the 3rd dimension varies only with the 2nd dimension.

    Construct a 3-dimensional hypermatrix, where the 3rd dimension varies only with the 2nd dimension.

    dim1

    size of the 1st dimension of the hypermatrix

    dim2

    size of the 2nd dimension of the hypermatrix

    dims3

    array of sizes of the 3rd dimension of the hypermatrix

  2. new HMatrix3(dim1: Int, dim2: Int, dim3: Int)(implicit arg0: ClassTag[T], arg1: Numeric[T])

    Construct a cuboidic 3-dimensional hypermatrix, where the 3rd dimension is fixed as well.

    Construct a cuboidic 3-dimensional hypermatrix, where the 3rd dimension is fixed as well.

    dim1

    size of the 1st dimension of the hypermatrix

    dim2

    size of the 2nd dimension of the hypermatrix

    dim3

    size of the 3rd dimension of the hypermatrix

  3. new HMatrix3(dim1: Int, dim2: Int)(implicit arg0: ClassTag[T], arg1: Numeric[T])

    dim1

    size of the 1st dimension of the hypermatrix

    dim2

    size of the 2nd dimension of the hypermatrix

Value Members

  1. def +(b: HMatrix3[T]): HMatrix3[T]

    Add 'this' hypermatrix and hypermatrix 'b'.

    Add 'this' hypermatrix and hypermatrix 'b'.

    b

    the hypermatrix to add (requires 'leDimensions')

  2. def -(b: HMatrix3[T]): HMatrix3[T]

    From 'this' hypermatrix subtract hypermatrix 'b'.

    From 'this' hypermatrix subtract hypermatrix 'b'.

    b

    the hypermatrix to add (requires 'leDimensions')

  3. def alloc(dims3: Array[Int]): Unit

    Allocate all elements of the 3rd dimension of the hypermatrix, where the last dimension only with the second dimension.

    Allocate all elements of the 3rd dimension of the hypermatrix, where the last dimension only with the second dimension.

    dims3

    array of sizes of the 3rd dimension of the hypermatrix

  4. def alloc(i: Int, j: Int, dim3: Int): Unit

    Allocate one element of the 3rd dimension of the hypermatrix for the specified '(i, j)' indices.

    Allocate one element of the 3rd dimension of the hypermatrix for the specified '(i, j)' indices. Although, this allows the 3rd dimension to vary with both the first and second dimensions, it should only vary with the second dimension.

    i

    1st dimension index of the hypermatrix

    j

    2nd dimension index of the hypermatrix

    dim3

    size of the array to be allocated in row i and column j

  5. def apply(i: Int, j: Int, k: Int): T

    Retrieve a single element of the hypermatrix.

    Retrieve a single element of the hypermatrix.

    i

    1st dimension index of the hypermatrix

    j

    2nd dimension index of the hypermatrix

    k

    3rd dimension index of the hypermatrix

  6. def clear(): Unit

    Clear (make null) all contents in the 3rd dimension of the hypermatrix.

  7. val dim1: Int
  8. val dim2: Int
  9. def dim_3(j: Int): Int

    Return the size of the 3rd dimension for the given 'j'.

    Return the size of the 3rd dimension for the given 'j'. The size of the 3rd dimension must be the same for all 'i'.

    j

    2nd dimension index of the hypermatrix

  10. 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
  11. def leDimensions(b: HMatrix3[T]): Boolean

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

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

    b

    the other matrix

  12. val nu: Numeric[T]

    Import Numeric evidence (gets nu val from superclass)

  13. def set(x: T): Unit

    Set all the hypermatrix element values to 'x'.

    Set all the hypermatrix element values to 'x'.

    x

    the value to set all elements to

  14. def setFormat(newFormat: String): Unit

    Set the format to the 'newFormat'.

    Set the format to the 'newFormat'.

    newFormat

    the new format string

  15. def toString(): String

    Convert 'this' hypermatrix to a string.

    Convert 'this' hypermatrix to a string.

    Definition Classes
    HMatrix3 → AnyRef → Any
  16. def update(i: Int, j: Int, k: Int, v: T): Unit

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

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

    i

    1st dimension index of the hypermatrix

    j

    2nd dimension index of the hypermatrix

    k

    3rd dimension index of the hypermatrix

    v

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