dragon.matrix

Interface SparseMatrix

All Superinterfaces:

Matrix

All Known Subinterfaces:

DoubleSparseMatrix, IntSparseMatrix

All Known Implementing Classes:

AbstractFlatSparseMatrix, AbstractGiantSparseMatrix, AbstractSparseMatrix, AbstractSuperSparseMatrix, DoubleFlatSparseMatrix, DoubleGiantSparseMatrix, DoubleSuperSparseMatrix, IntFlatSparseMatrix, IntGiantSparseMatrix, IntSuperSparseMatrix

public interface SparseMatrix
extends Matrix

Interface of sparse matrix

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

Method Summary

Modifier and Type	Method and Description
boolean	add(Cell cell) Add a cell to the sparse matrix.
Cell	createCell(int row, int column, byte[] data) This method will be called when the sparse matrix loads data from a binary file.
Cell	createCell(int row, int column, String data) This method will be called when the sparse matrix loads data from a text file.
SparseMatrix	createSparseMatrix() This method return an empty sparse matrix with the same implemented type as the current matrix.
boolean	finalizeData() It is equal to calling finalizeData(true)
boolean	finalizeData(boolean sorting) Any sparse matrix has two possible modes, writing mode and reading mode.
void	flush() Many implementations of sparse matrix cache cells in memory.
boolean	genCooccurrenceMatrix(IntSparseMatrix outputCooccurMatrix) The cell (i,j) in the output cooccurrence matrix stores the cooccurrence count of the i-th row and the j-th row.
boolean	genCooccurrenceMatrix(SparseMatrix matrixY, int minOccurrence, IntSparseMatrix outputCooccurMatrix) The cell (i,j) in the output cooccurrence matrix stores the cooccurrence count of the i-th row in the current matrix and the j-th row in the matrixY.
boolean	genCooccurrenceMatrix(SparseMatrix matrixY, IntSparseMatrix outputCooccurMatrix) The cell (i,j) in the output cooccurrence matrix stores the cooccurrence count of the i-th row in the current matrix and the j-th row in the matrixY.
Cell	getCell(int row, int column) If the specified cell doesn't exist, this method will return null.
Cell	getNonZeroCellInColumn(int column, int index) This method returns the index-th non-zero cell in the given row.
Cell	getNonZeroCellInRow(int row, int index) This method returns the index-th non-zero cell in the given column.
int	getNonZeroColumnInRow(int row, int index) This method returns the column index of the index-th non-zero cell in the given row.
int[]	getNonZeroColumnsInRow(int row) If the given row has n non-zero cells, this method returns a n-length integer array.
double	getNonZeroDoubleScoreInColumn(int column, int index) This method returns the double score of the index-th non-zero cell in the given column.
double	getNonZeroDoubleScoreInRow(int row, int index) This method returns the double score of the index-th non-zero cell in the given row.
double[]	getNonZeroDoubleScoresInColumn(int column) If the given column has n non-zero cells, this method returns a n-length double array.
double[]	getNonZeroDoubleScoresInRow(int row) If the given row has n non-zero cells, this method returns a n-length double array.
int	getNonZeroIntScoreInColumn(int column, int index) This method returns the integer score of the index-th non-zero cell in the given column.
int	getNonZeroIntScoreInRow(int row, int index) This method returns the integer score of the index-th non-zero cell in the given row.
int[]	getNonZeroIntScoresInColumn(int column) If the given column has n non-zero cells, this method returns a n-length integer array.
int[]	getNonZeroIntScoresInRow(int row) If the given row has n non-zero cells, this method returns a n-length integer array.
int	getNonZeroNum()
int	getNonZeroNumInColumn(int column) If the transposed matrix is not set yet, this method will automatically generate the transposed matrix.
int	getNonZeroNumInRow(int row)
int	getNonZeroRowInColumn(int column, int index) This method returns the row index of the index-th non-zero cell in the given column.
int[]	getNonZeroRowsInColumn(int column) If the given column has n non-zero cells, this method returns a n-length integer array.
boolean	isFinalized() If this method returns true, one can not add data to the sparse matrix any more.

Methods inherited from interface dragon.matrix.Matrix

close, columns, cosine, getBaseColumn, getBaseRow, getCellDataLength, getCooccurrenceCount, getDouble, getInt, getTranspose, rows, setTranspose, transpose

Method Detail

getNonZeroNum

int getNonZeroNum()

Returns:

the number of non-zero cells

getNonZeroNumInRow

int getNonZeroNumInRow(int row)

Parameters:

row - the index of the row

Returns:

the number of non-zero cells in the given row.

getNonZeroNumInColumn

int getNonZeroNumInColumn(int column)

If the transposed matrix is not set yet, this method will automatically generate the transposed matrix. Thus, it may take several minutes for the first call.

Parameters:

column - the index of the column

Returns:

the number of non-zero cells in the given column.

getNonZeroColumnInRow

int getNonZeroColumnInRow(int row,
                          int index)

This method returns the column index of the index-th non-zero cell in the given row. The index starts from zero.

Parameters:

row - the index of the row

index - the index-th non-zero cell

Returns:

the column index of the specified cell

getNonZeroRowInColumn

int getNonZeroRowInColumn(int column,
                          int index)

This method returns the row index of the index-th non-zero cell in the given column. The index starts from zero. If the transposed matrix is not set yet, this method will automatically generate the transposed matrix. Thus, it may take several minutes.

Parameters:

column - the index of the column

index - the index-th non-zero cell

Returns:

the row index of the specified cell.

getNonZeroColumnsInRow

int[] getNonZeroColumnsInRow(int row)

If the given row has n non-zero cells, this method returns a n-length integer array. Each element of the array stores the column index of the corresponding non-zero cell.

Parameters:

row - the index of row

Returns:

the array of non-zero columns in the given row

getNonZeroRowsInColumn

int[] getNonZeroRowsInColumn(int column)

If the given column has n non-zero cells, this method returns a n-length integer array. Each element of the array stores the row index of the corresponding non-zero cell. If the transposed matrix is not set yet, this method will automatically generate the transposed matrix. Thus, it may take several minutes.

Parameters:

column - the index of the column

Returns:

the array of non-zero rows in the given column.

getNonZeroCellInRow

Cell getNonZeroCellInRow(int row,
                         int index)

This method returns the index-th non-zero cell in the given column. The index starts from zero.

Parameters:

row - the index of the row

index - the index-th non-zero cell

Returns:

the cell

getNonZeroCellInColumn

Cell getNonZeroCellInColumn(int column,
                            int index)

This method returns the index-th non-zero cell in the given row. The index starts from zero. If the transposed matrix is not set yet, this method will automatically generate the transposed matrix. Thus, it may take several minutes.

Parameters:

column - the index of the column

index - the index-th non-zero cell

Returns:

the cell

getNonZeroDoubleScoreInRow

double getNonZeroDoubleScoreInRow(int row,
                                  int index)

This method returns the double score of the index-th non-zero cell in the given row. The index starts from zero.

Parameters:

row - the index of the row.

index - the index-th non-zero cell

Returns:

the double score

getNonZeroDoubleScoreInColumn

double getNonZeroDoubleScoreInColumn(int column,
                                     int index)

This method returns the double score of the index-th non-zero cell in the given column. The index starts from zero. If the transposed matrix is not set yet, this method will automatically generate the transposed matrix. Thus, it may take several minutes.

Parameters:

column - the index of the column

index - the index-th non-zero cell

Returns:

the double score

getNonZeroDoubleScoresInRow

double[] getNonZeroDoubleScoresInRow(int row)

If the given row has n non-zero cells, this method returns a n-length double array. Each element of the array stores the double score of the corresponding non-zero cell.

Parameters:

row - the index of row

Returns:

the array of non-zero double scores in the given row

getNonZeroDoubleScoresInColumn

double[] getNonZeroDoubleScoresInColumn(int column)

If the given column has n non-zero cells, this method returns a n-length double array. Each element of the array stores the double score of the corresponding non-zero cell. If the transposed matrix is not set yet, this method will automatically generate the transposed matrix. Thus, it may take several minutes.

Parameters:

column - the index of the column

Returns:

the array of non-zero double scores in the given column.

getNonZeroIntScoreInRow

int getNonZeroIntScoreInRow(int row,
                            int index)

This method returns the integer score of the index-th non-zero cell in the given row. The index starts from zero.

Parameters:

row - the index of the row.

index - the index-th non-zero cell

Returns:

the integer score

getNonZeroIntScoreInColumn

int getNonZeroIntScoreInColumn(int column,
                               int index)

This method returns the integer score of the index-th non-zero cell in the given column. The index starts from zero. If the transposed matrix is not set yet, this method will automatically generate the transposed matrix. Thus, it may take several minutes.

Parameters:

column - the index of the column

index - the index-th non-zero cell

Returns:

the integer score

getNonZeroIntScoresInRow

int[] getNonZeroIntScoresInRow(int row)

If the given row has n non-zero cells, this method returns a n-length integer array. Each element of the array stores the integer score of the corresponding non-zero cell.

Parameters:

row - the index of row

Returns:

the array of non-zero integer scores in the given row

getNonZeroIntScoresInColumn

int[] getNonZeroIntScoresInColumn(int column)

If the given column has n non-zero cells, this method returns a n-length integer array. Each element of the array stores the integer score of the corresponding non-zero cell. If the transposed matrix is not set yet, this method will automatically generate the transposed matrix. Thus, it may take several minutes.

Parameters:

column - the index of the column

Returns:

the array of non-zero integer scores in the given column.

genCooccurrenceMatrix

boolean genCooccurrenceMatrix(IntSparseMatrix outputCooccurMatrix)

The cell (i,j) in the output cooccurrence matrix stores the cooccurrence count of the i-th row and the j-th row.

Parameters:

outputCooccurMatrix - the output cooccurrence matrix

Returns:

true if successfully

genCooccurrenceMatrix

boolean genCooccurrenceMatrix(SparseMatrix matrixY,
                              IntSparseMatrix outputCooccurMatrix)

The cell (i,j) in the output cooccurrence matrix stores the cooccurrence count of the i-th row in the current matrix and the j-th row in the matrixY. The current matrix and the input matrix should have the same number of columns.

Parameters:

matrixY - another sparse matrix

outputCooccurMatrix - the output cooccurrence matrix

Returns:

true if successfully

genCooccurrenceMatrix

boolean genCooccurrenceMatrix(SparseMatrix matrixY,
                              int minOccurrence,
                              IntSparseMatrix outputCooccurMatrix)

The cell (i,j) in the output cooccurrence matrix stores the cooccurrence count of the i-th row in the current matrix and the j-th row in the matrixY. The current matrix and the input matrix should have the same number of columns. If the cooccurrence count less than the given threshold, it will be set to zero.

Parameters:

matrixY - another sparse matrix

minOccurrence - the minimum cooccurrence count

outputCooccurMatrix - the output cooccurrence matrix

Returns:

true if successfully

getCell

Cell getCell(int row,
             int column)

If the specified cell doesn't exist, this method will return null.

Parameters:

row - the index of row in the matrix

column - the index of column in the matrix

Returns:

the cell

add

boolean add(Cell cell)

Add a cell to the sparse matrix. If the cell already exists in the sparse matrix, the behavior of the addition is subject to the implementations. It may simply add the score to the existing cell. It may return false. It may cause errors even if the method returns true. Thus, one should be cautious when adding possibly existing cells to the sparse matrix.

Parameters:

cell - the input cell

Returns:

true if successfully added.

flush

void flush()

Many implementations of sparse matrix cache cells in memory. This method gives the chance to dump cells in the cache to the disk file.

finalizeData

boolean finalizeData()

It is equal to calling finalizeData(true)

Returns:

true if finalizing successfully

finalizeData

boolean finalizeData(boolean sorting)

Any sparse matrix has two possible modes, writing mode and reading mode. After calling this method, writing is not allowed any more. Instead, one call read out data from the sparse matrix. In most cases, one should set the sorting option to true. In one case that all cells are added to the sparse matrix in their natural order (from top to bottom, from left to right), one can set the sorting option to false for saving time.

Parameters:

sorting - if need to sort the added cells before finalization.

Returns:

true if finalizing successfully

isFinalized

boolean isFinalized()

If this method returns true, one can not add data to the sparse matrix any more.

Returns:

true if finalized

createSparseMatrix

SparseMatrix createSparseMatrix()

This method return an empty sparse matrix with the same implemented type as the current matrix.

Returns:

an emtpy sparse matrix

createCell

Cell createCell(int row,
                int column,
                byte[] data)

This method will be called when the sparse matrix loads data from a binary file.

Parameters:

row - the row index of the cell

column - the column index of the cell

data - the input data for the cell

Returns:

cell object

createCell

Cell createCell(int row,
                int column,
                String data)

This method will be called when the sparse matrix loads data from a text file.

Parameters:

row - the row index of the cell

column - the column index of the cell

data - the input data for the cell

Returns:

cell object