dragon.matrix

Class DoubleSuperSparseMatrix

java.lang.Object

dragon.matrix.AbstractMatrix

dragon.matrix.AbstractSparseMatrix

dragon.matrix.AbstractSuperSparseMatrix

dragon.matrix.DoubleSuperSparseMatrix

All Implemented Interfaces:

DoubleSparseMatrix, Matrix, SparseMatrix, Serializable

public class DoubleSuperSparseMatrix
extends AbstractSuperSparseMatrix
implements DoubleSparseMatrix

Super sparse matrix for double data type

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
DoubleSuperSparseMatrix(String matrixFile)
DoubleSuperSparseMatrix(String matrixFile, boolean mergeMode, boolean miniMode)
DoubleSuperSparseMatrix(String indexFile, String matrixFile)
DoubleSuperSparseMatrix(String indexFile, String matrixFile, boolean mergeMode, boolean miniMode)

Method Summary

Modifier and Type	Method and Description
boolean	add(int row, int column, double score) It is equal to create a double 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.
double	getColumnSum(int column)
double	getDouble(int row, int column) Return the score stored in the specified cell.
double	getNonZeroDoubleScoreInRow(int row, int index) This method returns the double score of the index-th non-zero cell in the given row.
double[]	getNonZeroDoubleScoresInRow(int row) If the given row has n non-zero cells, this method returns a n-length double array.
double	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, getInt, getNonZeroCellInColumn, getNonZeroDoubleScoreInColumn, getNonZeroDoubleScoresInColumn, getNonZeroIntScoreInColumn, getNonZeroIntScoreInRow, getNonZeroIntScoresInColumn, getNonZeroIntScoresInRow, 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, getNonZeroDoubleScoresInColumn, getNonZeroIntScoreInColumn, getNonZeroIntScoreInRow, getNonZeroIntScoresInColumn, getNonZeroIntScoresInRow, getNonZeroNum, getNonZeroNumInColumn, getNonZeroNumInRow, getNonZeroRowInColumn, getNonZeroRowsInColumn, isFinalized

Methods inherited from interface dragon.matrix.Matrix

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

Constructor Detail

DoubleSuperSparseMatrix

public DoubleSuperSparseMatrix(String matrixFile)

DoubleSuperSparseMatrix

public DoubleSuperSparseMatrix(String indexFile,
                               String matrixFile)

DoubleSuperSparseMatrix

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

DoubleSuperSparseMatrix

public DoubleSuperSparseMatrix(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,
                   double score)

Description copied from interface: DoubleSparseMatrix

It is equal to create a double cell and then add the cell to the sparse matrix.

Specified by:

add in interface DoubleSparseMatrix

Parameters:

row - the row of the cell

column - the column of the cell

score - the score of the cell

Returns:

true if added successfully

getDouble

public double getDouble(int row,
                        int column)

Description copied from interface: Matrix

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

Specified by:

getDouble in interface Matrix

Overrides:

getDouble 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

getNonZeroDoubleScoreInRow

public double getNonZeroDoubleScoreInRow(int row,
                                         int index)

Description copied from interface: SparseMatrix

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

Specified by:

getNonZeroDoubleScoreInRow in interface SparseMatrix

Overrides:

getNonZeroDoubleScoreInRow in class AbstractSparseMatrix

Parameters:

row - the index of the row.

index - the index-th non-zero cell

Returns:

the double score

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 double getRowSum(int row)

Specified by:

getRowSum in interface DoubleSparseMatrix

Parameters:

row - the index of the row

Returns:

the summation score of the given row.

getColumnSum

public double getColumnSum(int column)