 # Matrix

### Related Doc: package linalg

#### sealed trait Matrix extends Serializable

Trait for a local matrix.

Annotations
@Since( "2.0.0" )
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
1. Alphabetic
2. By Inheritance
Inherited
1. Matrix
2. Serializable
3. Serializable
4. AnyRef
5. Any
1. Hide All
2. Show All
Visibility
1. Public
2. All

### Abstract Value Members

1. #### abstract def apply(i: Int, j: Int): Double

Gets the (i, j)-th element.

Gets the (i, j)-th element.

Annotations
@Since( "2.0.0" )
2. #### abstract def colIter: Iterator[Vector]

Returns an iterator of column vectors.

Returns an iterator of column vectors. This operation could be expensive, depending on the underlying storage.

Annotations
@Since( "2.0.0" )
3. #### abstract def copy: Matrix

Get a deep copy of the matrix.

Get a deep copy of the matrix.

Annotations
@Since( "2.0.0" )
4. #### abstract def foreachActive(f: (Int, Int, Double) ⇒ Unit): Unit

Applies a function `f` to all the active elements of dense and sparse matrix.

Applies a function `f` to all the active elements of dense and sparse matrix. The ordering of the elements are not defined.

f

the function takes three parameters where the first two parameters are the row and column indices respectively with the type `Int`, and the final parameter is the corresponding value in the matrix with type `Double`.

Annotations
@Since( "2.2.0" )
5. #### abstract def numActives: Int

Find the number of values stored explicitly.

Find the number of values stored explicitly. These values can be zero as well.

Annotations
@Since( "2.0.0" )
6. #### abstract def numCols: Int

Number of columns.

Number of columns.

Annotations
@Since( "2.0.0" )
7. #### abstract def numNonzeros: Int

Find the number of non-zero active values.

Find the number of non-zero active values.

Annotations
@Since( "2.0.0" )
8. #### abstract def numRows: Int

Number of rows.

Number of rows.

Annotations
@Since( "2.0.0" )
9. #### abstract def transpose: Matrix

Transpose the Matrix.

Transpose the Matrix. Returns a new `Matrix` instance sharing the same underlying data.

Annotations
@Since( "2.0.0" )

### Concrete Value Members

1. #### final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
2. #### final def ##(): Int

Definition Classes
AnyRef → Any
3. #### final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
4. #### final def asInstanceOf[T0]: T0

Definition Classes
Any
5. #### def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
6. #### def compressed: Matrix

Returns a matrix in dense column major, dense row major, sparse row major, or sparse column major format, whichever uses less storage.

Returns a matrix in dense column major, dense row major, sparse row major, or sparse column major format, whichever uses less storage. When dense representation is optimal, it maintains the current layout order.

Annotations
@Since( "2.2.0" )
7. #### def compressedColMajor: Matrix

Returns a matrix in dense or sparse column major format, whichever uses less storage.

Returns a matrix in dense or sparse column major format, whichever uses less storage.

Annotations
@Since( "2.2.0" )
8. #### def compressedRowMajor: Matrix

Returns a matrix in dense or sparse row major format, whichever uses less storage.

Returns a matrix in dense or sparse row major format, whichever uses less storage.

Annotations
@Since( "2.2.0" )
9. #### final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
10. #### def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
11. #### def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
12. #### final def getClass(): Class[_]

Definition Classes
AnyRef → Any
13. #### def hashCode(): Int

Definition Classes
AnyRef → Any
14. #### final def isInstanceOf[T0]: Boolean

Definition Classes
Any
15. #### val isTransposed: Boolean

Flag that keeps track whether the matrix is transposed or not.

Flag that keeps track whether the matrix is transposed or not. False by default.

Annotations
@Since( "2.0.0" )
16. #### def multiply(y: Vector): DenseVector

Convenience method for `Matrix`-`Vector` multiplication.

Convenience method for `Matrix`-`Vector` multiplication.

Annotations
@Since( "2.0.0" )
17. #### def multiply(y: DenseVector): DenseVector

Convenience method for `Matrix`-`DenseVector` multiplication.

Convenience method for `Matrix`-`DenseVector` multiplication. For binary compatibility.

Annotations
@Since( "2.0.0" )
18. #### def multiply(y: DenseMatrix): DenseMatrix

Convenience method for `Matrix`-`DenseMatrix` multiplication.

Convenience method for `Matrix`-`DenseMatrix` multiplication.

Annotations
@Since( "2.0.0" )
19. #### final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
20. #### final def notify(): Unit

Definition Classes
AnyRef
21. #### final def notifyAll(): Unit

Definition Classes
AnyRef
22. #### def rowIter: Iterator[Vector]

Returns an iterator of row vectors.

Returns an iterator of row vectors. This operation could be expensive, depending on the underlying storage.

Annotations
@Since( "2.0.0" )
23. #### final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
24. #### def toArray: Array[Double]

Converts to a dense array in column major.

Converts to a dense array in column major.

Annotations
@Since( "2.0.0" )
25. #### def toDense: DenseMatrix

Converts this matrix to a dense matrix while maintaining the layout of the current matrix.

Converts this matrix to a dense matrix while maintaining the layout of the current matrix.

Annotations
@Since( "2.2.0" )
26. #### def toDenseColMajor: DenseMatrix

Converts this matrix to a dense matrix in column major order.

Converts this matrix to a dense matrix in column major order.

Annotations
@Since( "2.2.0" )
27. #### def toDenseRowMajor: DenseMatrix

Converts this matrix to a dense matrix in row major order.

Converts this matrix to a dense matrix in row major order.

Annotations
@Since( "2.2.0" )
28. #### def toSparse: SparseMatrix

Converts this matrix to a sparse matrix while maintaining the layout of the current matrix.

Converts this matrix to a sparse matrix while maintaining the layout of the current matrix.

Annotations
@Since( "2.2.0" )
29. #### def toSparseColMajor: SparseMatrix

Converts this matrix to a sparse matrix in column major order.

Converts this matrix to a sparse matrix in column major order.

Annotations
@Since( "2.2.0" )
30. #### def toSparseRowMajor: SparseMatrix

Converts this matrix to a sparse matrix in row major order.

Converts this matrix to a sparse matrix in row major order.

Annotations
@Since( "2.2.0" )
31. #### def toString(maxLines: Int, maxLineWidth: Int): String

A human readable representation of the matrix with maximum lines and width

A human readable representation of the matrix with maximum lines and width

Annotations
@Since( "2.0.0" )
32. #### def toString(): String

A human readable representation of the matrix

A human readable representation of the matrix

Definition Classes
Matrix → AnyRef → Any
33. #### final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
34. #### final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
35. #### final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )