dragon.matrix

Class AbstractFlatSparseMatrix

java.lang.Object

dragon.matrix.AbstractMatrix

dragon.matrix.AbstractSparseMatrix

dragon.matrix.AbstractFlatSparseMatrix

All Implemented Interfaces:

Matrix, SparseMatrix, Serializable

Direct Known Subclasses:

DoubleFlatSparseMatrix, IntFlatSparseMatrix

public abstract class AbstractFlatSparseMatrix
extends AbstractSparseMatrix
implements Serializable

Abstract flat sparse matrix handles sparse matrix smaller than super sparse matrix while adding options for read and store matrix data to disk either in text or binary format

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList	list

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
AbstractFlatSparseMatrix(boolean mergeMode, boolean miniMode, int cellDataLength)

Method Summary

Modifier and Type	Method and Description
boolean	add(Cell cell) Add a cell to the sparse matrix.
void	close() Close the matrix and release all resources.
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.
Cell	getCell(int row, int column) If the specified cell doesn't exist, this method will return null.
Cell	getNonZeroCell(int index)
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.
int	getNonZeroNum()
int	getNonZeroNumInRow(int row)
protected int	getRowEnd(int row)
protected int	getRowStart(int row)
void	print(PrintWriter out)
protected boolean	readBinaryMatrixFile(String filename)
protected boolean	readTextMatrixFile(String filename)
void	saveTo(String filename)
void	saveTo(String filename, boolean binary)
void	setDouble(int row, int column, double score)
void	setInt(int row, int column, int score)
void	setNonZeroDoubleScoreInRow(int row, int index, double score)
void	setNonZeroIntScoreInRow(int row, int index, int score)

Methods inherited from class dragon.matrix.AbstractSparseMatrix

cosine, finalizeData, genCooccurrenceMatrix, genCooccurrenceMatrix, genCooccurrenceMatrix, genTranslationMatrix, getCooccurrenceCount, getDouble, getInt, getNonZeroCellInColumn, getNonZeroDoubleScoreInColumn, getNonZeroDoubleScoreInRow, getNonZeroDoubleScoresInColumn, getNonZeroDoubleScoresInRow, 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

createCell, createCell, createSparseMatrix

Methods inherited from interface dragon.matrix.Matrix

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

Field Detail

list

protected ArrayList list

Constructor Detail

AbstractFlatSparseMatrix

public AbstractFlatSparseMatrix(boolean mergeMode,
                                boolean miniMode,
                                int cellDataLength)

Method Detail

getRowStart

protected int getRowStart(int row)

getRowEnd

protected int getRowEnd(int row)

close

public void close()

Description copied from interface: Matrix

Close the matrix and release all resources.

Specified by:

close in interface Matrix

getNonZeroNum

public int getNonZeroNum()

Specified by:

getNonZeroNum in interface SparseMatrix

Returns:

the number of non-zero cells

getNonZeroCell

public Cell getNonZeroCell(int index)

getCell

public Cell getCell(int row,
                    int column)

Description copied from interface: SparseMatrix

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

Specified by:

getCell in interface SparseMatrix

Parameters:

row - the index of row in the matrix

column - the index of column in the matrix

Returns:

the cell

getNonZeroCellInRow

public Cell getNonZeroCellInRow(int row,
                                int index)

Description copied from interface: SparseMatrix

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

Specified by:

getNonZeroCellInRow in interface SparseMatrix

Parameters:

row - the index of the row

index - the index-th non-zero cell

Returns:

the cell

getNonZeroNumInRow

public int getNonZeroNumInRow(int row)

Specified by:

getNonZeroNumInRow in interface SparseMatrix

Parameters:

row - the index of the row

Returns:

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

add

public boolean add(Cell cell)

Description copied from interface: SparseMatrix

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.

Specified by:

add in interface SparseMatrix

Parameters:

cell - the input cell

Returns:

true if successfully added.

getNonZeroColumnInRow

public int getNonZeroColumnInRow(int row,
                                 int index)

Description copied from interface: SparseMatrix

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

Specified by:

getNonZeroColumnInRow in interface SparseMatrix

Parameters:

row - the index of the row

index - the index-th non-zero cell

Returns:

the column index of the specified cell

getNonZeroColumnsInRow

public int[] getNonZeroColumnsInRow(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 column index of the corresponding non-zero cell.

Specified by:

getNonZeroColumnsInRow in interface SparseMatrix

Parameters:

row - the index of row

Returns:

the array of non-zero columns in the given row

setNonZeroDoubleScoreInRow

public void setNonZeroDoubleScoreInRow(int row,
                                       int index,
                                       double score)

setNonZeroIntScoreInRow

public void setNonZeroIntScoreInRow(int row,
                                    int index,
                                    int score)

setDouble

public void setDouble(int row,
                      int column,
                      double score)

setInt

public void setInt(int row,
                   int column,
                   int score)

flush

public void flush()

Description copied from interface: SparseMatrix

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

Specified by:

flush in interface SparseMatrix

finalizeData

public boolean finalizeData(boolean sorting)

Description copied from interface: SparseMatrix

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.

Specified by:

finalizeData in interface SparseMatrix

Parameters:

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

Returns:

true if finalizing successfully

saveTo

public void saveTo(String filename,
                   boolean binary)

saveTo

public void saveTo(String filename)

print

public void print(PrintWriter out)

readBinaryMatrixFile

protected boolean readBinaryMatrixFile(String filename)

readTextMatrixFile

protected boolean readTextMatrixFile(String filename)