dragon.matrix

Class IntSuperSparseMatrix

java.lang.Object

dragon.matrix.AbstractMatrix

dragon.matrix.AbstractSparseMatrix

dragon.matrix.AbstractSuperSparseMatrix

dragon.matrix.IntSuperSparseMatrix

All Implemented Interfaces:

IntSparseMatrix, Matrix, SparseMatrix, Serializable

public class IntSuperSparseMatrix
extends AbstractSuperSparseMatrix
implements IntSparseMatrix

Super sparse matrix for integer data

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

See Also:

Serialized Form

Field Summary

Fields inherited from class dragon.matrix.AbstractSuperSparseMatrix

arrCachedRow, arrRowLoadFactor, arrRowPosInCache, arrRowPosInFile, arrRowStart, cacheMatrix, cacheSize, firstEmpty, flushInterval, indexFilename, matrix, matrixFactory, matrixFilename, totalCell

Fields inherited from class dragon.matrix.AbstractSparseMatrix

isFinalized, mergeMode, miniMode

Fields inherited from class dragon.matrix.AbstractMatrix

cellDataLength, columnBase, columns, rowBase, rows, transposeMatrix

Constructor Summary

Constructors

Constructor and Description
IntSuperSparseMatrix(String matrixFile)
IntSuperSparseMatrix(String matrixFile, boolean mergeMode, boolean miniMode)
IntSuperSparseMatrix(String indexFile, String matrixFile)
IntSuperSparseMatrix(String indexFile, String matrixFile, boolean mergeMode, boolean miniMode)

Method Summary

Modifier and Type	Method and Description
boolean	add(int row, int column, int score) It is equal to create an integer cell and then add the 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.
protected AbstractFlatSparseMatrix	createFlatSparseMatrix(boolean mergeMode, boolean miniMode)
protected Row	createRow(int row, int columns, byte[] data)
SparseMatrix	createSparseMatrix() This method return an empty sparse matrix with the same implemented type as the current matrix.
long	getColumnSum(int column)
int	getInt(int row, int column) Return the score stored in the specified cell.
double[]	getNonZeroDoubleScoresInRow(int row) If the given row has n non-zero cells, this method returns a n-length double array.
int	getNonZeroIntScoreInRow(int row, int index) This method returns the integer score of the index-th non-zero cell in the given row.
int[]	getNonZeroIntScoresInRow(int row) If the given row has n non-zero cells, this method returns a n-length integer array.
long	getRowSum(int row)

Methods inherited from class dragon.matrix.AbstractSuperSparseMatrix

add, close, finalizeData, flush, getCell, getIndexFilename, getMatrixFilename, getNonZeroCellInRow, getNonZeroColumnInRow, getNonZeroColumnsInRow, getNonZeroNum, getNonZeroNumInRow, getRow, setCache, setFlushInterval

Methods inherited from class dragon.matrix.AbstractSparseMatrix

cosine, finalizeData, genCooccurrenceMatrix, genCooccurrenceMatrix, genCooccurrenceMatrix, genTranslationMatrix, getCooccurrenceCount, getDouble, getNonZeroCellInColumn, getNonZeroDoubleScoreInColumn, getNonZeroDoubleScoreInRow, getNonZeroDoubleScoresInColumn, getNonZeroIntScoreInColumn, getNonZeroIntScoresInColumn, getNonZeroNumInColumn, getNonZeroRowInColumn, getNonZeroRowsInColumn, isFinalized, transpose

Methods inherited from class dragon.matrix.AbstractMatrix

columns, getBaseColumn, getBaseRow, getCellDataLength, getTranspose, rows, setTranspose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dragon.matrix.SparseMatrix

add, finalizeData, finalizeData, flush, genCooccurrenceMatrix, genCooccurrenceMatrix, genCooccurrenceMatrix, getCell, getNonZeroCellInColumn, getNonZeroCellInRow, getNonZeroColumnInRow, getNonZeroColumnsInRow, getNonZeroDoubleScoreInColumn, getNonZeroDoubleScoreInRow, getNonZeroDoubleScoresInColumn, getNonZeroIntScoreInColumn, getNonZeroIntScoresInColumn, getNonZeroNum, getNonZeroNumInColumn, getNonZeroNumInRow, getNonZeroRowInColumn, getNonZeroRowsInColumn, isFinalized

Methods inherited from interface dragon.matrix.Matrix

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

Constructor Detail

IntSuperSparseMatrix

public IntSuperSparseMatrix(String matrixFile)

IntSuperSparseMatrix

public IntSuperSparseMatrix(String indexFile,
                            String matrixFile)

IntSuperSparseMatrix

public IntSuperSparseMatrix(String matrixFile,
                            boolean mergeMode,
                            boolean miniMode)

IntSuperSparseMatrix

public IntSuperSparseMatrix(String indexFile,
                            String matrixFile,
                            boolean mergeMode,
                            boolean miniMode)

Method Detail

createSparseMatrix

public SparseMatrix createSparseMatrix()

Description copied from interface: SparseMatrix

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

Specified by:

createSparseMatrix in interface SparseMatrix

Returns:

an emtpy sparse matrix

createFlatSparseMatrix

protected AbstractFlatSparseMatrix createFlatSparseMatrix(boolean mergeMode,
                                                          boolean miniMode)

Specified by:

createFlatSparseMatrix in class AbstractSuperSparseMatrix

createRow

protected Row createRow(int row,
                        int columns,
                        byte[] data)

Specified by:

createRow in class AbstractSuperSparseMatrix

createCell

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

Description copied from interface: SparseMatrix

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

Specified by:

createCell in interface SparseMatrix

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

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

Description copied from interface: SparseMatrix

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

Specified by:

createCell in interface SparseMatrix

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

add

public boolean add(int row,
                   int column,
                   int score)

Description copied from interface: IntSparseMatrix

It is equal to create an integer cell and then add the cell to the sparse matrix.

Specified by:

add in interface IntSparseMatrix

Parameters:

row - the row of the cell

column - the column of the cell

score - the score of the cell

Returns:

true if added successfully

getInt

public int getInt(int row,
                  int column)

Description copied from interface: Matrix

Return the score stored in the specified cell. If the score is double-typed, it will be coverted to an integer.

Specified by:

getInt in interface Matrix

Overrides:

getInt in class AbstractSparseMatrix

Parameters:

row - the row index of the cell

column - the column index of the cell

Returns:

the score stored in the cell

getNonZeroIntScoreInRow

public int getNonZeroIntScoreInRow(int row,
                                   int index)

Description copied from interface: SparseMatrix

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

Specified by:

getNonZeroIntScoreInRow in interface SparseMatrix

Overrides:

getNonZeroIntScoreInRow in class AbstractSparseMatrix

Parameters:

row - the index of the row.

index - the index-th non-zero cell

Returns:

the integer score

getNonZeroIntScoresInRow

public int[] getNonZeroIntScoresInRow(int row)

Description copied from interface: SparseMatrix

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.

Specified by:

getNonZeroIntScoresInRow in interface SparseMatrix

Overrides:

getNonZeroIntScoresInRow in class AbstractSparseMatrix

Parameters:

row - the index of row

Returns:

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

getNonZeroDoubleScoresInRow

public double[] getNonZeroDoubleScoresInRow(int row)

Description copied from interface: SparseMatrix

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.

Specified by:

getNonZeroDoubleScoresInRow in interface SparseMatrix

Overrides:

getNonZeroDoubleScoresInRow in class AbstractSparseMatrix

Parameters:

row - the index of row

Returns:

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

getRowSum

public long getRowSum(int row)

Specified by:

getRowSum in interface IntSparseMatrix

Parameters:

row - the index of the row

Returns:

the summation score of the given row.

getColumnSum

public long getColumnSum(int column)