org.apache.flink.ml.math

Class SparseMatrix

java.lang.Object

org.apache.flink.ml.math.SparseMatrix

All Implemented Interfaces:

Serializable, Matrix

public class SparseMatrix
extends Object
implements Matrix, scala.Serializable

Sparse matrix using the compressed sparse column (CSC) representation.

More details concerning the compressed sparse column (CSC) representation can be found [http://en.wikipedia.org/wiki/Sparse_matrix#Compressed_sparse_column_.28CSC_or_CCS.29].

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SparseMatrix(int numRows, int numCols, int[] rowIndices, int[] colPtrs, double[] data)

Method Summary

Modifier and Type	Method and Description
double	apply(int row, int col) Element wise access function
int[]	colPtrs()
SparseMatrix	copy() Copies the matrix instance
double[]	data()
boolean	equals(Object obj)
static SparseMatrix	fromCOO(int numRows, int numCols, scala.collection.Iterable<scala.Tuple3<Object,Object,Object>> entries) Constructs a sparse matrix from a coordinate list (COO) representation where each entry is stored as a tuple of (rowIndex, columnIndex, value).
static SparseMatrix	fromCOO(int numRows, int numCols, scala.collection.Seq<scala.Tuple3<Object,Object,Object>> entries) Constructs a sparse matrix from a coordinate list (COO) representation where each entry is stored as a tuple of (rowIndex, columnIndex, value).
static SparseMatrix	fromCOO(int numRows, int numCols, scala.Tuple3<Object,Object,Object> entry) Convenience method to convert a single tuple with an integer value into a SparseMatrix.
int	hashCode()
int	numCols() Number of columns
int	numRows() Number of rows
int[]	rowIndices()
DenseMatrix	toDenseMatrix()
String	toString()
void	update(int row, int col, double value) Element wise update function

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.flink.ml.math.Matrix

equalsMatrix

Constructor Detail

SparseMatrix

public SparseMatrix(int numRows,
                    int numCols,
                    int[] rowIndices,
                    int[] colPtrs,
                    double[] data)

Method Detail

fromCOO

public static SparseMatrix fromCOO(int numRows,
                                   int numCols,
                                   scala.collection.Seq<scala.Tuple3<Object,Object,Object>> entries)

Constructs a sparse matrix from a coordinate list (COO) representation where each entry is stored as a tuple of (rowIndex, columnIndex, value).

Parameters:

numRows -

numCols -

entries -

Returns:

fromCOO

public static SparseMatrix fromCOO(int numRows,
                                   int numCols,
                                   scala.collection.Iterable<scala.Tuple3<Object,Object,Object>> entries)

Constructs a sparse matrix from a coordinate list (COO) representation where each entry is stored as a tuple of (rowIndex, columnIndex, value).

Parameters:

numRows -

numCols -

entries -

Returns:

fromCOO

public static SparseMatrix fromCOO(int numRows,
                                   int numCols,
                                   scala.Tuple3<Object,Object,Object> entry)

Convenience method to convert a single tuple with an integer value into a SparseMatrix. The problem is that providing a single tuple to the fromCOO method, the Scala type inference cannot infer that the tuple has to be of type (Int, Int, Double) because of the overloading with the Iterable type.

Parameters:

numRows -

numCols -

entry -

Returns:

numRows

public int numRows()

Description copied from interface: Matrix

Number of rows

Specified by:

numRows in interface Matrix

Returns:

numCols

public int numCols()

Description copied from interface: Matrix

Number of columns

Specified by:

numCols in interface Matrix

Returns:

rowIndices

public int[] rowIndices()

colPtrs

public int[] colPtrs()

data

public double[] data()

apply

public double apply(int row,
                    int col)

Element wise access function

Specified by:

apply in interface Matrix

Parameters:

row - row index

col - column index

Returns:

matrix entry at (row, col)

toDenseMatrix

public DenseMatrix toDenseMatrix()

update

public void update(int row,
                   int col,
                   double value)

Element wise update function

Specified by:

update in interface Matrix

Parameters:

row - row index

col - column index

value - value to set at (row, col)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copy

public SparseMatrix copy()

Copies the matrix instance

Specified by:

copy in interface Matrix

Returns:

Copy of itself