edu.ucla.sspace.matrix

Class TransformStatistics

java.lang.Object

edu.ucla.sspace.matrix.TransformStatistics

public class TransformStatistics
extends Object

A static utility class used for gather statistics that are frequently used in matrix Transform implementations. Given a Matrix or a Matrix file, this class will gather row summations, column summations, and the total summation of the matrix. Optionally, when gathering either the row or column summations, the number of non zero values in the row or column can be counted instead of a full summation, which is needed for the TfIdfTransform.

Author:

Keith Stevens

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransformStatistics.MatrixStatistics A struct recording the row, column, and matrix summations as doubles.

Constructor Summary

Constructors

Constructor and Description
TransformStatistics()

Method Summary

Methods

Modifier and Type	Method and Description
static TransformStatistics.MatrixStatistics	extractStatistics(File inputMatrixFile, MatrixIO.Format format) Extracts the full row, column, and matrix summations based on entries in the given Matrix file.
static TransformStatistics.MatrixStatistics	extractStatistics(File inputMatrixFile, MatrixIO.Format format, boolean countRowOccurrances, boolean countColumnOccurrances) Extracts the row, column, and matrix summations based on entries in the given Matrix.
static TransformStatistics.MatrixStatistics	extractStatistics(Matrix matrix) Extracts the full row, column, and matrix summations based on entries in the given Matrix.
static TransformStatistics.MatrixStatistics	extractStatistics(Matrix matrix, boolean countRowOccurrances, boolean countColumnOccurrances) Extracts the row, column, and matrix summations based on entries in the given Matrix.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformStatistics

public TransformStatistics()

Method Detail

extractStatistics

public static TransformStatistics.MatrixStatistics extractStatistics(Matrix matrix)

Extracts the full row, column, and matrix summations based on entries in the given Matrix.

Parameters:

matrix - a to sum over

Returns:

a TransformStatistics.MatrixStatistics instance containing the summations

extractStatistics

public static TransformStatistics.MatrixStatistics extractStatistics(Matrix matrix,
                                                     boolean countRowOccurrances,
                                                     boolean countColumnOccurrances)

Extracts the row, column, and matrix summations based on entries in the given Matrix. If countRowOccurrances is true, the number of non zeros in each row will be counted for the row summation. If countColumnOccurrances is true, the same will be done for the columns. In either case, the matrix summation will remain the same.

Parameters:

matrix - a Matrix to sum over

countRowOccurrances - true if the row summation should only count the number of non zero values in a row

countColumnOccurrances - true if the column summation should only count the number of non zero values in a column

Returns:

a TransformStatistics.MatrixStatistics instance containing the summations

extractStatistics

public static TransformStatistics.MatrixStatistics extractStatistics(File inputMatrixFile,
                                                     MatrixIO.Format format)

Extracts the full row, column, and matrix summations based on entries in the given Matrix file.

Parameters:

inputMatrixFfile - a Matrix file to sum over

format - the matrix MatrixIO.Format of inputMatrixFile

Returns:

a TransformStatistics.MatrixStatistics instance containing the summations

extractStatistics

public static TransformStatistics.MatrixStatistics extractStatistics(File inputMatrixFile,
                                                     MatrixIO.Format format,
                                                     boolean countRowOccurrances,
                                                     boolean countColumnOccurrances)

Extracts the row, column, and matrix summations based on entries in the given Matrix. If countRowOccurrances is true, the number of non zeros in each row will be counted for the row summation. If countColumnOccurrances is true, the same will be done for the columns. In either case, the matrix summation will remain the same.

Parameters:

inputMatrixFfile - a Matrix file to sum over

format - the matrix MatrixIO.Format of inputMatrixFile

countRowOccurrances - true if the row summation should only count the number of non zero values in a row

countColumnOccurrances - true if the column summation should only count the number of non zero values in a column

Returns:

a TransformStatistics.MatrixStatistics instance containing the summations