linbox
Public Types | Public Member Functions
TransposedBlasMatrix< Matrix > Class Template Reference

TransposedBlasMatrix. More...

#include <blas-transposed-matrix.h>

+ Inheritance diagram for TransposedBlasMatrix< Matrix >:
+ Collaboration diagram for TransposedBlasMatrix< Matrix >:

Public Types

typedef Field::Element_ptr Element_ptr
 Pointer to Element type.
 
typedef Field::ConstElement_ptr ConstElement_ptr
 Pointer to const Element type.
 

Public Member Functions

const Field & field () const
 Get the field of the matrix. More...
 
size_t rowdim () const
 Get the number of rows in the matrix. More...
 
size_t coldim () const
 Get the number of columns in the matrix. More...
 
Matrix I/O
std::ostream & write (std::ostream &stream) const
 Write a matrix to an output stream. More...
 
Access to matrix elements
void setEntry (size_t i, size_t j, const Element &a_ij)
 Set the entry at the (i, j) position to a_ij. More...
 
Element & refEntry (size_t i, size_t j)
 Get a writeable reference to the entry in the (i, j) position. More...
 
const Element & getEntry (size_t i, size_t j) const
 Get a read-only reference to the entry in the (i, j) position. More...
 
Element & getEntry (Element &x, size_t i, size_t j) const
 Copy the (i, j) entry into x, and return a reference to x. More...
 
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 ()
 
ConstRowIterator rowBegin () const
 
RowIterator rowEnd ()
 
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 ()
 
ConstColIterator colBegin () const
 
ColIterator colEnd ()
 
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.

Iterator Begin ()
 
ConstIterator Begin () const
 
Iterator End ()
 
ConstIterator End () 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.

IndexedIterator IndexedBegin ()
 
ConstIndexedIterator IndexedBegin () const
 
IndexedIterator IndexedEnd ()
 
ConstIndexedIterator IndexedEnd () const
 
Matrix & _Mat
 

Detailed Description

template<class Matrix>
class LinBox::TransposedBlasMatrix< Matrix >

TransposedBlasMatrix.

NO DOC

Member Function Documentation

◆ field()

const Field & field ( ) const
inlineinherited

Get the field of the matrix.

Returns
field of the matrix

◆ rowdim()

size_t rowdim ( void  ) const
inlineinherited

Get the number of rows in the matrix.

Returns
Number of rows in matrix

◆ coldim()

size_t coldim ( void  ) const
inlineinherited

Get the number of columns in the matrix.

Returns
Number of columns in matrix

◆ write()

std::ostream & write ( std::ostream &  stream) const
inlineinherited

Write a matrix to an output stream.

Parameters
streamStream to which to write the matrix
Returns
Reference to stream

◆ setEntry()

void setEntry ( size_t  i,
size_t  j,
const Element &  a_ij 
)
inlineinherited

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

◆ refEntry()

Element & refEntry ( size_t  i,
size_t  j 
)
inlineinherited

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

◆ getEntry() [1/2]

const Element & getEntry ( size_t  i,
size_t  j 
) const
inlineinherited

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

Parameters
iRow index
jColumn index
Returns
Const reference to matrix entry

◆ getEntry() [2/2]

Element & getEntry ( Element &  x,
size_t  i,
size_t  j 
) const
inlineinherited

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 files: