edu.ucla.sspace.matrix

Interface Transform

All Known Implementing Classes:

BaseTransform, CorrelationTransform, LogEntropyTransform, LogLikelihoodTransform, NoTransform, PointWiseMutualInformationTransform, RowMagnitudeTransform, TfIdfDocStripedTransform, TfIdfTransform

public interface Transform

An interface for Matrix transformations. These tranformations should support both a Matrix and a serialized Matrix stored in a File, in one of the supported matrix formats. Implementations are strongly encouraged to implement the toString method, as many SemanticSpace implementations will use this when serializing.

Author:

David Jurgens

Method Summary

Methods

Modifier and Type	Method and Description
File	transform(File inputMatrixFile, MatrixIO.Format format) Transforms the matrix in the file using the an implemented method and returns a temporary file containing the result.
void	transform(File inputMatrixFile, MatrixIO.Format inputFormat, File outputMatrixFile) Transforms the input matrix using the implemented method and writes the result to the file for the output matrix.
Matrix	transform(Matrix input) Returns a transformed matrix based on the given matrix.
Matrix	transform(Matrix input, Matrix output) Returns a transformed matrix based on the given matrix.

Method Detail

transform

File transform(File inputMatrixFile,
             MatrixIO.Format format)
               throws IOException

Transforms the matrix in the file using the an implemented method and returns a temporary file containing the result.

Parameters:

inputMatrixFile - a file containing a matrix in the specified format

format - the format of the matrix

Returns:

a file with the transformed version of the input. This file is marked to be deleted when the JVM exits.

Throws:

IOException - if any error occurs while reading the input matrix or writing the output matrix

transform

void transform(File inputMatrixFile,
             MatrixIO.Format inputFormat,
             File outputMatrixFile)
               throws IOException

Transforms the input matrix using the implemented method and writes the result to the file for the output matrix.

Parameters:

inputMatrixFile - a file containing a matrix in the specified format

inputFormat - the format of the input matrix, and the format in which the output matrix will be written

outputMatrixFile - the file to which the transformed matrix will be written

Throws:

IOException - if any error occurs while reading the input matrix or writing the output matrix

transform

Matrix transform(Matrix input)

Returns a transformed matrix based on the given matrix. By default, algorithms will store the transformed values in place. Since a few algorithms cannot be done in place, this is optional. (optional operation).

Parameters:

input - the matrix to be transformed

Returns:

a pointer to input after it has been transformed

transform

Matrix transform(Matrix input,
               Matrix output)

Returns a transformed matrix based on the given matrix.

Parameters:

input - the matrix to be transformed

output - values transformed from input will be stored in this matrix

Returns:

output, the transformed version of the input matrix