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 linalgebra

    The linalgebra package contains classes, traits and objects for linear algebra, including vectors and matrices for real and complex numbers.

    The linalgebra package contains classes, traits and objects for linear algebra, including vectors and matrices for real and complex numbers.

    Definition Classes
    scalation
  • package par

    The par package contains classes, traits and objects for parallel linear algebra, including vectors and matrices for real and complex numbers.

    The par package contains classes, traits and objects for parallel linear algebra, including vectors and matrices for real and complex numbers.

    Definition Classes
    linalgebra
  • Fac_Cholesky
  • Fac_CholeskyTest
  • Fac_QR
  • Fac_QRTest
  • MatrixD
  • MatrixDTest
  • SparseMatrixD
  • SparseMatrixDTest
  • VectorD
  • VectorDTest

class MatrixD extends MatriD with Error with Serializable

The MatrixD class stores and operates parallel on Numeric Matrices of type Double. This class follows the MatrixN framework and is provided for efficiency. This class is only efficient when the dimension is large.

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

Instance Constructors

  1. new MatrixD(u: MatrixD)

    Construct a matrix and assign values from matrix u.

    Construct a matrix and assign values from matrix u.

    u

    the matrix of values to assign

  2. new MatrixD(u: Array[VectorD])

    Construct a matrix and assign values from array of vectors u.

    Construct a matrix and assign values from array of vectors u.

    u

    the 2D array of values to assign

  3. new MatrixD(dim: (Int, Int), u: Double*)

    Construct a matrix from repeated values.

    Construct a matrix from repeated values.

    dim

    the (row, column) dimensions

    u

    the repeated values

  4. new MatrixD(u: Array[Array[Double]])

    Construct a matrix and assign values from array of arrays u.

    Construct a matrix and assign values from array of arrays u.

    u

    the 2D array of values to assign

  5. new MatrixD(dim1: Int, dim2: Int, x: Double)

    Construct a dim1 by dim2 matrix and assign each element the value x.

    Construct a dim1 by dim2 matrix and assign each element the value x.

    dim1

    the row dimension

    dim2

    the column dimesion

    x

    the scalar value to assign

  6. new MatrixD(dim1: Int)

    Construct a dim1 by dim1 square matrix.

    Construct a dim1 by dim1 square matrix.

    dim1

    the row and column dimension

  7. new MatrixD(d1: Int, d2: Int, v: Array[Array[Double]] = null)

    d1

    the first/row dimension

    d2

    the second/column dimension

    v

    the 2D array used to store matrix elements

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def *(x: Double): MatrixD

    Multiply this matrix by scalar x.

    Multiply this matrix by scalar x.

    x

    the scalar to multiply by

    Definition Classes
    MatrixDMatriD
  4. def *(u: VectoD): VectorD

    Multiply this matrix by vector u.

    Multiply this matrix by vector u.

    u

    the vector to multiply by

    Definition Classes
    MatrixDMatriD
  5. def *(b: MatriD): MatrixD

    Multiply this matrix by matrix b, transposing b to improve performance.

    Multiply this matrix by matrix b, transposing b to improve performance. Use 'times' method to skip the transpose.

    b

    the matrix to multiply by (requires sameCrossDimensions)

    Definition Classes
    MatrixDMatriD
  6. def *(b: MatrixD): MatrixD

    Multiply this matrix by matrix b, transposing b to improve performance.

    Multiply this matrix by matrix b, transposing b to improve performance. Use 'times' method to skip the transpose.

    b

    the matrix to multiply by (requires sameCrossDimensions)

  7. def **(u: VectoD): MatrixD

    Multiply this matrix by vector u to produce another matrix (a_ij * u_j)

    Multiply this matrix by vector u to produce another matrix (a_ij * u_j)

    u

    the vector to multiply by

    Definition Classes
    MatrixDMatriD
  8. def **(b: MatriD): MatriD

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

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

    b

    the matrix to multiply by

    Definition Classes
    MatriD
    See also

    en.wikipedia.org/wiki/Hadamard_product_(matrices) FIX - remove ??? and implement in all implementing classes

  9. def **:(u: VectoD): MatrixD

    Multiply vector 'u' by 'this' matrix to produce another matrix 'u_i * a_ij'.

    Multiply vector 'u' by 'this' matrix to produce another matrix 'u_i * a_ij'. E.g., multiply a diagonal matrix represented as a vector by a matrix. This operator is right associative.

    u

    the vector to multiply by

    Definition Classes
    MatrixDMatriD
  10. def **=(u: VectoD): MatrixD

    Multiply in-place this matrix by vector u to produce another matrix (a_ij * u_j)

    Multiply in-place this matrix by vector u to produce another matrix (a_ij * u_j)

    u

    the vector to multiply by

    Definition Classes
    MatrixDMatriD
  11. def *:(u: VectoD): VectoD

    Multiply (row) vector 'u' by 'this' matrix.

    Multiply (row) vector 'u' by 'this' matrix. Note '*:' is right associative. vector = vector *: matrix

    u

    the vector to multiply by

    Definition Classes
    MatriD
  12. def *=(x: Double): MatrixD

    Multiply in-place this matrix by scalar x.

    Multiply in-place this matrix by scalar x.

    x

    the scalar to multiply by

    Definition Classes
    MatrixDMatriD
  13. def *=(b: MatriD): MatrixD

    Multiply in-place this matrix by matrix b, transposing b to improve efficiency.

    Multiply in-place this matrix by matrix b, transposing b to improve efficiency. Use 'times_ip' method to skip the transpose step.

    b

    the matrix to multiply by (requires square and sameCrossDimensions)

    Definition Classes
    MatrixDMatriD
  14. def *=(b: MatrixD): MatrixD

    Multiply in-place this matrix by matrix b, transposing b to improve efficiency.

    Multiply in-place this matrix by matrix b, transposing b to improve efficiency. Use 'times_ip' method to skip the transpose step.

    b

    the matrix to multiply by (requires square and sameCrossDimensions)

  15. def +(x: Double): MatrixD

    Add this matrix and scalar x.

    Add this matrix and scalar x.

    x

    the scalar to add

    Definition Classes
    MatrixDMatriD
  16. def +(u: VectoD): MatrixD

    Add this matrix and (row) vector u.

    Add this matrix and (row) vector u.

    u

    the vector to add

    Definition Classes
    MatrixDMatriD
  17. def +(b: MatriD): MatrixD

    Add 'this' matrix and matrix 'b' for any subtype of MatriD.

    Add 'this' matrix and matrix 'b' for any subtype of MatriD.

    b

    the matrix to add (requires leDimensions)

    Definition Classes
    MatrixDMatriD
  18. def +(b: MatrixD): MatrixD

    Add 'this' matrix and matrix 'b'.

    Add 'this' matrix and matrix 'b'.

    b

    the matrix to add (requires leDimensions)

  19. def ++(b: MatriD): MatrixD

    Concatenate (row-wise) 'this' matrix and matrix 'b'.

    Concatenate (row-wise) 'this' matrix and matrix 'b'.

    b

    the matrix to be concatenated as the new last rows in new matrix

    Definition Classes
    MatrixDMatriD
  20. def ++^(b: MatriD): MatrixD

    Concatenate (column-wise) 'this' matrix and matrix 'b'.

    Concatenate (column-wise) 'this' matrix and matrix 'b'.

    b

    the matrix to be concatenated as the new last columns in new matrix

    Definition Classes
    MatrixDMatriD
  21. def +:(u: VectoD): MatrixD

    Concatenate (row) vector 'u' and 'this' matrix, i.e., prepend 'u' to 'this'.

    Concatenate (row) vector 'u' and 'this' matrix, i.e., prepend 'u' to 'this'.

    u

    the vector to be prepended as the new first row in new matrix

    Definition Classes
    MatrixDMatriD
  22. def +=(x: Double): MatrixD

    Add in-place this matrix and scalar x.

    Add in-place this matrix and scalar x.

    x

    the scalar to add

    Definition Classes
    MatrixDMatriD
  23. def +=(u: VectoD): MatrixD

    Add in-place this matrix and (row) vector u.

    Add in-place this matrix and (row) vector u.

    u

    the vector to add

    Definition Classes
    MatrixDMatriD
  24. def +=(b: MatriD): MatrixD

    Add in-place this matrix and matrix b for any subtype of MatriD.

    Add in-place this matrix and matrix b for any subtype of MatriD.

    b

    the matrix to add (requires leDimensions)

    Definition Classes
    MatrixDMatriD
  25. def +=(b: MatrixD): MatrixD

    Add in-place this matrix and matrix b.

    Add in-place this matrix and matrix b.

    b

    the matrix to add (requires leDimensions)

  26. def +^:(u: VectoD): MatrixD

    Concatenate (column) vector 'u' and 'this' matrix, i.e., prepend 'u' to 'this'.

    Concatenate (column) vector 'u' and 'this' matrix, i.e., prepend 'u' to 'this'.

    u

    the vector to be prepended as the new first column in new matrix

    Definition Classes
    MatrixDMatriD
  27. def -(x: Double): MatrixD

    From this matrix subtract scalar x.

    From this matrix subtract scalar x.

    x

    the scalar to subtract

    Definition Classes
    MatrixDMatriD
  28. def -(u: VectoD): MatrixD

    From this matrix subtract (row) vector u.

    From this matrix subtract (row) vector u.

    u

    the vector to add

    Definition Classes
    MatrixDMatriD
  29. def -(b: MatriD): MatrixD

    From 'this' matrix subtract matrix 'b' for any subtype of MatriD.

    From 'this' matrix subtract matrix 'b' for any subtype of MatriD.

    b

    the matrix to add (requires leDimensions)

    Definition Classes
    MatrixDMatriD
  30. def -(b: MatrixD): MatrixD

    From this matrix subtract matrix b.

    From this matrix subtract matrix b.

    b

    the matrix to subtract (requires leDimensions)

  31. def -=(x: Double): MatrixD

    From this matrix subtract in-place scalar x.

    From this matrix subtract in-place scalar x.

    x

    the scalar to subtract

    Definition Classes
    MatrixDMatriD
  32. def -=(u: VectoD): MatrixD

    From this matrix subtract in-place (row) vector u.

    From this matrix subtract in-place (row) vector u.

    u

    the vector to add

    Definition Classes
    MatrixDMatriD
  33. def -=(b: MatriD): MatrixD

    From this matrix subtract in-place matrix b for any subtype of MatriD.

    From this matrix subtract in-place matrix b for any subtype of MatriD.

    b

    the matrix to subtract (requires leDimensions)

    Definition Classes
    MatrixDMatriD
  34. def -=(b: MatrixD): MatrixD

    From this matrix subtract in-place matrix b.

    From this matrix subtract in-place matrix b.

    b

    the matrix to subtract (requires leDimensions)

  35. def /(x: Double): MatrixD

    Divide this matrix by scalar x.

    Divide this matrix by scalar x.

    x

    the scalar to divide by

    Definition Classes
    MatrixDMatriD
  36. def /=(x: Double): MatrixD

    Divide in-place this matrix by scalar x.

    Divide in-place this matrix by scalar x.

    x

    the scalar to divide by

    Definition Classes
    MatrixDMatriD
  37. def :+(u: VectoD): MatrixD

    Concatenate 'this' matrix and (row) vector 'u', i.e., append 'u' to 'this'.

    Concatenate 'this' matrix and (row) vector 'u', i.e., append 'u' to 'this'.

    u

    the vector to be appended as the new last row in new matrix

    Definition Classes
    MatrixDMatriD
  38. def :^+(u: VectoD): MatrixD

    Concatenate 'this' matrix and (column) vector 'u', i.e., append 'u' to 'this'.

    Concatenate 'this' matrix and (column) vector 'u', i.e., append 'u' to 'this'.

    u

    the vector to be appended as the new last column in new matrix

    Definition Classes
    MatrixDMatriD
  39. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  40. def apply(ir: Range, jr: Range): MatrixD

    Get a slice this matrix row-wise on range ir and column-wise on range jr.

    Get a slice this matrix row-wise on range ir and column-wise on range jr. Ex: b = a(2..4, 3..5)

    ir

    the row range

    jr

    the column range

    Definition Classes
    MatrixDMatriD
  41. def apply(i: Int): VectorD

    Get this matrix's vector at the i-th index position (i-th row).

    Get this matrix's vector at the i-th index position (i-th row).

    i

    the row index

    Definition Classes
    MatrixDMatriD
  42. def apply(i: Int, j: Int): Double

    Get this matrix's element at the i,j-th index position.

    Get this matrix's element at the i,j-th index position.

    i

    the row index

    j

    the column index

    Definition Classes
    MatrixDMatriD
  43. def apply(iv: VectoI): MatriD

    Get the rows indicated by the index vector 'iv' FIX - implement in all implementing classes

    Get the rows indicated by the index vector 'iv' FIX - implement in all implementing classes

    iv

    the vector of row indices

    Definition Classes
    MatriD
  44. def apply(i: Int, jr: Range): VectoD

    Get a slice 'this' matrix row-wise at index 'i' and column-wise on range 'jr'.

    Get a slice 'this' matrix row-wise at index 'i' and column-wise on range 'jr'. Ex: u = a(2, 3..5)

    i

    the row index

    jr

    the column range

    Definition Classes
    MatriD
  45. def apply(ir: Range, j: Int): VectoD

    Get a slice 'this' matrix row-wise on range 'ir' and column-wise at index j.

    Get a slice 'this' matrix row-wise on range 'ir' and column-wise at index j. Ex: u = a(2..4, 3)

    ir

    the row range

    j

    the column index

    Definition Classes
    MatriD
  46. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  47. def bsolve(y: VectoD): VectorD

    Solve for 'x' using back substitution in the equation 'u*x = y' where 'this' matrix ('u') is upper triangular (see 'lud_npp' above).

    Solve for 'x' using back substitution in the equation 'u*x = y' where 'this' matrix ('u') is upper triangular (see 'lud_npp' above).

    y

    the constant vector

    Definition Classes
    MatrixDMatriD
  48. def clean(thres: Double, relative: Boolean = true): MatrixD

    Clean values in matrix at or below the threshold by setting them to zero.

    Clean values in matrix at or below the threshold by setting them to zero. Iterative algorithms give approximate values and if very close to zero, may throw off other calculations, e.g., in computing eigenvectors.

    thres

    the cutoff threshold (a small value)

    relative

    whether to use relative or absolute cutoff

    Definition Classes
    MatrixDMatriD
  49. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  50. def col(col: Int, from: Int = 0): VectorD

    Get column 'col' from the matrix, returning it as a vector.

    Get column 'col' from the matrix, returning it as a vector.

    col

    the column to extract from the matrix

    from

    the position to start extracting from

    Definition Classes
    MatrixDMatriD
  51. def copy(): MatriD

    Create an exact copy of 'this' m-by-n matrix.

    Create an exact copy of 'this' m-by-n matrix.

    Definition Classes
    MatrixDMatriD
  52. val d1: Int
  53. val d2: Int
  54. def det: Double

    Compute the determinant of this matrix.

    Compute the determinant of this matrix. The value of the determinant indicates, among other things, whether there is a unique solution to a system of linear equations (a nonzero determinant).

    Definition Classes
    MatrixDMatriD
  55. def diag(p: Int, q: Int): MatrixD

    Form a matrix [Ip, this, Iq] where Ir is a r by r identity matrix, by positioning the three matrices Ip, this and Iq along the diagonal.

    Form a matrix [Ip, this, Iq] where Ir is a r by r identity matrix, by positioning the three matrices Ip, this and Iq along the diagonal.

    p

    the size of identity matrix Ip

    q

    the size of identity matrix Iq

    Definition Classes
    MatrixDMatriD
  56. def diag(p: Int): MatrixD

    Form a matrix [Ip, this] where Ip is a p by p identity matrix, by positioning the two matrices Ip and this along the diagonal.

    Form a matrix [Ip, this] where Ip is a p by p identity matrix, by positioning the two matrices Ip and this along the diagonal. Fill the rest of matrix with zeros.

    p

    the size of identity matrix Ip

  57. def diag(b: MatriD): MatrixD

    Combine this matrix with matrix b, placing them along the diagonal and filling in the bottom left and top right regions with zeros; [this, b].

    Combine this matrix with matrix b, placing them along the diagonal and filling in the bottom left and top right regions with zeros; [this, b].

    b

    the matrix to combine with this matrix

    Definition Classes
    MatrixDMatriD
  58. lazy val dim1: Int

    Dimension 1

    Dimension 1

    Definition Classes
    MatrixDMatriD
  59. lazy val dim2: Int

    Dimension 2

    Dimension 2

    Definition Classes
    MatrixDMatriD
  60. def dot(u: VectoD): VectorD

    Compute the dot product of 'this' matrix and vector 'u', by first transposing 'this' matrix and then multiplying by 'u' (ie., 'a dot u = a.t * u').

    Compute the dot product of 'this' matrix and vector 'u', by first transposing 'this' matrix and then multiplying by 'u' (ie., 'a dot u = a.t * u').

    u

    the vector to multiply by (requires same first dimensions)

    Definition Classes
    MatrixDMatriD
  61. def dot(b: MatrixD): MatrixD

    Compute the dot product of 'this' matrix and matrix 'b', by first transposing 'this' matrix and then multiplying by 'b' (ie., 'a dot b = a.t * b').

    Compute the dot product of 'this' matrix and matrix 'b', by first transposing 'this' matrix and then multiplying by 'b' (ie., 'a dot b = a.t * b').

    b

    the matrix to multiply by (requires same first dimensions)

  62. def dot(b: MatriD): VectoD

    Compute the dot product of 'this' matrix and matrix 'b' that results in a vector, by taking the dot product for each column 'j' of both matrices.

    Compute the dot product of 'this' matrix and matrix 'b' that results in a vector, by taking the dot product for each column 'j' of both matrices.

    b

    the matrix to multiply by (requires same first dimensions)

    Definition Classes
    MatrixDMatriD
    See also

    www.mathworks.com/help/matlab/ref/dot.html

  63. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  64. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  65. val fString: String

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

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

    Attributes
    protected
    Definition Classes
    MatriD
  66. def flatten: VectoD

    Flatten 'this' matrix in row-major fashion, returning a vector containing all the elements from the matrix.

    Flatten 'this' matrix in row-major fashion, returning a vector containing all the elements from the matrix.

    Definition Classes
    MatriD
  67. 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
  68. def foreach[U](f: (Array[Double]) ⇒ U): Unit

    Iterate over 'this' matrix row by row applying method 'f'.

    Iterate over 'this' matrix row by row applying method 'f'.

    f

    the function to apply

    Definition Classes
    MatriD
  69. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  70. def getDiag(k: Int = 0): VectorD

    Get the kth diagonal of this matrix.

    Get the kth diagonal of this matrix. Assumes dim2 >= dim1.

    k

    how far above the main diagonal, e.g., (-1, 0, 1) for (sub, main, super)

    Definition Classes
    MatrixDMatriD
  71. val granularity: Int
  72. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  73. def inverse: MatrixD

    Invert this matrix (requires a squareMatrix) and use partial pivoting.

    Invert this matrix (requires a squareMatrix) and use partial pivoting.

    Definition Classes
    MatrixDMatriD
  74. def inverse_ip(): MatrixD

    Invert in-place this matrix (requires a squareMatrix) and uses partial pivoting.

    Invert in-place this matrix (requires a squareMatrix) and uses partial pivoting.

    Definition Classes
    MatrixDMatriD
  75. def inverse_npp: MatrixD

    Invert this matrix (requires a squareMatrix) and does not use partial pivoting.

  76. def isBidiagonal: Boolean

    Check whether 'this' matrix is bidiagonal (has non-zero elements only in main diagonal and super-diagonal).

    Check whether 'this' matrix is bidiagonal (has non-zero elements only in main diagonal and super-diagonal). The method may be overriding for efficiency.

    Definition Classes
    MatriD
  77. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  78. def isNonnegative: Boolean

    Check whether 'this' matrix is nonnegative (has no negative elements).

    Check whether 'this' matrix is nonnegative (has no negative elements).

    Definition Classes
    MatriD
  79. def isRectangular: Boolean

    Check whether this matrix is rectangular (all rows have the same number of columns).

    Check whether this matrix is rectangular (all rows have the same number of columns).

    Definition Classes
    MatrixDMatriD
  80. def isSquare: Boolean

    Check whether 'this' matrix is square (same row and column dimensions).

    Check whether 'this' matrix is square (same row and column dimensions).

    Definition Classes
    MatriD
  81. def isSymmetric: Boolean

    Check whether 'this' matrix is symmetric.

    Check whether 'this' matrix is symmetric.

    Definition Classes
    MatriD
  82. def isTridiagonal: Boolean

    Check whether 'this' matrix is bidiagonal (has non-zero elements only in main diagonal and super-diagonal).

    Check whether 'this' matrix is bidiagonal (has non-zero elements only in main diagonal and super-diagonal). The method may be overriding for efficiency.

    Definition Classes
    MatriD
  83. def leDimensions(b: MatriD): Boolean

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

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

    b

    the other matrix

    Definition Classes
    MatriD
  84. def lowerT: MatriD

    Return the lower triangular of 'this' matrix (rest are zero).

    Return the lower triangular of 'this' matrix (rest are zero).

    Definition Classes
    MatrixDMatriD
  85. def lud_ip(): (MatrixD, MatrixD)

    Decompose in-place this matrix into the product of lower and upper triangular matrices (l, u) using an LU Decomposition algorithm.

    Decompose in-place this matrix into the product of lower and upper triangular matrices (l, u) using an LU Decomposition algorithm.

    Definition Classes
    MatrixDMatriD
  86. def lud_npp: (MatrixD, MatrixD)

    Decompose this matrix into the product of upper and lower triangular matrices (l, u) using an LU Decomposition algorithm.

    Decompose this matrix into the product of upper and lower triangular matrices (l, u) using an LU Decomposition algorithm.

    Definition Classes
    MatrixDMatriD
  87. def mag: Double

    Find the magnitude of 'this' matrix, the element value farthest from zero.

    Find the magnitude of 'this' matrix, the element value farthest from zero.

    Definition Classes
    MatriD
  88. def map(f: (VectoD) ⇒ VectoD): MatriD

    Map the elements of 'this' matrix by applying the mapping function 'f'.

    Map the elements of 'this' matrix by applying the mapping function 'f'. FIX - remove ??? and implement in all implementing classes

    f

    the function to apply

    Definition Classes
    MatriD
  89. def max(e: Int = dim1): Double

    Find the maximum element in this matrix.

    Find the maximum element in this matrix.

    e

    the ending row index (exclusive) for the search

    Definition Classes
    MatrixDMatriD
  90. def mdot(b: MatriD): MatriD

    Compute the matrix dot product of 'this' matrix and matrix 'b', by first transposing 'this' matrix and then multiplying by 'b' (i.e., 'a dot b = a.t * b').

    Compute the matrix dot product of 'this' matrix and matrix 'b', by first transposing 'this' matrix and then multiplying by 'b' (i.e., 'a dot b = a.t * b').

    b

    the matrix to multiply by (requires same first dimensions)

    Definition Classes
    MatrixDMatriD
  91. def mean: VectoD

    Compute the column means of 'this' matrix.

    Compute the column means of 'this' matrix.

    Definition Classes
    MatriD
  92. def meanNZ: VectoD

    Compute the column means of 'this' matrix ignoring zero elements (e.g., a zero may indicate a missing value as in recommender systems).

    Compute the column means of 'this' matrix ignoring zero elements (e.g., a zero may indicate a missing value as in recommender systems).

    Definition Classes
    MatriD
  93. def meanR: VectoD

    Compute the row means of 'this' matrix.

    Compute the row means of 'this' matrix.

    Definition Classes
    MatriD
  94. def meanRNZ: VectoD

    Compute the row means of 'this' matrix ignoring zero elements (e.g., a zero may indicate a missing value as in recommender systems).

    Compute the row means of 'this' matrix ignoring zero elements (e.g., a zero may indicate a missing value as in recommender systems).

    Definition Classes
    MatriD
  95. def min(e: Int = dim1): Double

    Find the minimum element in this matrix.

    Find the minimum element in this matrix.

    e

    the ending row index (exclusive) for the search

    Definition Classes
    MatrixDMatriD
  96. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  97. def norm1: Double

    Compute the 1-norm of 'this' matrix, i.e., the maximum 1-norm of the column vectors.

    Compute the 1-norm of 'this' matrix, i.e., the maximum 1-norm of the column vectors. This is useful for comparing matrices '(a - b).norm1'.

    Definition Classes
    MatriD
    See also

    en.wikipedia.org/wiki/Matrix_norm

  98. def normF: Double

    Compute the Frobenius-norm of 'this' matrix, i.e., the square root of the sum of the squared values over all the elements (sqrt (sse)).

    Compute the Frobenius-norm of 'this' matrix, i.e., the square root of the sum of the squared values over all the elements (sqrt (sse)). FIX: for MatriC should take absolute values, first.

    Definition Classes
    MatriD
    See also

    en.wikipedia.org/wiki/Matrix_norm#Frobenius_norm

  99. def normFSq: Double

    Compute the sqaure of the Frobenius-norm of 'this' matrix, i.e., the sum of the squared values over all the elements (sse).

    Compute the sqaure of the Frobenius-norm of 'this' matrix, i.e., the sum of the squared values over all the elements (sse). FIX: for MatriC should take absolute values, first.

    Definition Classes
    MatriD
    See also

    en.wikipedia.org/wiki/Matrix_norm#Frobenius_norm

  100. def normINF: Double

    Compute the (infinity) INF-norm of 'this' matrix, i.e., the maximum 1-norm of the row vectors.

    Compute the (infinity) INF-norm of 'this' matrix, i.e., the maximum 1-norm of the row vectors.

    Definition Classes
    MatriD
    See also

    en.wikipedia.org/wiki/Matrix_norm

  101. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  102. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  103. def nullspace: VectorD

    Compute the (right) nullspace of this m by n matrix (requires n = m + 1) by performing Gauss-Jordan reduction and extracting the negation of the last column augmented by 1.

    Compute the (right) nullspace of this m by n matrix (requires n = m + 1) by performing Gauss-Jordan reduction and extracting the negation of the last column augmented by 1. The nullspace of matrix a is "this vector v times any scalar s", i.e., a*(v*s) = 0. The left nullspace of matrix a is the same as the right nullspace of a.t (a transpose).

    Definition Classes
    MatrixDMatriD
  104. def nullspace_ip(): VectorD

    Compute the (right) nullspace in-place of this m by n matrix (requires n = m + 1) by performing Gauss-Jordan reduction and extracting the negation of the last column augmented by 1.

    Compute the (right) nullspace in-place of this m by n matrix (requires n = m + 1) by performing Gauss-Jordan reduction and extracting the negation of the last column augmented by 1. The nullspace of matrix a is "this vector v times any scalar s", i.e., a*(v*s) = 0. The left nullspace of matrix a is the same as the right nullspace of a.t (a transpose).

    Definition Classes
    MatrixDMatriD
  105. val range1: Range

    Range for the storage array on dimension 1 (rows)

    Range for the storage array on dimension 1 (rows)

    Definition Classes
    MatriD
  106. val range2: Range

    Range for the storage array on dimension 2 (columns)

    Range for the storage array on dimension 2 (columns)

    Definition Classes
    MatriD
  107. def reduce: MatrixD

    Use Gauss-Jordan reduction on this matrix to make the left part embed an identity matrix.

    Use Gauss-Jordan reduction on this matrix to make the left part embed an identity matrix. A constraint on this m by n matrix is that n >= m.

    Definition Classes
    MatrixDMatriD
  108. def reduce_ip(): Unit

    Use Gauss-Jordan reduction in-place on this matrix to make the left part embed an identity matrix.

    Use Gauss-Jordan reduction in-place on this matrix to make the left part embed an identity matrix. A constraint on this m by n matrix is that n >= m.

    Definition Classes
    MatrixDMatriD
  109. def sameCrossDimensions(b: MatriD): Boolean

    Check whether 'this' matrix and the other matrix 'b' have the same cross dimensions.

    Check whether 'this' matrix and the other matrix 'b' have the same cross dimensions.

    b

    the other matrix

    Definition Classes
    MatriD
  110. def sameDimensions(b: MatriD): Boolean

    Check whether 'this' matrix and the other matrix 'b' have the same dimensions.

    Check whether 'this' matrix and the other matrix 'b' have the same dimensions.

    b

    the other matrix

    Definition Classes
    MatriD
  111. def selectCols(colIndex: Array[Int]): MatrixD

    Select columns from this matrix according to the given index/basis.

    Select columns from this matrix according to the given index/basis. Ex: Can be used to divide a matrix into a basis and a non-basis.

    colIndex

    the column index positions (e.g., (0, 2, 5))

    Definition Classes
    MatrixDMatriD
  112. def selectRows(rowIndex: Array[Int]): MatrixD

    Select rows from this matrix according to the given index/basis.

    Select rows from this matrix according to the given index/basis.

    rowIndex

    the row index positions (e.g., (0, 2, 5))

    Definition Classes
    MatrixDMatriD
  113. def selectRows(rowIndex: VectoI): MatriD

    Select rows from 'this' matrix according to the given index/basis 'rowIndex'.

    Select rows from 'this' matrix according to the given index/basis 'rowIndex'.

    rowIndex

    the row index positions (e.g., (0, 2, 5))

    Definition Classes
    MatriD
  114. def selectRowsEx(rowIndex: VectoI): MatriD

    Select all rows from 'this' matrix excluding the rows from the given 'rowIndex'.

    Select all rows from 'this' matrix excluding the rows from the given 'rowIndex'.

    rowIndex

    the row indices to exclude

    Definition Classes
    MatriD
  115. def selectRowsEx(rowIndex: Array[Int]): MatriD

    Select all rows from 'this' matrix excluding the rows from the given 'rowIndex'.

    Select all rows from 'this' matrix excluding the rows from the given 'rowIndex'.

    rowIndex

    the row indices to exclude

    Definition Classes
    MatriD
  116. def set(i: Int, u: VectoD, j: Int = 0): Unit

    Set this matrix's ith row starting at column j to the vector u.

    Set this matrix's ith row starting at column j to the vector u.

    i

    the row index

    u

    the vector value to assign

    j

    the starting column index

    Definition Classes
    MatrixDMatriD
  117. def set(u: MatriD): Unit

    Set the values in 'this' matrix as copies of the values in matrix 'u'.

    Set the values in 'this' matrix as copies of the values in matrix 'u'.

    u

    the matrix of values to assign

    Definition Classes
    MatrixDMatriD
  118. def set(u: Array[Array[Double]]): Unit

    Set all the values in this matrix as copies of the values in 2D array u.

    Set all the values in this matrix as copies of the values in 2D array u.

    u

    the 2D array of values to assign

    Definition Classes
    MatrixDMatriD
  119. def set(x: Double): Unit

    Set all the elements in this matrix to the scalar x.

    Set all the elements in this matrix to the scalar x.

    x

    the scalar value to assign

    Definition Classes
    MatrixDMatriD
  120. def setCol(col: Int, u: VectoD): Unit

    Set column 'col' of the matrix to a vector.

    Set column 'col' of the matrix to a vector.

    col

    the column to set

    u

    the vector to assign to the column

    Definition Classes
    MatrixDMatriD
  121. def setDiag(x: Double): Unit

    Set the main diagonal of this matrix to the scalar x.

    Set the main diagonal of this matrix to the scalar x. Assumes dim2 >= dim1.

    x

    the scalar to set the diagonal to

    Definition Classes
    MatrixDMatriD
  122. def setDiag(u: VectoD, k: Int = 0): Unit

    Set the kth diagonal of this matrix to the vector u.

    Set the kth diagonal of this matrix to the vector u. Assumes dim2 >= dim1.

    u

    the vector to set the diagonal to

    k

    how far above the main diagonal, e.g., (-1, 0, 1) for (sub, main, super)

    Definition Classes
    MatrixDMatriD
  123. def setFormat(newFormat: String): Unit

    Set the format to the 'newFormat'.

    Set the format to the 'newFormat'.

    newFormat

    the new format string

    Definition Classes
    MatriD
  124. def slice(r_from: Int, r_end: Int, c_from: Int, c_end: Int): MatrixD

    Slice this matrix row-wise r_from to r_end and column-wise c_from to c_end.

    Slice this matrix row-wise r_from to r_end and column-wise c_from to c_end.

    r_from

    the start of the row slice

    r_end

    the end of the row slice

    c_from

    the start of the column slice

    c_end

    the end of the column slice

    Definition Classes
    MatrixDMatriD
  125. def slice(from: Int, end: Int): MatrixD

    Slice this matrix row-wise from to end.

    Slice this matrix row-wise from to end.

    from

    the start row of the slice (inclusive)

    end

    the end row of the slice (exclusive)

    Definition Classes
    MatrixDMatriD
  126. def slice(rg: Range): MatriD

    Slice 'this' matrix row-wise over the given range 'rg'.

    Slice 'this' matrix row-wise over the given range 'rg'.

    rg

    the range specifying the slice

    Definition Classes
    MatriD
  127. def sliceCol(from: Int, end: Int): MatrixD

    Slice this matrix column-wise 'from' to 'end'.

    Slice this matrix column-wise 'from' to 'end'.

    from

    the start column of the slice (inclusive)

    end

    the end column of the slice (exclusive)

    Definition Classes
    MatrixDMatriD
  128. def sliceEx(row: Int, col: Int): MatrixD

    Slice this matrix excluding the given row and column.

    Slice this matrix excluding the given row and column.

    row

    the row to exclude

    col

    the column to exclude

    Definition Classes
    MatrixDMatriD
  129. def sliceEx(rg: Range): MatriD

    Slice 'this' matrix row-wise excluding the given range 'rg'.

    Slice 'this' matrix row-wise excluding the given range 'rg'.

    rg

    the excluded range of the slice

    Definition Classes
    MatriD
  130. def solve(b: VectoD): VectorD

    Solve for 'x' in the equation 'a*x = b' where 'a' is 'this' matrix.

    Solve for 'x' in the equation 'a*x = b' where 'a' is 'this' matrix.

    b

    the constant vector.

    Definition Classes
    MatrixDMatriD
  131. def solve(lu: (MatriD, MatriD), b: VectoD): VectorD

    Solve for 'x' in the equation 'l*u*x = b' (see lud_npp above).

    Solve for 'x' in the equation 'l*u*x = b' (see lud_npp above).

    lu

    the lower and upper triangular matrices

    b

    the constant vector

    Definition Classes
    MatrixDMatriD
  132. def solve(l: MatriD, u: MatriD, b: VectoD): VectorD

    Solve for x in the equation l*u*x = b (see lud_npp above).

    Solve for x in the equation l*u*x = b (see lud_npp above).

    l

    the lower triangular matrix

    u

    the upper triangular matrix

    b

    the constant vector

    Definition Classes
    MatrixDMatriD
  133. def splitRows(rowIndex: VectoI): (MatriD, MatriD)

    Split the rows from 'this' matrix to form two matrices, one from the rows in 'rowIndex' and the other from rows not in 'rowIndex'.

    Split the rows from 'this' matrix to form two matrices, one from the rows in 'rowIndex' and the other from rows not in 'rowIndex'.

    rowIndex

    the row indices to include/exclude

    Definition Classes
    MatriD
  134. def splitRows(rowIndex: Array[Int]): (MatriD, MatriD)

    Split the rows from 'this' matrix to form two matrices, one from the rows in 'rowIndex' and the other from rows not in 'rowIndex'.

    Split the rows from 'this' matrix to form two matrices, one from the rows in 'rowIndex' and the other from rows not in 'rowIndex'.

    rowIndex

    the row indices to include/exclude

    Definition Classes
    MatriD
  135. def sum: Double

    Compute the sum of this matrix, i.e., the sum of its elements.

    Compute the sum of this matrix, i.e., the sum of its elements.

    Definition Classes
    MatrixDMatriD
  136. def sumAbs: Double

    Compute the abs sum of this matrix, i.e., the sum of the absolute value of its elements.

    Compute the abs sum of this matrix, i.e., the sum of the absolute value of its elements. This is useful for comparing matrices (a - b).sumAbs

    Definition Classes
    MatrixDMatriD
  137. def sumLower: Double

    Compute the sum of the lower triangular region of this matrix.

    Compute the sum of the lower triangular region of this matrix.

    Definition Classes
    MatrixDMatriD
  138. def swap(i: Int, k: Int, col: Int = 0): Unit

    Swap the elements in rows 'i' and 'k' starting from column 'col'.

    Swap the elements in rows 'i' and 'k' starting from column 'col'.

    i

    the first row in the swap

    k

    the second row in the swap

    col

    the starting column for the swap (default 0 => whole row)

    Definition Classes
    MatriD
  139. def swapCol(j: Int, l: Int, row: Int = 0): Unit

    Swap the elements in columns 'j' and 'l' starting from row 'row'.

    Swap the elements in columns 'j' and 'l' starting from row 'row'.

    j

    the first column in the swap

    l

    the second column in the swap

    row

    the starting row for the swap (default 0 => whole column)

    Definition Classes
    MatriD
  140. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  141. def t: MatrixD

    Transpose this matrix (rows => columns).

    Transpose this matrix (rows => columns).

    Definition Classes
    MatrixDMatriD
  142. def times(b: MatrixD): MatrixD

    Multiply this matrix by matrix b without transposing b.

    Multiply this matrix by matrix b without transposing b.

    b

    the matrix to multiply by (requires sameCrossDimensions)

  143. def times_ip(b: MatrixD): Unit

    Multiply in-place this matrix by matrix b.

    Multiply in-place this matrix by matrix b. If b and this reference the same matrix (b == this), a copy of the this matrix is made.

    b

    the matrix to multiply by (requires square and sameCrossDimensions)

  144. def times_s(b: MatrixD): MatrixD

    Multiply this matrix by matrix b using the Strassen matrix multiplication algorithm.

    Multiply this matrix by matrix b using the Strassen matrix multiplication algorithm. Both matrices (this and b) must be square. Although the algorithm is faster than the traditional cubic algorithm, its requires more memory and is often less stable (due to round-off errors). FIX: could be make more efficient using a virtual slice (vslice) method.

    b

    the matrix to multiply by (it has to be a square matrix)

    See also

    http://en.wikipedia.org/wiki/Strassen_algorithm

  145. def toDense: MatriD

    Convert 'this' matrix to a dense matrix.

    Convert 'this' matrix to a dense matrix.

    Definition Classes
    MatrixDMatriD
  146. def toDouble: MatrixD

    Convert 'this' MatrixD into a dense double matrix MatrixD.

    Convert 'this' MatrixD into a dense double matrix MatrixD.

    Definition Classes
    MatrixDMatriD
  147. def toInt: MatrixI

    Convert 'this' MatriD into an integer matrix MatriI.

    Convert 'this' MatriD into an integer matrix MatriI.

    Definition Classes
    MatrixDMatriD
  148. def toString(): String

    Convert this matrix to a string.

    Convert this matrix to a string.

    Definition Classes
    MatrixD → AnyRef → Any
  149. def trace: Double

    Compute the trace of this matrix, i.e., the sum of the elements on the main diagonal.

    Compute the trace of this matrix, i.e., the sum of the elements on the main diagonal. Should also equal the sum of the eigenvalues.

    Definition Classes
    MatrixDMatriD
    See also

    Eigen.scala

  150. def update(ir: Range, jr: Range, b: MatriD): Unit

    Set a slice this matrix row-wise on range ir and column-wise on range jr.

    Set a slice this matrix row-wise on range ir and column-wise on range jr. Ex: a(2..4, 3..5) = b

    ir

    the row range

    jr

    the column range

    b

    the matrix to assign

    Definition Classes
    MatrixDMatriD
  151. def update(i: Int, u: VectoD): Unit

    Set this matrix's row at the i-th index position to the vector u.

    Set this matrix's row at the i-th index position to the vector u.

    i

    the row index

    u

    the vector value to assign

    Definition Classes
    MatrixDMatriD
  152. def update(i: Int, j: Int, x: Double): Unit

    Set this matrix's element at the i,j-th index position to the scalar x.

    Set this matrix's element at the i,j-th index position to the scalar x.

    i

    the row index

    j

    the column index

    x

    the scalar value to assign

    Definition Classes
    MatrixDMatriD
  153. def update(i: Int, jr: Range, u: VectoD): Unit

    Set a slice of 'this' matrix row-wise at index 'i' and column-wise on range 'jr' to vector 'u'.

    Set a slice of 'this' matrix row-wise at index 'i' and column-wise on range 'jr' to vector 'u'. Ex: a(2, 3..5) = u

    i

    the row index

    jr

    the column range

    u

    the vector to assign

    Definition Classes
    MatriD
  154. def update(ir: Range, j: Int, u: VectoD): Unit

    Set a slice of 'this' matrix row-wise on range 'ir' and column-wise at index 'j' to vector 'u'.

    Set a slice of 'this' matrix row-wise on range 'ir' and column-wise at index 'j' to vector 'u'. Ex: a(2..4, 3) = u

    ir

    the row range

    j

    the column index

    u

    the vector to assign

    Definition Classes
    MatriD
  155. def upperT: MatriD

    Return the upper triangular of 'this' matrix (rest are zero).

    Return the upper triangular of 'this' matrix (rest are zero).

    Definition Classes
    MatrixDMatriD
  156. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  157. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  158. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  159. def write(fileName: String): Unit

    Write this matrix to a CSV-formatted text file.

    Write this matrix to a CSV-formatted text file.

    fileName

    the name of file holding the data

    Definition Classes
    MatrixDMatriD
  160. def zero(m: Int, n: Int): MatriD

    Create an m-by-n matrix with all elements initialized to zero.

    Create an m-by-n matrix with all elements initialized to zero.

    m

    the number of rows

    n

    the number of columns

    Definition Classes
    MatrixDMatriD
  161. def ~^(p: Int): MatrixD

    Raise this matrix to the pth power (for some integer p >= 2).

    Raise this matrix to the pth power (for some integer p >= 2). Caveat: should be replace by a divide and conquer algorithm.

    p

    the power to raise this matrix to

    Definition Classes
    MatrixDMatriD

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from MatriD

Inherited from Error

Inherited from AnyRef

Inherited from Any

Ungrouped