final def !=(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final def ##(): Int

Definition Classes: AnyRef → Any

def *(x: Real): SparseMatrixR

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

x: the scalar to multiply by

Definition Classes: SparseMatrixR → MatriR

def *(u: VectoR): VectorR

Multiply 'this' sparse matrix by vector 'u' (vector elements beyond 'dim2' ignored).

u: the vector to multiply by

Definition Classes: SparseMatrixR → MatriR

def *(b: MatriR): SparseMatrixR

Multiply 'this' sparse matrix by dense matrix 'b'.

b: the matrix to multiply by (requires 'sameCrossDimensions')

Definition Classes: SparseMatrixR → MatriR

def *(b: SparseMatrixR): SparseMatrixR

Multiply 'this' sparse matrix by sparse matrix 'b', by performing a merge operation on the rows on 'this' sparse matrix and the transpose of the 'b' matrix.

b: the matrix to multiply by (requires 'sameCrossDimensions')

def **(u: VectoR): SparseMatrixR

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

u: the vector to multiply by

Definition Classes: SparseMatrixR → MatriR

def **:(u: VectoR): SparseMatrixR

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: SparseMatrixR → MatriR

def **=(u: VectoR): SparseMatrixR

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

u: the vector to multiply by

Definition Classes: SparseMatrixR → MatriR

def *:(u: VectoR): VectoR

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: MatriR

def *=(x: Real): SparseMatrixR

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

x: the scalar to multiply by

Definition Classes: SparseMatrixR → MatriR

def *=(b: MatriR): SparseMatrixR

Multiply in-place 'this' sparse matrix by dense matrix 'b'.

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

Definition Classes: SparseMatrixR → MatriR

def *=(b: SparseMatrixR): SparseMatrixR

Multiply in-place 'this' sparse matrix by sparse matrix 'b', by performing a merge operation on the rows on 'this' sparse matrix and the transpose of the 'b' matrix.

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

def +(x: Real): MatrixR

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

Add 'this' sparse matrix and scalar 'x'. Note: every element will be likely filled, hence the return type is a dense matrix.

x: the scalar to add

Definition Classes: SparseMatrixR → MatriR

def +(u: VectoR): SparseMatrixR

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

u: the vector to add

Definition Classes: SparseMatrixR → MatriR

def +(b: MatriR): SparseMatrixR

Add 'this' sparse matrix and matrix 'b'.

Add 'this' sparse matrix and matrix 'b'. 'b' may be any subtype of MatriR. Note, subtypes of MatriR should also implement a more efficient version, e.g., def + (b: SparseMatrixR): SparseMatrixR.

b: the matrix to add (requires 'sameCrossDimensions')

Definition Classes: SparseMatrixR → MatriR

def +(b: SparseMatrixR): SparseMatrixR

Add 'this' sparse matrix and sparse matrix 'b'.

b: the matrix to add (requires 'sameCrossDimensions')

def ++(b: MatriR): SparseMatrixR

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

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

Definition Classes: SparseMatrixR → MatriR

def ++^(b: MatriR): SparseMatrixR

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

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

Definition Classes: SparseMatrixR → MatriR

def +:(u: VectoR): SparseMatrixR

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: SparseMatrixR → MatriR

def +=(x: Real): SparseMatrixR

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

x: the scalar to add

Definition Classes: SparseMatrixR → MatriR

def +=(u: VectoR): SparseMatrixR

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

u: the vector to add

Definition Classes: SparseMatrixR → MatriR

def +=(b: MatriR): SparseMatrixR

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

b: the matrix to add (requires 'sameCrossDimensions')

Definition Classes: SparseMatrixR → MatriR

def +=(b: SparseMatrixR): SparseMatrixR

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

b: the matrix to add (requires 'sameCrossDimensions')

def +^:(u: VectoR): SparseMatrixR

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: SparseMatrixR → MatriR

def -(x: Real): MatrixR

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

From 'this' sparse matrix subtract scalar 'x'. Note: every element will be likely filled, hence the return type is a dense matrix.

x: the scalar to subtract

Definition Classes: SparseMatrixR → MatriR

def -(u: VectoR): SparseMatrixR

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

u: the vector to subtract

Definition Classes: SparseMatrixR → MatriR

def -(b: MatriR): SparseMatrixR

From 'this' sparse matrix subtract matrix 'b'.

b: the matrix to subtract (requires 'sameCrossDimensions')

Definition Classes: SparseMatrixR → MatriR

def -(b: SparseMatrixR): SparseMatrixR

From 'this' sparse matrix subtract matrix 'b'.

b: the sparse matrix to subtract (requires 'sameCrossDimensions')

def -=(x: Real): SparseMatrixR

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

x: the scalar to subtract

Definition Classes: SparseMatrixR → MatriR

def -=(u: VectoR): SparseMatrixR

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

u: the vector to subtract

Definition Classes: SparseMatrixR → MatriR

def -=(b: MatriR): SparseMatrixR

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

b: the matrix to subtract (requires 'sameCrossDimensions')

Definition Classes: SparseMatrixR → MatriR

def -=(b: SparseMatrixR): SparseMatrixR

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

b: the sparse matrix to subtract (requires 'sameCrossDimensions')

def /(x: Real): SparseMatrixR

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

x: the scalar to divide by

Definition Classes: SparseMatrixR → MatriR

def /=(x: Real): SparseMatrixR

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

x: the scalar to divide by

Definition Classes: SparseMatrixR → MatriR

def :+(u: VectoR): SparseMatrixR

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: SparseMatrixR → MatriR

def :^+(u: VectoR): SparseMatrixR

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: SparseMatrixR → MatriR

final def ==(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def apply(ir: Range, jr: Range): SparseMatrixR

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: SparseMatrixR → MatriR

def apply(i: Int): VectorR

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

i: the row index

Definition Classes: SparseMatrixR → MatriR

def apply(i: Int, j: Int): Real

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

i: the row index
j: the column index

Definition Classes: SparseMatrixR → MatriR

def apply(i: Int, jr: Range): VectoR

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: MatriR

def apply(ir: Range, j: Int): VectoR

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: MatriR

final def asInstanceOf[T0]: T0

Definition Classes: Any

def bsolve(y: VectoR): VectorR

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: SparseMatrixR → MatriR

def clean(thres: Double, relative: Boolean = true): SparseMatrixR

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: SparseMatrixR → MatriR

def clone(): AnyRef

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @throws( ... )

def col(col: Int, from: Int = 0): VectorR

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: SparseMatrixR → MatriR

def copy(): SparseMatrixR

Create a clone of 'this' 'm-by-n' sparse matrix.

Definition Classes: SparseMatrixR → MatriR

val d1: Int

val d2: Int

def det: Real

Compute the determinant of 'this' sparse matrix.

Definition Classes: SparseMatrixR → MatriR

def diag(p: Int, q: Int): SparseMatrixR

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: SparseMatrixR → MatriR

def diag(b: MatriR): SparseMatrixR

Combine 'this' sparse 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: SparseMatrixR → MatriR

lazy val dim1: Int

Dimension 1

Definition Classes: SparseMatrixR → MatriR

lazy val dim2: Int

Dimension 2

Definition Classes: SparseMatrixR → MatriR

def dot(b: MatriR): VectorR

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

b: the second matrix of the dot product

Definition Classes: SparseMatrixR → MatriR

def dot(u: VectoR): VectorR

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

u: the vector to multiply by (requires same first dimensions)

Definition Classes: SparseMatrixR → MatriR

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def equals(arg0: Any): Boolean

Definition Classes: AnyRef → Any

val fString: String

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

Attributes: protected
Definition Classes: MatriR

def finalize(): Unit

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @throws( classOf[java.lang.Throwable] )

final def flaw(method: String, message: String): Unit

Show the flaw by printing the error message.

method: the method where the error occurred
message: the error message

Definition Classes: Error

def foreach[U](f: (Array[Real]) ⇒ U): Unit

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

f: the function to apply

Definition Classes: MatriR

final def getClass(): Class[_]

Definition Classes: AnyRef → Any

def getDiag(k: Int = 0): VectorR

Get the 'k'th diagonal of this matrix.

Get the 'k'th 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: SparseMatrixR → MatriR

def hashCode(): Int

Definition Classes: AnyRef → Any

def inverse: SparseMatrixR

Invert 'this' sparse matrix (requires a 'squareMatrix') using partial pivoting.

Definition Classes: SparseMatrixR → MatriR

def inverse_ip(): SparseMatrixR

Invert in-place 'this' sparse matrix (requires a 'squareMatrix').

Invert in-place 'this' sparse matrix (requires a 'squareMatrix'). This version uses partial pivoting.

Definition Classes: SparseMatrixR → MatriR

def inverse_npp: SparseMatrixR

Invert 'this' sparse matrix (requires a 'squareMatrix') not using partial pivoting.

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: MatriR

final def isInstanceOf[T0]: Boolean

Definition Classes: Any

def isNonnegative: Boolean

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

Definition Classes: SparseMatrixR → MatriR

def isRectangular: Boolean

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

Definition Classes: SparseMatrixR → MatriR

def isSquare: Boolean

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

Definition Classes: MatriR

def isSymmetric: Boolean

Check whether 'this' matrix is symmetric.

Definition Classes: MatriR

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: MatriR

def leDimensions(b: MatriR): Boolean

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

b: the other matrix

Definition Classes: MatriR

def lowerT: SparseMatrixR

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

Definition Classes: SparseMatrixR → MatriR

def lud_ip(): (SparseMatrixR, SparseMatrixR)

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

Definition Classes: SparseMatrixR → MatriR

def lud_npp: (SparseMatrixR, SparseMatrixR)

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

Definition Classes: SparseMatrixR → MatriR

def mag: Real

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

Definition Classes: MatriR

def max(e: Int = dim1): Real

Find the maximum element in 'this' sparse matrix.

e: the ending row index (exclusive) for the search

Definition Classes: SparseMatrixR → MatriR

def mdot(b: MatriR): SparseMatrixR

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: SparseMatrixR → MatriR

def mean: VectoR

Compute the column means of this matrix.

Definition Classes: MatriR

def min(e: Int = dim1): Real

Find the minimum element in 'this' sparse matrix.

e: the ending row index (exclusive) for the search

Definition Classes: SparseMatrixR → MatriR

final def ne(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def norm1: Real

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: MatriR

final def notify(): Unit

Definition Classes: AnyRef

final def notifyAll(): Unit

Definition Classes: AnyRef

def nullspace: VectorR

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: SparseMatrixR → MatriR
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

def nullspace_ip(): VectorR

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: SparseMatrixR → MatriR
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

val range1: Range

Range for the storage array on dimension 1 (rows)

Definition Classes: MatriR

val range2: Range

Range for the storage array on dimension 2 (columns)

Definition Classes: MatriR

def reduce: SparseMatrixR

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

Use Gauss-Jordan reduction on 'this' sparse 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: SparseMatrixR → MatriR

def reduce_ip(): Unit

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

Use Gauss-Jordan reduction in-place on 'this' sparse 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: SparseMatrixR → MatriR

def sameCrossDimensions(b: MatriR): Boolean

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

b: the other matrix

Definition Classes: MatriR

def sameDimensions(b: MatriR): Boolean

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

b: the other matrix

Definition Classes: MatriR

def selectCols(colIndex: Array[Int]): SparseMatrixR

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: SparseMatrixR → MatriR

def selectRows(rowIndex: Array[Int]): SparseMatrixR

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

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

Definition Classes: SparseMatrixR → MatriR

def set(i: Int, u: VectoR, j: Int = 0): Unit

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: SparseMatrixR → MatriR

def set(u: Array[Array[Real]]): Unit

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: SparseMatrixR → MatriR

def set(x: Real): Unit

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

x: the scalar value to assign

Definition Classes: SparseMatrixR → MatriR

def setCol(col: Int, u: VectoR): Unit

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

col: the column to set
u: the vector to assign to the column

Definition Classes: SparseMatrixR → MatriR

def setDiag(x: Real): 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: SparseMatrixR → MatriR

def setDiag(u: VectoR, 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: SparseMatrixR → MatriR

def setFormat(newFormat: String): Unit

Set the format to the 'newFormat'.

newFormat: the new format string

Definition Classes: MatriR

def showAll(): Unit

Show all elements in 'this' sparse matrix.

def slice(r_from: Int, r_end: Int, c_from: Int, c_end: Int): SparseMatrixR

Slice 'this' sparse 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: SparseMatrixR → MatriR

def slice(from: Int, end: Int): SparseMatrixR

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

from: the start row of the slice
end: the end row of the slice

Definition Classes: SparseMatrixR → MatriR

def sliceCol(from: Int, end: Int): SparseMatrixR

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

from: the start column of the slice (inclusive)
end: the end column of the slice (exclusive)

Definition Classes: SparseMatrixR → MatriR

def sliceExclude(row: Int, col: Int): SparseMatrixR

Slice 'this' sparse matrix excluding the given row and column.

row: the row to exclude
col: the column to exclude

Definition Classes: SparseMatrixR → MatriR

def solve(b: VectoR): VectoR

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

b: the constant vector.

Definition Classes: SparseMatrixR → MatriR

def solve(l: MatriR, u: MatriR, b: VectoR): VectoR

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: SparseMatrixR → MatriR

def solve(lu: (MatriR, MatriR), b: VectoR): VectoR

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: MatriR

def sum: Real

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

Definition Classes: SparseMatrixR → MatriR

def sumAbs: Real

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: SparseMatrixR → MatriR

def sumLower: Real

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

Definition Classes: SparseMatrixR → MatriR

def swap(i: Int, k: Int, col: Int = 0): Unit

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: MatriR

def swapCol(j: Int, l: Int, row: Int = 0): Unit

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: MatriR

final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes: AnyRef

def t: SparseMatrixR

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

Definition Classes: SparseMatrixR → MatriR

def times_s(b: SparseMatrixR): SparseMatrixR

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

Multiply 'this' sparse matrix by sparse 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

def toDense: MatrixR

Convert this sparse matrix to a dense matrix.

Convert this sparse matrix to a dense matrix. FIX - new builder

Definition Classes: SparseMatrixR → MatriR

def toInt: MatrixI

Convert 'this' SparseMatrixR into a MatrixI.

Definition Classes: SparseMatrixR → MatriR

def toString(): String

Show the non-zero elements in 'this' sparse matrix.

Definition Classes: SparseMatrixR → AnyRef → Any

def trace: Real

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

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

Definition Classes: SparseMatrixR → MatriR
See also: Eigen.scala

def update(ir: Range, jr: Range, b: MatriR): Unit

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

Set a slice 'this' sparse 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: SparseMatrixR → MatriR

def update(i: Int, u: RowMap): Unit

Set 'this' sparse matrix's row at the 'i'-th index position to the sorted-linked-map 'u'.

i: the row index
u: the sorted-linked-map of non-zero values to assign

def update(i: Int, u: VectoR): Unit

Set 'this' sparse 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: SparseMatrixR → MatriR

def update(i: Int, j: Int, x: Real): Unit

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

Set 'this' sparse matrix's element at the 'i,j'-th index position to the scalar 'x'. Only store 'x' if it is non-zero.

i: the row index
j: the column index
x: the scalar value to assign

Definition Classes: SparseMatrixR → MatriR

def update(i: Int, jr: Range, u: VectoR): 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: MatriR

def update(ir: Range, j: Int, u: VectoR): 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: MatriR

def upperT: SparseMatrixR

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

Definition Classes: SparseMatrixR → MatriR

final def wait(): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

def write(fileName: String): Unit

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

fileName: the name of file to hold the data

Definition Classes: SparseMatrixR → MatriR

def zero(m: Int = dim1, n: Int = dim2): SparseMatrixR

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

m: the number of rows
n: the number of columns

Definition Classes: SparseMatrixR → MatriR

def ~^(p: Int): SparseMatrixR

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

Raise 'this' sparse matrix to the 'p'th 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: SparseMatrixR → MatriR

Packages

SparseMatrixR

Companion object SparseMatrixR

class SparseMatrixR extends MatriR with Error with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from MatriR

Inherited from Error

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

SparseMatrixR 

Companion object SparseMatrixR

class SparseMatrixR extends MatriR with Error with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from MatriR

Inherited from Error

Inherited from AnyRef

Inherited from Any

Ungrouped

SparseMatrixR