linbox  1
Public Member Functions
TransposeMatrix< Matrix, Trait > Class Template Reference

#include <transpose-matrix.h>

List of all members.

Public Member Functions

 TransposeMatrix (Matrix &A)
 TransposeMatrix (const TransposeMatrix &M)
size_t rowdim () const
size_t coldim () const
Matrix I/O
template<class Field >
std::ostream & write (std::ostream &stream, const Field &F) const
Access to matrix elements
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
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

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

ColIterator colBegin ()
ColIterator colEnd ()
ConstColIterator colBegin () const
ConstColIterator colEnd () const
Raw iterator

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.

RawIterator rawBegin ()
RawIterator rawEnd ()
ConstRawIterator rawBegin () const
ConstRawIterator rawEnd () const
Raw Indexed iterator

Like the raw iterator, the indexed iterator is a method for accessing all entries in the matrix in some unspecified order. At each position of the the indexed iterator, it also provides the row and column indices of the currently referenced entry. This is provided through it's rowIndex() and colIndex() functions.

RawIndexedIterator rawIndexedBegin ()
RawIndexedIterator rawIndexedEnd ()
ConstRawIndexedIterator rawIndexedBegin () const
ConstRawIndexedIterator rawIndexedEnd () const

Detailed Description

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
class LinBox::TransposeMatrix< Matrix, Trait >

Matrix transpose

This class takes a matrix meeting the DenseMatrixBase} archetype and switches the row and column iterators, giving the transpose of the original matrix. It is generic with respect to the matrix given.

If the matrix given has limited iterators, then its transpose will have limited iterators as well. In particular, if the matrix given has only row iterators, then the transpose object will have only column iterators, and vice versa.

This class differs from Transpose} in that it constructs a full matrix representation, with row and/or column iterators. It does not include any logic for matrix-vector products, and does not meet the BlackboxArchetype} interface. Nor does it make such assumptions about the matrix given.

This class gives a constant matrix as output. It provides no iterators for modification of the data in the matrix.

The input/output functionality of this class passes requests directly through to the underlying matrix. In particular, the output will be the transpose of the matrix expected and the input will expect the transpose of the matrix given. Thus, it is not recommended to use TransposeMatrix for reading and writing matrices, except for testing purposes.


Constructor & Destructor Documentation

TransposeMatrix ( Matrix &  A) [inline]

Constructor.

Parameters:
AUnderlying matrix of which to construct the transpose
TransposeMatrix ( const TransposeMatrix< Matrix, Trait > &  M) [inline]

Copy constructor


Member Function Documentation

size_t rowdim ( ) const [inline]

Get the number of rows in the matrix

Returns:
Number of rows in matrix
size_t coldim ( ) const [inline]

Get the number of columns in the matrix

Returns:
Number of columns in matrix
std::ostream& write ( std::ostream &  stream,
const Field F 
) const [inline]

Write a matrix to an output stream

Parameters:
streamStream to which to write the matrix
Returns:
Reference to stream
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:
iRow number, 0...rowdim () - 1
jColumn number 0...coldim () - 1
a_ijElement to set
Element& refEntry ( size_t  i,
size_t  j 
) [inline]

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

Parameters:
iRow index of entry
jColumn 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:
iRow index
jColumn 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:
xElement in which to store result
iRow index
jColumn index
Returns:
Reference to x

The documentation for this class was generated from the following file: