cat.lump.ir.retrievalmodels.similarity

Class SimilarityMatrix

java.lang.Object

cat.lump.ir.retrievalmodels.similarity.SimilarityMatrix

All Implemented Interfaces:

java.io.Serializable

public class SimilarityMatrix
extends java.lang.Object
implements java.io.Serializable

This class represents a matrix of similarities. Each position stores the similarity between two fragments. The rows represents the source fragments and the columns the target fragments.
For example, the position matrix(0,1) contains the similarity between the first source fragment and the second target fragment.

Author:

jboldoba

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimilarityMatrix(int rows, int cols) Creates a matrix filled with zeros with the size given by the parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int row, int col, double value) Adds the value to the current value of the position given by row and col
void	div(int row, int col, double value) Divides the current value of the position given by row and col by the indicated value
static SimilarityMatrix	getFromFile(java.io.File file, boolean binary) Loads a similarity matrix froma binary a file.
double[][]	getMatrix()
int	getNCols()
int	getNRows()
double	getSimilarity(int row, int col)
int	getSize()
SimilarityMatrixIterator	iterator()
void	serialize(java.io.File output) Saves this object in a file as binary raw data.
void	setMatrix(double[][] matrix)
void	setSimilarity(int row, int col, float value) Changes the value of the position of the matrix given by row and col.
void	toFile(java.io.File output) Writes the matrix as text in a given file
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimilarityMatrix

public SimilarityMatrix(int rows,
                int cols)

Creates a matrix filled with zeros with the size given by the parameters. Any size can be zero.

Parameters:

rows - Number of rows of the matrix. (Number of source fragments)

cols - Number of columns of the matrix. (Number of target fragments)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toFile

public void toFile(java.io.File output)
            throws java.io.IOException

Writes the matrix as text in a given file

Parameters:

output - The wile wherein the matrix must be written

Throws:

java.io.IOException - If happens any problem during the writing

serialize

public void serialize(java.io.File output)
               throws java.io.IOException

Saves this object in a file as binary raw data.

Parameters:

output - The file wherein the matrix will be saved

Throws:

java.io.IOException

add

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

Adds the value to the current value of the position given by row and col

Parameters:

row - Row index

col - Column index

value - Value to add

div

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

Divides the current value of the position given by row and col by the indicated value

Parameters:

row - Row index

col - Column index

value - Divisor

setSimilarity

public void setSimilarity(int row,
                 int col,
                 float value)

Changes the value of the position of the matrix given by row and col.

Parameters:

row - Index of the row

col - Index of the column

value - New value for the given position

setMatrix

public void setMatrix(double[][] matrix)

Parameters:

matrix - the new similarity matrix

getFromFile

public static SimilarityMatrix getFromFile(java.io.File file,
                           boolean binary)
                                    throws java.lang.ClassNotFoundException,
                                           java.io.IOException

Loads a similarity matrix froma binary a file.

Parameters:

file - File wherein the matrix is saved

binary - Indicates if the matrix is saved as binary data ( binary = true) or as text (binary = false)

Returns:

The similarity matrix contained in file

Throws:

java.lang.ClassNotFoundException

java.io.IOException

getSimilarity

public double getSimilarity(int row,
                   int col)

Parameters:

row - Index of the row

col - Index of the column

Returns:

The value stored in the position of the matrix given by row and col

getNRows

public int getNRows()

getNCols

public int getNCols()

getSize

public int getSize()

iterator

public SimilarityMatrixIterator iterator()

getMatrix

public double[][] getMatrix()

Returns:

the similarity matrix