Packages

class RleMatrixI extends MatriI with Error with Serializable

The RleMatrixI class stores and operates on Numeric Matrices of type Int. Rather than storing the matrix as a 2 dimensional array, it is stored as an array of RleVectorI's.

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

Instance Constructors

  1. new RleMatrixI(dim1: Int)

    Construct a 'dim1' by 'dim1' square matrix.

    Construct a 'dim1' by 'dim1' square matrix.

    dim1

    the row and column dimension

  2. new RleMatrixI(d1: Int, d2: Int, v: Array[RleVectorI] = null, deferred: Boolean = false)

    d1

    the first/row dimension

    d2

    the second/column dimension

    v

    the 1D 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 *(b: MatriI): MatriI

    Multiply 'this' matrix by matrix 'b'.

    Multiply 'this' matrix by matrix 'b'.

    b

    the matrix to multiply by (requires 'sameCrossDimensions')

    Definition Classes
    RleMatrixIMatriI
  4. def *(x: Int): RleMatrixI

    Multiply 'this' matrix by scalar 'x'.

    Multiply 'this' matrix by scalar 'x'.

    x

    the scalar to multiply by

    Definition Classes
    RleMatrixIMatriI
  5. def *(u: VectoI): VectoI

    Multiply 'this' matrix by (column) vector 'u'

    Multiply 'this' matrix by (column) vector 'u'

    u

    the vector to multiply by

    Definition Classes
    RleMatrixIMatriI
  6. def **(u: VectoI): MatriI

    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'. E.g., multiply a matrix by a diagonal matrix represented as a vector.

    u

    the vector to multiply by

    Definition Classes
    RleMatrixIMatriI
  7. def **:(u: VectoI): MatriI

    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
    RleMatrixIMatriI
  8. def **=(u: VectoI): MatriI

    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
    RleMatrixIMatriI
  9. 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
  10. def *=(b: MatriI): MatriI

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

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

    b

    the matrix to multiply by (requires square and 'sameCrossDimensions')

    Definition Classes
    RleMatrixIMatriI
  11. def *=(x: Int): RleMatrixI

    Multiply in-place 'this' matrix by matrix 'x'

    Multiply in-place 'this' matrix by matrix 'x'

    x

    the matrix to multiply by

    Definition Classes
    RleMatrixIMatriI
  12. def +(u: VectoI): MatriI

    Add 'this' matrix and vector 'u'.

    Add 'this' matrix and vector 'u'.

    u

    the matrix to add (requires leDimensions)

    Definition Classes
    RleMatrixIMatriI
  13. def +(x: Int): RleMatrixI

    Add 'this' matrix and scalar 'x'.

    Add 'this' matrix and scalar 'x'.

    x

    the scalar to add

    Definition Classes
    RleMatrixIMatriI
  14. def +(b: MatriI): RleMatrixI

    Add 'this' matrix and matrix 'b'.

    Add 'this' matrix and matrix 'b'.

    b

    the matrix to add (requires leDimensions)

    Definition Classes
    RleMatrixIMatriI
  15. def ++(b: MatriI): RleMatrixI

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

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

    b

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

    Definition Classes
    RleMatrixIMatriI
  16. def ++^(b: MatriI): RleMatrixI

    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
    RleMatrixIMatriI
  17. def +:(u: VectoI): RleMatrixI

    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
    RleMatrixIMatriI
  18. def +=(b: MatriI): MatriI

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

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

    b

    the matrix to add (requires 'leDimensions')

    Definition Classes
    RleMatrixIMatriI
  19. def +=(u: VectoI): MatriI

    Add in-place 'this' matrix and vector 'u'.

    Add in-place 'this' matrix and vector 'u'.

    u

    the vector to add

    Definition Classes
    RleMatrixIMatriI
  20. def +=(x: Int): MatriI

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

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

    x

    the scalar to add

    Definition Classes
    RleMatrixIMatriI
  21. def +^:(u: VectoI): RleMatrixI

    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
    RleMatrixIMatriI
  22. def -(b: MatriI): MatriI

    From 'this' matrix subtract matrix 'b'.

    From 'this' matrix subtract matrix 'b'.

    b

    the matrix to subtract

    Definition Classes
    RleMatrixIMatriI
  23. def -(u: VectoI): RleMatrixI

    From 'this' matrix subtract vector 'u'.

    From 'this' matrix subtract vector 'u'.

    u

    the vector to subtract

    Definition Classes
    RleMatrixIMatriI
  24. def -(x: Int): MatriI

    From 'this' matrix subtract scalar 'x'.

    From 'this' matrix subtract scalar 'x'.

    x

    the scalar to subtract

    Definition Classes
    RleMatrixIMatriI
  25. def -=(b: MatriI): MatriI

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

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

    b

    the matrix to subtract (requires 'leDimensions')

    Definition Classes
    RleMatrixIMatriI
  26. def -=(u: VectoI): MatriI

    From 'this' matrix subtract in-place vector 'u'.

    From 'this' matrix subtract in-place vector 'u'.

    u

    the vector to subtract

    Definition Classes
    RleMatrixIMatriI
  27. def -=(x: Int): MatriI

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

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

    x

    the scalar to subtract

    Definition Classes
    RleMatrixIMatriI
  28. def /(x: Int): MatriI

    Divide 'this' matrix by scalar 'x'.

    Divide 'this' matrix by scalar 'x'.

    x

    the scalar to divide by

    Definition Classes
    RleMatrixIMatriI
  29. def /=(x: Int): MatriI

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

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

    x

    the scalar to divide by

    Definition Classes
    RleMatrixIMatriI
  30. def :+(u: VectoI): RleMatrixI

    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
    RleMatrixIMatriI
  31. def :^+(u: VectoI): RleMatrixI

    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
    RleMatrixIMatriI
  32. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  33. def apply(): Array[RleVectorI]

    Get the underlying 1D array for 'this' matrix.

  34. def apply(ir: Range, jr: Range): MatriI

    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
    RleMatrixIMatriI
  35. def apply(i: Int): RleVectorI

    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
    RleMatrixIMatriI
  36. def apply(i: Int, j: Int): Int

    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
    RleMatrixIMatriI
  37. 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
  38. 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
  39. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  40. def bsolve(y: VectoI): RleVectorI

    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
    RleMatrixIMatriI
  41. def clean(thres: Double = TOL, relative: Boolean = true): MatriI

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

    Clean values in 'this' matrix at or below the threshold 'thres' 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
    RleMatrixIMatriI
  42. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def col(col: Int, from: Int = 0): VectorI

    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
    RleMatrixIMatriI
  44. def col(col: Int): RleVectorI

    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

  45. def copy(): RleMatrixI

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

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

    Definition Classes
    RleMatrixIMatriI
  46. def csize: VectorI

    Get size of each column of 'this' RleMatrix

  47. val d1: Int
  48. val d2: Int
  49. val deferred: Boolean
  50. def det: Int

    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
    RleMatrixIMatriI
  51. def diag(b: MatriI): RleMatrixI

    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
    RleMatrixIMatriI
  52. def diag(p: Int, q: Int = 0): MatriI

    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
    RleMatrixIMatriI
  53. lazy val dim1: Int

    Dimension 1

    Dimension 1

    Definition Classes
    RleMatrixIMatriI
  54. lazy val dim2: Int

    Dimension 2

    Dimension 2

    Definition Classes
    RleMatrixIMatriI
  55. def dot(b: RleMatrixI): RleVectorI

    Compute the dot product of 'this' matrix and matrix 'b'.

    Compute the dot product of 'this' matrix and matrix 'b'. Results in a Vector.

    b

    the matrix to multiply by (requires same first dimensions)

  56. def dot(b: MatriI): RleVectorI

    Compute the dot product of 'this' matrix and matrix 'b'.

    Compute the dot product of 'this' matrix and matrix 'b'. Results in a Vector.

    b

    the matrix to multiply by (requires same first dimensions)

    Definition Classes
    RleMatrixIMatriI
  57. def dot(b: VectoI): VectoI

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

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

    b

    the vector to multiply by (requires same first dimensions)

    Definition Classes
    RleMatrixIMatriI
  58. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  59. def equals(b: Any): Boolean

    Override equals to determine whether 'this' vector equals vector 'b'.

    Override equals to determine whether 'this' vector equals vector 'b'.

    b

    the vector to compare with this

    Definition Classes
    RleMatrixI → AnyRef → Any
  60. 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
  61. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  62. 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
  63. 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
  64. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  65. def getDiag(k: Int = 0): RleVectorI

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

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

    k

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

    Definition Classes
    RleMatrixIMatriI
  66. def hashCode(): Int

    Must also override hashCode for 'this' vector to be compatible with equals.

    Must also override hashCode for 'this' vector to be compatible with equals.

    Definition Classes
    RleMatrixI → AnyRef → Any
  67. def inverse: MatriI

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

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

    Definition Classes
    RleMatrixIMatriI
  68. def inverse_ip(): MatriI

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

    Invert in-place 'this' matrix (requires a square matrix) and uses partial pivoting. Note: this method turns the original matrix into the identity matrix. The inverse is returned and is captured by assignment.

    Definition Classes
    RleMatrixIMatriI
  69. 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
  70. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  71. 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
    MatriI
  72. 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
    RleMatrixIMatriI
  73. 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
  74. def isSymmetric: Boolean

    Check whether 'this' matrix is symmetric.

    Check whether 'this' matrix is symmetric.

    Definition Classes
    MatriI
  75. 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
    MatriI
  76. 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
  77. def lowerT: RleMatrixI

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

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

    Definition Classes
    RleMatrixIMatriI
  78. def lud_ip(): (RleMatrixI, RleMatrixI)

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

    Factor in-place 'this' matrix into the product of lower and upper triangular matrices '(l, u)' using an 'LU' Factorization algorithm. FIX - check for 0 pivots (divide by zero).

    Definition Classes
    RleMatrixIMatriI
  79. def lud_npp: (RleMatrixI, RleMatrixI)

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

    Factor 'this' matrix into the product of lower and upper triangular matrices '(l, u)' using an 'LU' Factorization algorithm. FIX - check for 0 pivots (divide by zero).

    Definition Classes
    RleMatrixIMatriI
  80. 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
  81. def max(e: Int = dim1): Int

    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
    RleMatrixIMatriI
  82. def mdot(b: RleMatrixI): RleMatrixI

    Compute the matrix dot product of 'this' matrix and matrix 'b'.

    Compute the matrix dot product of 'this' matrix and matrix 'b'.

    b

    the matrix to multiply by (requires same first dimensions)

  83. def mdot(b: MatriI): RleMatrixI

    Compute the matrix dot product of 'this' matrix and matrix 'b'.

    Compute the matrix dot product of 'this' matrix and matrix 'b'.

    b

    the matrix to multiply by (requires same first dimensions)

    Definition Classes
    RleMatrixIMatriI
  84. def mean: VectoI

    Compute the column means of this matrix.

    Compute the column means of this matrix.

    Definition Classes
    MatriI
  85. def min(e: Int = dim1): Int

    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
    RleMatrixIMatriI
  86. def mul2(u: RleVectorI): RleVectorI

    Multiply 'this' matrix by (column) vector 'u'

    Multiply 'this' matrix by (column) vector 'u'

    u

    the vector to multiply by

  87. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  88. 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
  89. final def notify(): Unit
    Definition Classes
    AnyRef
  90. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  91. def nullspace: VectoI

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

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

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

  92. def nullspace_ip(): VectoI

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

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

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

  93. val range1: Range

    Range for the storage array on dimension 1 (rows)

    Range for the storage array on dimension 1 (rows)

    Definition Classes
    MatriI
  94. val range2: Range

    Range for the storage array on dimension 2 (columns)

    Range for the storage array on dimension 2 (columns)

    Definition Classes
    MatriI
  95. def reduce: RleMatrixI

    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'. It can be used to solve 'a * x = b': augment 'a' with 'b' and call reduce. Takes '[a | b]' to '[I | x]'.

    Definition Classes
    RleMatrixIMatriI
  96. 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'. It can be used to solve 'a * x = b': augment 'a' with 'b' and call reduce. Takes '[a | b]' to '[I | x]'.

    Definition Classes
    RleMatrixIMatriI
  97. 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
  98. 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
  99. def selectCols(colIndex: Array[Int]): RleMatrixI

    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
    RleMatrixIMatriI
  100. def selectRows(rowIndex: Array[Int]): RleMatrixI

    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
    RleMatrixIMatriI
  101. def set(u: Array[Array[Int]]): 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
    RleMatrixIMatriI
  102. def set(i: Int, u: VectoI, j: Int = 0): Unit

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

    Set 'this' 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
    RleMatrixIMatriI
  103. def set(x: Int): 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
    RleMatrixIMatriI
  104. def setCol(col: Int, u: VectoI): 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
    RleMatrixIMatriI
  105. def setDiag(u: VectoI, k: Int = 0): Unit

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

    Set the 'k'th 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
    RleMatrixIMatriI
  106. def setDiag(x: Int): Unit

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

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

    x

    the scalar to set the diagonal to

    Definition Classes
    RleMatrixIMatriI
  107. 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
  108. def slice(r_from: Int, r_end: Int, c_from: Int, c_end: Int): RleMatrixI

    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
    RleMatrixIMatriI
  109. def slice(from: Int, end: Int): RleMatrixI

    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
    RleMatrixIMatriI
  110. def sliceCol(from: Int, end: Int): RleMatrixI

    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
    RleMatrixIMatriI
  111. def sliceExclude(row: Int, col: Int): RleMatrixI

    Slice 'this' matrix excluding the given row and/or column.

    Slice 'this' matrix excluding the given row and/or column.

    row

    the row to exclude

    col

    the column to exclude

    Definition Classes
    RleMatrixIMatriI
  112. def solve(b: VectoI): VectoI

    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
    RleMatrixIMatriI
  113. def solve(l: MatriI, u: MatriI, b: VectoI): VectoI

    Solve for 'x' in the equation 'l*u*x = b'

    Solve for 'x' in the equation 'l*u*x = b'

    l

    the lower triangular matrix

    u

    the upper triangular matrix

    b

    the constant vector

    Definition Classes
    RleMatrixIMatriI
  114. 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
  115. def sum: Int

    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
    RleMatrixIMatriI
  116. def sumAbs: Int

    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
    RleMatrixIMatriI
  117. def sumLower: Int

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

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

    Definition Classes
    RleMatrixIMatriI
  118. 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
  119. 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
  120. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  121. def t: RleMatrixI

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

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

    Definition Classes
    RleMatrixIMatriI
  122. def toDense: MatrixI

    Convert 'this' matrix to a dense matrix.

    Convert 'this' matrix to a dense matrix.

    Definition Classes
    RleMatrixIMatriI
  123. def toInt: MatrixI

    Convert 'this' RleMatrixI into a MatrixI.

    Convert 'this' RleMatrixI into a MatrixI.

    Definition Classes
    RleMatrixIMatriI
  124. def toString(): String

    Convert 'this' real (Int precision) matrix to a string.

    Convert 'this' real (Int precision) matrix to a string.

    Definition Classes
    RleMatrixI → AnyRef → Any
  125. def trace: Int

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

    Eigen.scala

  126. def update(ir: Range, jr: Range, b: MatriI): 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
    RleMatrixIMatriI
  127. def update(i: Int, u: VectoI): 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
    RleMatrixIMatriI
  128. def update(i: Int, j: Int, x: Int): 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
    RleMatrixIMatriI
  129. 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
  130. 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
  131. def upperT: RleMatrixI

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

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

    Definition Classes
    RleMatrixIMatriI
  132. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  134. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  135. def write(fileName: String): Unit

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

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

    fileName

    the name of file to hold the data

    Definition Classes
    RleMatrixIMatriI
  136. def zero(mm: Int, nn: Int): RleMatrixI

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

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

    Definition Classes
    RleMatrixIMatriI
  137. def ~^(p: Int): RleMatrixI

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

    Raise 'this' matrix to the 'p'th power (for some integer 'p' >= 2). FIX - make compatible with imple in BldMatrix

    p

    the power to raise 'this' matrix to

    Definition Classes
    RleMatrixIMatriI

Inherited from Serializable

Inherited from Serializable

Inherited from MatriI

Inherited from Error

Inherited from AnyRef

Inherited from Any

Ungrouped