edu.ucla.sspace.matrix

Class BaseTransform

java.lang.Object

edu.ucla.sspace.matrix.BaseTransform

All Implemented Interfaces:

Transform

Direct Known Subclasses:

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

public abstract class BaseTransform
extends Object
implements Transform

An abstract Transform implemenation that most transforms can extend. Any transform that can be implemented as a GlobalTransform can simply define the a GlobalTransform and then subclass this abstract class to adhere to the standard Transform interface.

Constructor Summary

Constructors

Constructor and Description
BaseTransform()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract GlobalTransform	getTransform(File inputMatrixFile, MatrixIO.Format format) Returns a GlobalTransform for a File of the given format.
protected abstract GlobalTransform	getTransform(Matrix matrix) Returns a GlobalTransform for a Matrix.
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 format, File outputMatrixFile) Transforms the input matrix using the implemented method and writes the result to the file for the output matrix.
Matrix	transform(Matrix matrix) Returns a transformed matrix based on the given matrix.
Matrix	transform(Matrix matrix, Matrix transformed) Returns a transformed matrix based on the given matrix.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTransform

public BaseTransform()

Method Detail

transform

public 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.

Specified by:

transform in interface Transform

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

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

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

Specified by:

transform in interface Transform

Parameters:

inputMatrixFile - a file containing a matrix in the specified format

format - 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

public Matrix transform(Matrix matrix)

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).

Specified by:

transform in interface Transform

Parameters:

matrix - the matrix to be transformed

Returns:

a pointer to input after it has been transformed

transform

public Matrix transform(Matrix matrix,
               Matrix transformed)

Returns a transformed matrix based on the given matrix.

Specified by:

transform in interface Transform

Parameters:

matrix - the matrix to be transformed

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

Returns:

output, the transformed version of the input matrix

getTransform

protected abstract GlobalTransform getTransform(Matrix matrix)

Returns a GlobalTransform for a Matrix.

getTransform

protected abstract GlobalTransform getTransform(File inputMatrixFile,
                           MatrixIO.Format format)

Returns a GlobalTransform for a File of the given format.