Matrices (S-Space Package 2.0.1 API)

java.lang.Object
- edu.ucla.sspace.matrix.Matrices

```
public class Matrices
extends Object
```
A class of static methods for manipulating and creating Matrix instances.

See Also:
Matrix, MatrixIO

Method Summary

Methods
Modifier and Type	Method and Description
`static <T extends DoubleVector> Matrix`	`asMatrix(List<T> vectors)` Returns a `Matrix` from a list of `DoubleVector`s.
`static <T extends SparseDoubleVector> SparseMatrix`	`asSparseMatrix(List<T> vectors)` Returns a `SparseMatrix` from a list of `SparseDoubleVector`s.
`static <T extends SparseDoubleVector> SparseMatrix`	`asSparseMatrix(List<T> vectors, int columns)` Returns a `SparseMatrix` from a list of `SparseDoubleVector`s.
`static Matrix`	`copy(Matrix matrix)` Returns a copied version of a given matrix.
`static Matrix`	`copyTo(Matrix matrix, Matrix output)` Copies values from `matrix` to `output` and returns `output`.
`static Matrix`	`create(int rows, int cols, boolean isDense)` Creates a matrix of the given dimensions and selects the matrix implementation by considering the size and density of the new matrix with respect to the available memory for the JVM.
`static Matrix`	`create(int rows, int cols, Matrix.Type matrixType)` Creates a new `Matrix` based on the provided type, with the provided dimensions
`static MatrixBuilder`	`getMatrixBuilderForSVD()` Returns a `MatrixBuilder` in the default format of the fastest available `SVD algorithm`.
`static MatrixBuilder`	`getMatrixBuilderForSVD(boolean transpose)` Deprecated.
`static Matrix`	`multiply(Matrix m1, Matrix m2)`
`static Matrix`	`resize(Matrix matrix, int rows, int columns)` Returns a new `Matrix` that has been resized from the original, truncating values if smaller, or adding zero elements if larger.
`static AtomicMatrix`	`synchronizedMatrix(Matrix m)` Returns a synchronized (thread-safe) matrix backed by the provided `Matrix`.
`static AtomicMatrix`	`synchronizedSparseMatrix(SparseMatrix m)` Returns a synchronized (thread-safe) matrix backed by the provided `SparseMatrix`.
`static Matrix`	`transpose(Matrix matrix)` Returns the transpose of the input matrix, i.e.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - asMatrix
```
public static <T extends DoubleVector> Matrix asMatrix(List<T> vectors)
```
    Returns a Matrix from a list of DoubleVectors. The resulting matrix will be modifiable. Any modifications will affect the vectors stored in the passed in list.
  - asSparseMatrix
```
public static <T extends SparseDoubleVector> SparseMatrix asSparseMatrix(List<T> vectors)
```
    Returns a SparseMatrix from a list of SparseDoubleVectors. The resulting matrix will be modifiable. Any modifications will affect the vectors stored in the passed in list.
  - asSparseMatrix
```
public static <T extends SparseDoubleVector> SparseMatrix asSparseMatrix(List<T> vectors,
                                                         int columns)
```
    Returns a SparseMatrix from a list of SparseDoubleVectors. The resulting matrix will be modifiable. Any modifications will affect the vectors stored in the passed in list.
  - create
```
public static Matrix create(int rows,
            int cols,
            boolean isDense)
```
    Creates a matrix of the given dimensions and selects the matrix implementation by considering the size and density of the new matrix with respect to the available memory for the JVM.
    
    Parameters:
    rows - the number of rows in the matrix
    cols - the number of columns in the matrix
    isDense - whether the returned matrix will contain mostly non-zero elements
  - copy
```
public static Matrix copy(Matrix matrix)
```
    Returns a copied version of a given matrix. The returned matrix will have the same dimensionality, values, and sparsity, but it may not have the same exact sub-type.
    
    Parameters:
    matrix - the matrix to be copied
    
    Returns:
    a copied version of matrix
    
    Throws:
    
    IllegalArgumentException - when the dimensionality of matrix and output do not match
  - copyTo
```
public static Matrix copyTo(Matrix matrix,
            Matrix output)
```
    Copies values from matrix to output and returns output. output is assumed to be empty. This method is useful for uses who wish to specify the type of matrix used during a copy operation.
    
    Parameters:
    matrix - the matrix to be copied
    output - the matrix storing the copied values.
    
    Returns:
    output
    
    Throws:
    
    IllegalArgumentException - when the dimensionality of matrix and output do not match
  - create
```
public static Matrix create(int rows,
            int cols,
            Matrix.Type matrixType)
```
    Creates a new Matrix based on the provided type, with the provided dimensions
    
    Parameters:
    matrixType - the type of matrix to create
    rows - the number of rows in the matrix
    cols - the number of columns in the matrix
  - getMatrixBuilderForSVD
```
public static MatrixBuilder getMatrixBuilderForSVD()
```
    Returns a MatrixBuilder in the default format of the fastest available SVD algorithm.
    
    Returns:
    a matrix builder to be used in creating a matrix for use with the SVD class
  - getMatrixBuilderForSVD
```
@Deprecated
public static MatrixBuilder getMatrixBuilderForSVD(boolean transpose)
```
    Deprecated.
    
    Returns a MatrixBuilder in the default format of the fastest available SVD algorithm that will optionally transpose the matrix data on input
    
    Parameters:
    transpose - true if the input columns to the MatrixBuilder should be transposed (i.e. become rows) in the final matrix
    
    Returns:
    a matrix builder to be used in creating a matrix for use with the SVD class
  - multiply
```
public static Matrix multiply(Matrix m1,
              Matrix m2)
```
  - resize
```
public static Matrix resize(Matrix matrix,
            int rows,
            int columns)
```
    Returns a new Matrix that has been resized from the original, truncating values if smaller, or adding zero elements if larger.
  - synchronizedMatrix
```
public static AtomicMatrix synchronizedMatrix(Matrix m)
```
    Returns a synchronized (thread-safe) matrix backed by the provided Matrix.
    
    Parameters:
    m - the matrix to be made thread-safe
    
    Returns:
    a synchronized (thread-safe) view of the provided matrix.
  - synchronizedSparseMatrix
```
public static AtomicMatrix synchronizedSparseMatrix(SparseMatrix m)
```
    Returns a synchronized (thread-safe) matrix backed by the provided SparseMatrix.
    
    Parameters:
    m - the matrix to be made thread-safe
    
    Returns:
    a synchronized (thread-safe) view of the provided sparse matrix. The returned matrix will also be a SparseMatrix
  - transpose
```
public static Matrix transpose(Matrix matrix)
```
    Returns the transpose of the input matrix, i.e. where every element (i,j) in the output has the value of the element at (j,i) in the input.

Class Matrices

Method Summary

Methods inherited from class java.lang.Object

Method Detail

asMatrix

asSparseMatrix

asSparseMatrix

create

copy

copyTo

create

getMatrixBuilderForSVD

getMatrixBuilderForSVD

multiply

resize

synchronizedMatrix

synchronizedSparseMatrix

transpose