no.uib.cipr.matrix.sparse

Class FlexCompColMatrix

java.lang.Object

no.uib.cipr.matrix.AbstractMatrix

no.uib.cipr.matrix.sparse.FlexCompColMatrix

All Implemented Interfaces:

Iterable<MatrixEntry>, Matrix

public class FlexCompColMatrix
extends AbstractMatrix

Matrix stored column-wise into sparse vectors

Nested Class Summary

Nested classes/interfaces inherited from interface no.uib.cipr.matrix.Matrix

Matrix.Norm

Field Summary

Fields inherited from class no.uib.cipr.matrix.AbstractMatrix

numColumns, numRows

Constructor Summary

Constructors

Constructor and Description
FlexCompColMatrix(int numRows, int numColumns) Constructor for FlexCompColMatrix
FlexCompColMatrix(Matrix A) Constructor for FlexCompColMatrix
FlexCompColMatrix(Matrix A, boolean deep) Constructor for FlexCompColMatrix

Method Summary

Modifier and Type	Method and Description
void	add(int row, int column, double value) A(row,column) += value
void	compact() Tries to store the matrix as compactly as possible
FlexCompColMatrix	copy() Creates a deep copy of the matrix
double	get(int row, int column) Returns A(row,column)
SparseVector	getColumn(int i) Returns the given column
Iterator<MatrixEntry>	iterator()
Vector	multAdd(double alpha, Vector x, Vector y) y = alpha*A*x + y
void	set(int row, int column, double value) A(row,column) = value
void	setColumn(int i, SparseVector x) Sets the given column equal the passed vector
Vector	transMultAdd(double alpha, Vector x, Vector y) y = alpha*AT*x + y
FlexCompColMatrix	zero() Zeros all the entries in the matrix, while preserving any underlying structure.

Methods inherited from class no.uib.cipr.matrix.AbstractMatrix

add, add, check, checkMultAdd, checkMultAdd, checkRank1, checkRank1, checkRank2, checkRank2, checkSize, checkSolve, checkSolve, checkTransABmultAdd, checkTransAmultAdd, checkTransBmultAdd, checkTransMultAdd, checkTranspose, checkTranspose, checkTransRank1, checkTransRank2, isSquare, max, max, mult, mult, mult, mult, multAdd, multAdd, multAdd, norm, norm1, normF, normInf, numColumns, numRows, rank1, rank1, rank1, rank1, rank1, rank1, rank2, rank2, rank2, rank2, scale, set, set, solve, solve, toString, transABmult, transABmult, transABmultAdd, transABmultAdd, transAmult, transAmult, transAmultAdd, transAmultAdd, transBmult, transBmult, transBmultAdd, transBmultAdd, transMult, transMult, transMultAdd, transpose, transpose, transRank1, transRank1, transRank2, transRank2, transSolve, transSolve

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FlexCompColMatrix

public FlexCompColMatrix(int numRows,
                         int numColumns)

Constructor for FlexCompColMatrix

Parameters:

numRows - Number of rows

numColumns - Number of column

FlexCompColMatrix

public FlexCompColMatrix(Matrix A,
                         boolean deep)

Constructor for FlexCompColMatrix

Parameters:

A - Matrix to copy contents from

deep - True for a deep copy, false for a reference copy. A reference copy can only be made of an FlexCompColMatrix

FlexCompColMatrix

public FlexCompColMatrix(Matrix A)

Constructor for FlexCompColMatrix

Parameters:

A - Matrix to copy contents from. The copy will be deep

Method Detail

getColumn

public SparseVector getColumn(int i)

Returns the given column

setColumn

public void setColumn(int i,
                      SparseVector x)

Sets the given column equal the passed vector

multAdd

public Vector multAdd(double alpha,
                      Vector x,
                      Vector y)

Description copied from interface: Matrix

y = alpha*A*x + y

Specified by:

multAdd in interface Matrix

Overrides:

multAdd in class AbstractMatrix

x - Vector of size A.numColumns()

y - Vector of size A.numRows()

Returns:

y

transMultAdd

public Vector transMultAdd(double alpha,
                           Vector x,
                           Vector y)

Description copied from interface: Matrix

y = alpha*AT*x + y

Specified by:

transMultAdd in interface Matrix

Overrides:

transMultAdd in class AbstractMatrix

x - Vector of size A.numRows()

y - Vector of size A.numColumns()

Returns:

y

add

public void add(int row,
                int column,
                double value)

Description copied from interface: Matrix

A(row,column) += value

Specified by:

add in interface Matrix

Overrides:

add in class AbstractMatrix

set

public void set(int row,
                int column,
                double value)

Description copied from interface: Matrix

A(row,column) = value

Specified by:

set in interface Matrix

Overrides:

set in class AbstractMatrix

get

public double get(int row,
                  int column)

Description copied from interface: Matrix

Returns A(row,column)

Specified by:

get in interface Matrix

Overrides:

get in class AbstractMatrix

iterator

public Iterator<MatrixEntry> iterator()

Specified by:

iterator in interface Iterable<MatrixEntry>

Overrides:

iterator in class AbstractMatrix

copy

public FlexCompColMatrix copy()

Description copied from interface: Matrix

Creates a deep copy of the matrix

Specified by:

copy in interface Matrix

Overrides:

copy in class AbstractMatrix

Returns:

A

zero

public FlexCompColMatrix zero()

Description copied from interface: Matrix

Zeros all the entries in the matrix, while preserving any underlying structure. Useful for general, unstructured matrices.

Specified by:

zero in interface Matrix

Overrides:

zero in class AbstractMatrix

Returns:

A

compact

public void compact()

Tries to store the matrix as compactly as possible