Packages

class SymTriMatrixI extends MatriI with Error with Serializable

The SymTriMatrixI class stores and operates on symmetric tridiagonal matrices. The elements are of type of Int. A matrix is stored as two vectors: the diagonal vector and the sub-diagonal vector.

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

Instance Constructors

  1. new SymTriMatrixI(b: MatriI)

    Construct a symmetric tridiagonal matrix from the given matrix.

    Construct a symmetric tridiagonal matrix from the given matrix.

    b

    the matrix of values to assign

  2. new SymTriMatrixI(v1: VectoI, v2: VectoI)

    Construct a symmetric tridiagonal matrix with the given diagonal and sub-diagonal.

    Construct a symmetric tridiagonal matrix with the given diagonal and sub-diagonal.

    v1

    the diagonal vector

    v2

    the sub-diagonal vector

  3. new SymTriMatrixI(d1: Int)

    d1

    the first/row dimension (symmetric => d2 = d1)

Value Members

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

    Multiply 'this' tridiagonal matrix by scalar 'x'.

    Multiply 'this' tridiagonal matrix by scalar 'x'.

    x

    the scalar to multiply by

    Definition Classes
    SymTriMatrixIMatriI
  4. def *(u: VectoI): VectorI

    Multiply 'this' tridiagonal matrix by vector 'u'.

    Multiply 'this' tridiagonal matrix by vector 'u'.

    u

    the vector to multiply by

    Definition Classes
    SymTriMatrixIMatriI
  5. def *(b: SymTriMatrixI): MatrixI

    Multiply 'this' tridiagonal matrix by matrix 'b'.

    Multiply 'this' tridiagonal matrix by matrix 'b'. Requires 'b' to have type SymTriMatrixI, but returns a more general type of matrix.

    b

    the matrix to multiply by

  6. def *(b: MatriI): SymTriMatrixI

    Multiply 'this' tridiagonal matrix by matrix 'b'.

    Multiply 'this' tridiagonal matrix by matrix 'b'.

    b

    the matrix to multiply by

    Definition Classes
    SymTriMatrixIMatriI
  7. def **(u: VectoI): MatrixI

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

    Multiply 'this' tridiagonal matrix by vector 'u' to produce another matrix 'a_ij * u_j'. E.g., multiply a diagonal matrix represented as a vector by a matrix.

    u

    the vector to multiply by

    Definition Classes
    SymTriMatrixIMatriI
  8. def **(b: MatriI): MatriI

    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
    MatriI
    See also

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

  9. def **:(u: VectoI): MatrixI

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

    Multiply vector 'u' by 'this' tridiagonal 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
    SymTriMatrixIMatriI
  10. def **=(u: VectoI): MatrixI

    Multiply in-place 'this' tridiagonal matrix by vector 'u' to produce another matrix 'a_ij * u_j'.

    Multiply in-place 'this' tridiagonal matrix by vector 'u' to produce another matrix 'a_ij * u_j'. E.g., multiply a diagonal matrix represented as a vector by a matrix.

    u

    the vector to multiply by

    Definition Classes
    SymTriMatrixIMatriI
  11. def *:(u: VectoI): VectoI

    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
    MatriI
  12. def *=(x: Int): SymTriMatrixI

    Multiply in-place 'this' tridiagonal matrix by scalar 'x'.

    Multiply in-place 'this' tridiagonal matrix by scalar 'x'.

    x

    the scalar to multiply by

    Definition Classes
    SymTriMatrixIMatriI
  13. def *=(b: MatriI): SymTriMatrixI

    Multiply in-place 'this' tridiagonal matrix by matrix 'b'.

    Multiply in-place 'this' tridiagonal matrix by matrix 'b'.

    b

    the matrix to multiply by

    Definition Classes
    SymTriMatrixIMatriI
  14. def +(x: Int): SymTriMatrixI

    Add 'this' tridiagonal matrix and scalar 'x'.

    Add 'this' tridiagonal matrix and scalar 'x'.

    x

    the scalar to add

    Definition Classes
    SymTriMatrixIMatriI
  15. def +(u: VectoI): MatrixI

    Add 'this' tridiagonal matrix and (row) vector 'u'.

    Add 'this' tridiagonal matrix and (row) vector 'u'.

    u

    the vector to add

    Definition Classes
    SymTriMatrixIMatriI
  16. def +(b: MatriI): SymTriMatrixI

    Add 'this' tridiagonal matrix and matrix 'b'.

    Add 'this' tridiagonal matrix and matrix 'b'.

    b

    the matrix to add (requires 'leDimensions')

    Definition Classes
    SymTriMatrixIMatriI
  17. def ++(b: MatriI): SymTriMatrixI

    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
    SymTriMatrixIMatriI
  18. def ++^(b: MatriI): SymTriMatrixI

    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
    SymTriMatrixIMatriI
  19. def +:(u: VectoI): SymTriMatrixI

    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
    SymTriMatrixIMatriI
  20. def +=(x: Int): SymTriMatrixI

    Add in-place 'this' tridiagonal matrix and scalar 'x'.

    Add in-place 'this' tridiagonal matrix and scalar 'x'.

    x

    the scalar to add

    Definition Classes
    SymTriMatrixIMatriI
  21. def +=(u: VectoI): MatrixI

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

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

    u

    the vector to add

    Definition Classes
    SymTriMatrixIMatriI
  22. def +=(b: MatriI): SymTriMatrixI

    Add in-place 'this' tridiagonal matrix and matrix 'b'.

    Add in-place 'this' tridiagonal matrix and matrix 'b'.

    b

    the matrix to add (requires 'leDimensions')

    Definition Classes
    SymTriMatrixIMatriI
  23. def +^:(u: VectoI): SymTriMatrixI

    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
    SymTriMatrixIMatriI
  24. def -(x: Int): SymTriMatrixI

    From 'this' tridiagonal matrix subtract scalar 'x'.

    From 'this' tridiagonal matrix subtract scalar 'x'.

    x

    the scalar to subtract

    Definition Classes
    SymTriMatrixIMatriI
  25. def -(u: VectoI): MatrixI

    From 'this' tridiagonal matrix subtract (row) vector 'u'.

    From 'this' tridiagonal matrix subtract (row) vector 'u'.

    u

    the vector to subtract

    Definition Classes
    SymTriMatrixIMatriI
  26. def -(b: MatriI): SymTriMatrixI

    From 'this' tridiagonal matrix subtract matrix 'b'.

    From 'this' tridiagonal matrix subtract matrix 'b'.

    b

    the matrix to subtract (requires 'leDimensions')

    Definition Classes
    SymTriMatrixIMatriI
  27. def -=(x: Int): SymTriMatrixI

    From 'this' tridiagonal matrix subtract in-place scalar 'x'.

    From 'this' tridiagonal matrix subtract in-place scalar 'x'.

    x

    the scalar to subtract

    Definition Classes
    SymTriMatrixIMatriI
  28. def -=(u: VectoI): MatrixI

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

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

    u

    the vector to subtract

    Definition Classes
    SymTriMatrixIMatriI
  29. def -=(b: MatriI): SymTriMatrixI

    From 'this' tridiagonal matrix subtract in-place matrix 'b'.

    From 'this' tridiagonal matrix subtract in-place matrix 'b'.

    b

    the matrix to subtract (requires 'leDimensions')

    Definition Classes
    SymTriMatrixIMatriI
  30. def /(x: Int): SymTriMatrixI

    Divide 'this' tridiagonal matrix by scalar 'x'.

    Divide 'this' tridiagonal matrix by scalar 'x'.

    x

    the scalar to divide by

    Definition Classes
    SymTriMatrixIMatriI
  31. def /=(x: Int): SymTriMatrixI

    Divide in-place 'this' tridiagonal matrix by scalar 'x'.

    Divide in-place 'this' tridiagonal matrix by scalar 'x'.

    x

    the scalar to divide by

    Definition Classes
    SymTriMatrixIMatriI
  32. def :+(u: VectoI): SymTriMatrixI

    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
    SymTriMatrixIMatriI
  33. def :^+(u: VectoI): SymTriMatrixI

    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
    SymTriMatrixIMatriI
  34. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  35. def apply(ir: Range, jr: Range): SymTriMatrixI

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

    Get a slice 'this' tridiagonal 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
    SymTriMatrixIMatriI
  36. def apply(i: Int): VectorI

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

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

    i

    the row index

    Definition Classes
    SymTriMatrixIMatriI
  37. def apply(i: Int, j: Int): Int

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

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

    i

    the row index

    j

    the column index

    Definition Classes
    SymTriMatrixIMatriI
  38. def apply(iv: VectoI): MatriI

    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
    MatriI
  39. def apply(i: Int, jr: Range): VectoI

    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
    MatriI
  40. def apply(ir: Range, j: Int): VectoI

    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
    MatriI
  41. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  42. def at(i: Int, j: Int): Int

    Get 'this' tridiagonal matrix's element at the 'i,j'-th index position, returning 0, if off tridiagonal.

    Get 'this' tridiagonal matrix's element at the 'i,j'-th index position, returning 0, if off tridiagonal.

    i

    the row index

    j

    the column index

  43. def bsolve(y: VectoI): VectorI

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

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

    y

    the constant vector

    Definition Classes
    SymTriMatrixIMatriI
  44. def clean(thres: Double, relative: Boolean = true): SymTriMatrixI

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

    Clean values in 'this' tridiagonal 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
    SymTriMatrixIMatriI
  45. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  46. def col(col: Int, from: Int = 0): VectorI

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

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

    col

    the column to extract from the matrix

    from

    the position to start extracting from

    Definition Classes
    SymTriMatrixIMatriI
  47. def copy: SymTriMatrixI

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

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

    Definition Classes
    SymTriMatrixIMatriI
  48. val d1: Int
  49. def det: Int

    Compute the determinant of 'this' tridiagonal matrix.

    Compute the determinant of 'this' tridiagonal matrix.

    Definition Classes
    SymTriMatrixIMatriI
  50. def dg: VectorI

    Get the diagonal of 'this' tridiagonal matrix.

  51. def dg_(v: VectorI): Unit

    Set the diagonal of 'this' tridiagonal matrix.

    Set the diagonal of 'this' tridiagonal matrix.

    v

    the vector to assign to the diagonal

  52. def diag(p: Int, q: Int): SymTriMatrixI

    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. Fill the rest of matrix with zeros.

    p

    the size of identity matrix Ip

    q

    the size of identity matrix Iq

    Definition Classes
    SymTriMatrixIMatriI
  53. def diag(b: MatriI): MatriI

    Combine 'this' tridiagonal 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' tridiagonal 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' tridiagonal matrix

    Definition Classes
    SymTriMatrixIMatriI
  54. lazy val dim1: Int

    Dimension 1

    Dimension 1

    Definition Classes
    SymTriMatrixIMatriI
  55. lazy val dim2: Int

    Dimension 2

    Dimension 2

    Definition Classes
    SymTriMatrixIMatriI
  56. def dot(b: MatriI): VectorI

    Compute the dot product of 'this' matrix with matrix 'b' to produce a vector.

    Compute the dot product of 'this' matrix with matrix 'b' to produce a vector.

    b

    the second matrix of the dot product

    Definition Classes
    SymTriMatrixIMatriI
  57. def dot(b: SymTriMatrixI): VectorI

    Compute the dot product of 'this' matrix with matrix 'b' to produce a vector.

    Compute the dot product of 'this' matrix with matrix 'b' to produce a vector.

    b

    the second matrix of the dot product

  58. def dot(u: VectoI): VectorI

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

    Compute the dot product of 'this' tridiagonal matrix and vector 'u', by first transposing 'this' tridiagonal matrix and then multiplying by 'u' (i.e., 'a dot u = a.t * u'). Since 'this' is symmetric, the result is the same as 'a * u'.

    u

    the vector to multiply by (requires same first dimensions)

    Definition Classes
    SymTriMatrixIMatriI
  59. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  60. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  61. 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
    MatriI
  62. def flatten: VectoI

    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
    MatriI
  63. 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
  64. def foreach[U](f: (Array[Int]) => 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
    MatriI
  65. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  66. def getDiag(k: Int = 0): VectorI

    Get the 'k'th diagonal of 'this' tridiagonal matrix.

    Get the 'k'th diagonal of 'this' tridiagonal matrix. Assumes 'dim2 >= dim1'.

    k

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

    Definition Classes
    SymTriMatrixIMatriI
  67. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  68. def inverse: MatriI

    Invert 'this' tridiagonal matrix.

    Invert 'this' tridiagonal matrix.

    Definition Classes
    SymTriMatrixIMatriI
    See also

    www.amm.shu.edu.cn/EN/article/downloadArticleFile.do?attachType=PDF&id=4339

  69. def inverse_ip(): SymTriMatrixI

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

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

    Definition Classes
    SymTriMatrixIMatriI
  70. 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
    MatriI
  71. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  72. def isNonnegative: Boolean

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

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

    Definition Classes
    SymTriMatrixIMatriI
  73. def isRectangular: Boolean

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

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

    Definition Classes
    SymTriMatrixIMatriI
  74. 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
    MatriI
  75. def isSymmetric: Boolean

    Check whether 'this' tridiagonal matrix is symmetric.

    Check whether 'this' tridiagonal matrix is symmetric.

    Definition Classes
    SymTriMatrixIMatriI
  76. def isTridiagonal: Boolean

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

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

    Definition Classes
    SymTriMatrixIMatriI
  77. def leDimensions(b: MatriI): 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
    MatriI
  78. def lowerT: SymTriMatrixI

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

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

    Definition Classes
    SymTriMatrixIMatriI
  79. def lud_ip(): (MatriI, MatriI)

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

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

    Definition Classes
    SymTriMatrixIMatriI
  80. def lud_npp: (MatriI, MatriI)

    Factor 'this' tridiagonal matrix into the product of lower and upper triangular matrices '(l, u)' using the 'LU' Factorization algorithm.

    Factor 'this' tridiagonal matrix into the product of lower and upper triangular matrices '(l, u)' using the 'LU' Factorization algorithm. 'l' is lower bidiagonal and 'u' is upper bidiagonal. FIX: would be more efficient to use tridiagonal matrices than dense matrices.

    Definition Classes
    SymTriMatrixIMatriI
    See also

    www.webpages.uidaho.edu/~barannyk/Teaching/LU_factorization_tridiagonal.pdf

  81. def mag: Int

    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
    MatriI
  82. def map(f: (VectoI) => VectoI): MatriI

    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
    MatriI
  83. def max(e: Int = dim1): Int

    Find the maximum element in 'this' tridiagonal matrix.

    Find the maximum element in 'this' tridiagonal matrix.

    e

    the ending row index (exclusive) for the search

    Definition Classes
    SymTriMatrixIMatriI
  84. def mdot(b: MatriI): MatrixI

    Compute the matrix dot product of 'this' matrix with matrix 'b' to produce a matrix.

    Compute the matrix dot product of 'this' matrix with matrix 'b' to produce a matrix.

    b

    the second matrix of the dot product

    Definition Classes
    SymTriMatrixIMatriI
  85. def mdot(b: SymTriMatrixI): MatrixI

    Compute the matrix dot product of 'this' matrix with matrix 'b' to produce a matrix.

    Compute the matrix dot product of 'this' matrix with matrix 'b' to produce a matrix.

    b

    the second matrix of the dot product

  86. def mean: VectoI

    Compute the column means of 'this' matrix.

    Compute the column means of 'this' matrix.

    Definition Classes
    MatriI
  87. def meanNZ: VectoI

    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
    MatriI
  88. def meanR: VectoI

    Compute the row means of 'this' matrix.

    Compute the row means of 'this' matrix.

    Definition Classes
    MatriI
  89. def meanRNZ: VectoI

    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
    MatriI
  90. def min(e: Int = dim1): Int

    Find the minimum element in 'this' tridiagonal matrix.

    Find the minimum element in 'this' tridiagonal matrix.

    e

    the ending row index (exclusive) for the search

    Definition Classes
    SymTriMatrixIMatriI
  91. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  92. def norm1: Int

    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
    MatriI
    See also

    en.wikipedia.org/wiki/Matrix_norm

  93. 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
    MatriI
    See also

    en.wikipedia.org/wiki/Matrix_norm#Frobenius_norm

  94. def normFSq: Int

    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
    MatriI
    See also

    en.wikipedia.org/wiki/Matrix_norm#Frobenius_norm

  95. def normINF: Int

    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
    MatriI
    See also

    en.wikipedia.org/wiki/Matrix_norm

  96. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  97. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  98. def nullspace: VectorI

    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.

    nullspace (a) = set of orthogonal vectors v s.t. a * v = 0

    The left nullspace of matrix 'a' is the same as the right nullspace of 'a.t'. FIX: need a more robust algorithm for computing nullspace (@see Fac_QR.scala). FIX: remove the 'n = m+1' restriction.

    Definition Classes
    SymTriMatrixIMatriI
    See also

    http://ocw.mit.edu/courses/mathematics/18-06sc-linear-algebra-fall-2011/ax-b-and-the-four-subspaces

    /solving-ax-0-pivot-variables-special-solutions/MIT18_06SCF11_Ses1.7sum.pdf

  99. def nullspace_ip(): VectorI

    Compute in-place 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 in-place 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.

    nullspace (a) = set of orthogonal vectors v s.t. a * v = 0

    The left nullspace of matrix 'a' is the same as the right nullspace of 'a.t'. FIX: need a more robust algorithm for computing nullspace (@see Fac_QR.scala). FIX: remove the 'n = m+1' restriction.

    Definition Classes
    SymTriMatrixIMatriI
    See also

    http://ocw.mit.edu/courses/mathematics/18-06sc-linear-algebra-fall-2011/ax-b-and-the-four-subspaces

    /solving-ax-0-pivot-variables-special-solutions/MIT18_06SCF11_Ses1.7sum.pdf

  100. val range1: Range

    Range for the storage array on dimension 1 (rows)

    Range for the storage array on dimension 1 (rows)

    Definition Classes
    MatriI
  101. val range2: Range

    Range for the storage array on dimension 2 (columns)

    Range for the storage array on dimension 2 (columns)

    Definition Classes
    MatriI
  102. def reduce: SymTriMatrixI

    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
    SymTriMatrixIMatriI
  103. def reduce_ip(): SymTriMatrixI

    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
    SymTriMatrixIMatriI
  104. def sameCrossDimensions(b: MatriI): 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
    MatriI
  105. def sameDimensions(b: MatriI): 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
    MatriI
  106. def sd: VectorI

    Get the sub-diagonal of 'this' tridiagonal matrix.

  107. def sd_(v: VectorI): Unit

    Set the sub-diagonal of 'this' tridiagonal matrix.

    Set the sub-diagonal of 'this' tridiagonal matrix.

    v

    the vector to assign to the sub-diagonal

  108. def selectCols(colIndex: Array[Int]): SymTriMatrixI

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

    Select columns from 'this' tridiagonal 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
    SymTriMatrixIMatriI
  109. def selectRows(rowIndex: Array[Int]): SymTriMatrixI

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

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

    rowIndex

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

    Definition Classes
    SymTriMatrixIMatriI
  110. def selectRows(rowIndex: VectoI): MatriI

    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
    MatriI
  111. def selectRowsEx(rowIndex: VectoI): MatriI

    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
    MatriI
  112. def selectRowsEx(rowIndex: Array[Int]): MatriI

    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
    MatriI
  113. def set(i: Int, u: VectoI, j: Int = 0): Unit

    Set 'this' tridiagonal matrix's 'i'th row starting at column 'j' to the vector 'u'.

    Set 'this' tridiagonal matrix's 'i'th 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
    SymTriMatrixIMatriI
  114. def set(u: MatriI): 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
    SymTriMatrixIMatriI
  115. def set(u: Array[Array[Int]]): Unit

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

    Set all the values in 'this' tridiagonal matrix as copies of the values in 2D array 'u'. Ignore parts of array not corresponding to tridiagonal.

    u

    the 2D array of values to assign

    Definition Classes
    SymTriMatrixIMatriI
  116. def set(x: Int): Unit

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

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

    x

    the scalar value to assign

    Definition Classes
    SymTriMatrixIMatriI
  117. def setCol(col: Int, u: VectoI): Unit

    Set column 'col' of 'this' tridiagonal matrix to a vector.

    Set column 'col' of 'this' tridiagonal matrix to a vector.

    col

    the column to set

    u

    the vector to assign to the column

    Definition Classes
    SymTriMatrixIMatriI
  118. def setDiag(x: Int): Unit

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

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

    x

    the scalar to set the diagonal to

    Definition Classes
    SymTriMatrixIMatriI
  119. def setDiag(u: VectoI, k: Int = 0): Unit

    Set the 'k'th diagonal of 'this' tridiagonal matrix to the vector 'u'.

    Set the 'k'th diagonal of 'this' tridiagonal 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
    SymTriMatrixIMatriI
  120. def setFormat(newFormat: String): Unit

    Set the format to the 'newFormat'.

    Set the format to the 'newFormat'.

    newFormat

    the new format string

    Definition Classes
    MatriI
  121. def slice(r_from: Int, r_end: Int, c_from: Int, c_end: Int): SymTriMatrixI

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

    Slice 'this' tridiagonal 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
    SymTriMatrixIMatriI
  122. def slice(from: Int, end: Int): SymTriMatrixI

    Slice 'this' tridiagonal matrix row-wise 'from' to 'end'.

    Slice 'this' tridiagonal matrix row-wise 'from' to 'end'.

    from

    the start row of the slice (inclusive)

    end

    the end row of the slice (exclusive)

    Definition Classes
    SymTriMatrixIMatriI
  123. def slice(rg: Range): MatriI

    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
    MatriI
  124. def sliceCol(from: Int, end: Int): SymTriMatrixI

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

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

    from

    the start column of the slice (inclusive)

    end

    the end column of the slice (exclusive)

    Definition Classes
    SymTriMatrixIMatriI
  125. def sliceEx(row: Int, col: Int): SymTriMatrixI

    Slice 'this' tridiagonal matrix excluding the given 'row' and 'col'umn.

    Slice 'this' tridiagonal matrix excluding the given 'row' and 'col'umn.

    row

    the row to exclude

    col

    the column to exclude

    Definition Classes
    SymTriMatrixIMatriI
  126. def sliceEx(rg: Range): MatriI

    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
    MatriI
  127. def solve(b: VectoI): VectoI

    Solve for 'x' in the equation 'a*x = b' where 'a' is 'this' tridiagonal matrix, using the Thomas Algorithm.

    Solve for 'x' in the equation 'a*x = b' where 'a' is 'this' tridiagonal matrix, using the Thomas Algorithm. Caveat: Stability vs. diagonal dominance. This method is more efficient, since a 'lud_npp' creates dense matrices.

    b

    the constant vector

    Definition Classes
    SymTriMatrixIMatriI
    See also

    en.wikibooks.org/wiki/Algorithm_Implementation/Linear_Algebra/Tridiagonal_matrix_algorithm

  128. def solve(l: MatriI, u: MatriI, b: VectoI): VectoI

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

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

    l

    the lower triangular matrix

    u

    the upper triangular matrix

    b

    the constant vector

    Definition Classes
    SymTriMatrixIMatriI
  129. def solve(lu: (MatriI, MatriI), b: VectoI): VectoI

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

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

    lu

    the lower and upper triangular matrices

    b

    the constant vector

    Definition Classes
    MatriI
  130. def splitRows(rowIndex: VectoI): (MatriI, MatriI)

    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
    MatriI
  131. def splitRows(rowIndex: Array[Int]): (MatriI, MatriI)

    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
    MatriI
  132. def sum: Int

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

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

    Definition Classes
    SymTriMatrixIMatriI
  133. def sumAbs: Int

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

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

    Definition Classes
    SymTriMatrixIMatriI
  134. def sumLower: Int

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

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

    Definition Classes
    SymTriMatrixIMatriI
  135. 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
    MatriI
  136. 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
    MatriI
  137. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  138. def t: SymTriMatrixI

    Transpose 'this' tridiagonal matrix (rows => columns).

    Transpose 'this' tridiagonal matrix (rows => columns). Note, since the matrix is symmetric, it returns itself.

    Definition Classes
    SymTriMatrixIMatriI
  139. def toDense: MatrixI

    Convert 'this' tridiagonal matrix to a dense matrix.

    Convert 'this' tridiagonal matrix to a dense matrix.

    Definition Classes
    SymTriMatrixIMatriI
  140. def toDouble: SymTriMatrixD

    Convert 'this' SymTriMatrixI into a double matrix SymTriMatrixD.

    Convert 'this' SymTriMatrixI into a double matrix SymTriMatrixD.

    Definition Classes
    SymTriMatrixIMatriI
  141. def toInt: SymTriMatrixI

    Convert 'this' SymTriMatrixI into an integer matrix SymTriMatrixI.

    Convert 'this' SymTriMatrixI into an integer matrix SymTriMatrixI.

    Definition Classes
    SymTriMatrixIMatriI
  142. def toString(): String

    Convert 'this' tridiagonal matrix to a string showing the diagonal vector followed by the sub-diagonal vector.

    Convert 'this' tridiagonal matrix to a string showing the diagonal vector followed by the sub-diagonal vector.

    Definition Classes
    SymTriMatrixI → AnyRef → Any
  143. def trace: Int

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

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

    Definition Classes
    SymTriMatrixIMatriI
    See also

    Eigen.scala

  144. def update(ir: Range, jr: Range, b: MatriI): Unit

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

    Set a slice 'this' tridiagonal 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
    SymTriMatrixIMatriI
  145. def update(i: Int, u: VectoI): Unit

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

    Set 'this' tridiagonal 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
    SymTriMatrixIMatriI
  146. def update(i: Int, j: Int, x: Int): Unit

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

    Set 'this' tridiagonal 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
    SymTriMatrixIMatriI
  147. def update(i: Int, jr: Range, u: VectoI): 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
    MatriI
  148. def update(ir: Range, j: Int, u: VectoI): 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
    MatriI
  149. def upperT: SymTriMatrixI

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

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

    Definition Classes
    SymTriMatrixIMatriI
  150. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  151. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  152. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  153. def write(fileName: String): Unit

    Write 'this' tridiagonal matrix to a CSV-formatted text file with name 'fileName'.

    Write 'this' tridiagonal matrix to a CSV-formatted text file with name 'fileName'.

    fileName

    the name of file to hold the data

    Definition Classes
    SymTriMatrixIMatriI
  154. def zero(m: Int = dim1, n: Int = dim2): SymTriMatrixI

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

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

    m

    the number of rows

    n

    the number of columns

    Definition Classes
    SymTriMatrixIMatriI
  155. def ~^(p: Int): SymTriMatrixI

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

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

    p

    the power to raise this tridiagonal matrix to

    Definition Classes
    SymTriMatrixIMatriI

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 MatriI

Inherited from Error

Inherited from AnyRef

Inherited from Any

Ungrouped