Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

DenseMatrixBase Class Template Reference
[linbox/matrix]

#include <dense.h>

Inheritance diagram for DenseMatrixBase:

DenseMatrix List of all members.

Detailed Description

template<class _Element>
class LinBox::DenseMatrixBase< _Element >

Blackbox dense matrix template. This is a class of dense matrices templatized by the entry type, the Element type of some field. The matrix is stored as a one dimensional STL vector of the elements, by rows. The interface provides for iteration over rows and over columns.

The class LinBox::Dense builds on this base.

Currently, only dense vectors are supported when doing matrix-vector applies.


Column of rows iterator

The column of rows iterator traverses the rows of the matrix in ascending order. Dereferencing the iterator yields a row vector in dense format

typedef Subvector< typename
Rep::iterator, typename Rep::const_iterator > 
Row
typedef Subvector< typename
Rep::const_iterator > 
ConstRow
RowIterator rowBegin ()
RowIterator rowEnd ()
ConstRowIterator rowBegin () const
ConstRowIterator rowEnd () const

Row of columns iterator

The row of columns iterator traverses the columns of the matrix in ascending order. Dereferencing the iterator yields a column vector in dense format

typedef Subvector< Subiterator<
typename Rep::iterator > > 
Col
typedef Subvector< Subiterator<
typename Rep::const_iterator > > 
ConstCol
typedef Col Column
typedef ConstCol ConstColumn
typedef Rep::iterator RawIterator
typedef Rep::const_iterator ConstRawIterator
ColIterator colBegin ()
ColIterator colEnd ()
ConstColIterator colBegin () const
ConstColIterator colEnd () const
RawIterator rawBegin ()
RawIterator rawEnd ()
ConstRawIterator rawBegin () const
ConstRawIterator rawEnd () const
RawIndexedIterator rawIndexedBegin ()
RawIndexedIterator rawIndexedEnd ()
ConstRawIndexedIterator rawIndexedBegin () const
ConstRawIndexedIterator rawIndexedEnd () const
Row operator[] (size_t i)
ConstRow operator[] (size_t i) const
template<class Vector> Vector & columnDensity (Vector &v) const
std::vector< Element > _rep
size_t _rows
size_t _cols
Element * _ptr

Public Member Functions

 DenseMatrixBase (size_t m, size_t n)
template<class Field>  DenseMatrixBase (MatrixStream< Field > &ms)
Element * FullIterator () const
size_t rowdim () const
size_t coldim () const
void resize (size_t m, size_t n, const Element &val=Element())
template<class Field> std::istream & read (std::istream &file, const Field &F)
template<class Field> std::ostream & write (std::ostream &os, const Field &F) const
void setEntry (size_t i, size_t j, const Element &a_ij)
Element & refEntry (size_t i, size_t j)
const Element & getEntry (size_t i, size_t j) const
Element & getEntry (Element &x, size_t i, size_t j) const


Member Typedef Documentation

typedef Rep::iterator RawIterator
 

The raw iterator is a method for accessing all entries in the matrix in some unspecified order. This can be used, e.g. to reduce all matrix entries modulo a prime before passing the matrix into an algorithm.

Reimplemented in DenseMatrix, and DenseMatrix< Field >.


Constructor & Destructor Documentation

DenseMatrixBase size_t  m,
size_t  n
[inline]
 

Constructor.

Parameters:
m row dimension
n column dimension

DenseMatrixBase MatrixStream< Field > &  ms  ) 
 

Constructor from a matrix stream


Member Function Documentation

Element* FullIterator  )  const [inline]
 

Get a pointer on the storage of the elements

Returns:
a pointer on Elements /todo What is this?

size_t rowdim  )  const [inline]
 

Get the number of rows in the matrix

Returns:
Number of rows in matrix

Reimplemented in DenseMatrix, and DenseMatrix< Field >.

size_t coldim  )  const [inline]
 

Get the number of columns in the matrix

Returns:
Number of columns in matrix

Reimplemented in DenseMatrix, and DenseMatrix< Field >.

void resize size_t  m,
size_t  n,
const Element &  val = Element()
[inline]
 

Resize the matrix to the given dimensions The state of the matrix's entries after a call to this method is undefined

Parameters:
m Number of rows
n Number of columns

std::istream& read std::istream &  file,
const Field &  F
 

Read the matrix from an input stream

Parameters:
file Input stream from which to read
F Field over which to read

std::ostream& write std::ostream &  os,
const Field &  F
const
 

Write the matrix to an output stream

Parameters:
os Output stream to which to write
F Field over which to write

void setEntry size_t  i,
size_t  j,
const Element &  a_ij
[inline]
 

Set the entry at the (i, j) position to a_ij.

Parameters:
i Row number, 0...rowdim () - 1
j Column number 0...coldim () - 1
a_ij Element to set

Element& refEntry size_t  i,
size_t  j
[inline]
 

Get a writeable reference to the entry in the (i, j) position.

Parameters:
i Row index of entry
j Column index of entry
Returns:
Reference to matrix entry

const Element& getEntry size_t  i,
size_t  j
const [inline]
 

Get a read-only reference to the entry in the (i, j) position.

Parameters:
i Row index
j Column index
Returns:
Const reference to matrix entry

Element& getEntry Element &  x,
size_t  i,
size_t  j
const [inline]
 

Copy the (i, j) entry into x, and return a reference to x. This form is more in the Linbox style and is provided for interface compatibility with other parts of the library

Parameters:
x Element in which to store result
i Row index
j Column index
Returns:
Reference to x

Row operator[] size_t  i  )  [inline]
 

Retrieve a reference to a row. Since rows may also be indexed, this allows A[i][j] notation to be used.

Parameters:
i Row index

Vector& columnDensity Vector &  v  )  const [inline]
 

Compute column density


The documentation for this class was generated from the following file:
Generated on Thu Feb 8 22:33:05 2007 for linbox by doxygen 1.3.4