Matrix (Dragontool 1.3.3 API)

All Known Subinterfaces:

DenseMatrix, DoubleDenseMatrix, DoubleSparseMatrix, IntDenseMatrix, IntSparseMatrix, SparseMatrix

All Known Implementing Classes:

AbstractDenseMatrix, AbstractFlatSparseMatrix, AbstractGiantSparseMatrix, AbstractMatrix, AbstractSparseMatrix, AbstractSuperSparseMatrix, DoubleFlatDenseMatrix, DoubleFlatSparseMatrix, DoubleGiantSparseMatrix, DoubleSuperSparseMatrix, IntFlatDenseMatrix, IntFlatSparseMatrix, IntGiantSparseMatrix, IntSuperSparseMatrix
```
public interface Matrix
```
Interface of matrix including dense matrix and sparse matrix

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Close the matrix and release all resources.
`int`	`columns()`
`double`	`cosine(int rowA, int rowB)` This method treats each row a vector and return the cosine similarity of two rows.
`int`	`getBaseColumn()` The index of the first column in a matrix is zero.
`int`	`getBaseRow()` The index of the first row in a matrix is zero.
`int`	`getCellDataLength()` For double matrix, this method returns 8; for integer matrix, it returns 4.
`int`	`getCooccurrenceCount(int rowA, int rowB)` If two cells in the same column have non-zero scores, they will be counted as co-occurred.
`double`	`getDouble(int row, int column)` Return the score stored in the specified cell.
`int`	`getInt(int row, int column)` Return the score stored in the specified cell.
`Matrix`	`getTranspose()` If one never calls niether the method of setTranspose nor the method of transpose, it returns null.
`int`	`rows()`
`void`	`setTranspose(Matrix matrix)` Manually set the transposed matrix.
`Matrix`	`transpose()` if one has set the transposed matrix by calling the method setTranspose, this method simply return that transposed matrix.

- Method Detail
  - rows
```
int rows()
```
    Returns:
    
    number of rows
  - columns
```
int columns()
```
    Returns:
    
    number of columns
  - getBaseRow
```
int getBaseRow()
```
    The index of the first row in a matrix is zero. The base row is the index of the first non-empty row of the matrix.
    
    Returns:
    
    the index of the first non-empty row of the matrix.
  - getBaseColumn
```
int getBaseColumn()
```
    The index of the first column in a matrix is zero. The base column is the index of the first non-empty column of the matrix. This method is not used in this version. It always simply returns zero.
    
    Returns:
    
    zero.
  - getCellDataLength
```
int getCellDataLength()
```
    For double matrix, this method returns 8; for integer matrix, it returns 4.
    
    Returns:
    
    the length in bytes of the data stored in the cell.
  - getInt
```
int getInt(int row,
           int column)
```
    Return the score stored in the specified cell. If the score is double-typed, it will be coverted to an integer.
    
    Parameters:
    
    row - the row index of the cell
    
    column - the column index of the cell
    
    Returns:
    
    the score stored in the cell
  - getDouble
```
double getDouble(int row,
                 int column)
```
    Return the score stored in the specified cell. If the score is integer-typed, it will be coverted to a double.
    
    Parameters:
    
    row - the row index of the cell
    
    column - the column index of the cell
    
    Returns:
    
    the score stored in the cell
  - cosine
```
double cosine(int rowA,
              int rowB)
```
    This method treats each row a vector and return the cosine similarity of two rows.
    
    Parameters:
    
    rowA - the row index of the first vector
    
    rowB - the row index of the second vector
    
    Returns:
    
    the cosine similarity of two given rows.
  - getCooccurrenceCount
```
int getCooccurrenceCount(int rowA,
                         int rowB)
```
    If two cells in the same column have non-zero scores, they will be counted as co-occurred.
    
    Parameters:
    
    rowA - the index of the first row
    
    rowB - the index of the second row
    
    Returns:
    
    the cooccurrence count
  - transpose
```
Matrix transpose()
```
    if one has set the transposed matrix by calling the method setTranspose, this method simply return that transposed matrix. Otherwise, it will generate the transposed matrix online. So this method may take several minutes.
    
    Returns:
    
    the transposed matrix
  - getTranspose
```
Matrix getTranspose()
```
    If one never calls niether the method of setTranspose nor the method of transpose, it returns null.
    
    Returns:
    
    the transpose matrix
  - setTranspose
```
void setTranspose(Matrix matrix)
```
    Manually set the transposed matrix.
    
    Parameters:
    
    matrix - the transpose matrix of the current matrix.
  - close
```
void close()
```
    Close the matrix and release all resources.

Interface Matrix

Method Summary

Method Detail

rows

columns

getBaseRow

getBaseColumn

getCellDataLength

getInt

getDouble

cosine

getCooccurrenceCount

transpose

getTranspose

setTranspose

close