linbox
TransposedBlasMatrix< Matrix > Class Template Reference

TransposedBlasMatrix. More...

#include <blas-transposed-matrix.h>

+ Inheritance diagram for TransposedBlasMatrix< Matrix >:

Public Types

typedef TransposedBlasMatrix< MatrixSelf_t
 
typedef Matrix::Field Field
 
typedef Field::Element Element
 
typedef Field::Element_ptr Element_ptr
 Pointer to Element type.
 
typedef Field::ConstElement_ptr ConstElement_ptr
 Pointer to const Element type.
 
typedef Matrix::ColIterator RowIterator
 
typedef Matrix::RowIterator ColIterator
 
typedef Matrix::Iterator Iterator
 
typedef Matrix::IndexedIterator IndexedIterator
 
typedef Matrix::ConstColIterator ConstRowIterator
 
typedef Matrix::ConstRowIterator ConstColIterator
 
typedef Matrix::ConstIterator ConstIterator
 
typedef Matrix::ConstIndexedIterator ConstIndexedIterator
 
typedef Matrix::Row Column
 
typedef Matrix::Row Col
 
typedef Matrix::Col Row
 

Public Member Functions

Self_tcopy (const Self_t &A)
 
size_t getStride () const
 
ConstElement_ptr getPointer () const
 
Element_ptr getPointer ()
 
ConstElement_ptr getConstPointer () const
 
template<class Vector1, class Vector2>
Vector1 & apply (Vector1 &y, const Vector2 &x) const
 
template<class Vector1, class Vector2>
Vector1 & applyTranpose (Vector1 &y, const Vector2 &x) const
 
void random ()
 
template<typename RandIter>
void random (RandIter &G)
 
MatrixgetMatrix () const
 
const Fieldfield () const
 Get the field of the matrix.
 
size_t rowdim () const
 Get the number of rows in the matrix.
 
size_t coldim () const
 Get the number of columns in the matrix.
 
Matrix I/O
std::ostream & write (std::ostream &stream) const
 Write a matrix to an output stream.
 
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.
 
ElementrefEntry (size_t i, size_t j)
 Get a writeable reference to the entry in the (i, j) position.
 
const ElementgetEntry (size_t i, size_t j) const
 Get a read-only reference to the entry in the (i, j) position.
 
ElementgetEntry (Element &x, size_t i, size_t j) const
 Copy the (i, j) entry into x, and return a reference to x.
 
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 Typedef Documentation

◆ Self_t

template<class Matrix>
typedef TransposedBlasMatrix<Matrix> Self_t

◆ Field

template<class Matrix>
typedef Matrix::Field Field

◆ Element

template<class Matrix>
typedef Field::Element Element

◆ Element_ptr

template<class Matrix>
typedef Field::Element_ptr Element_ptr

Pointer to Element type.

◆ ConstElement_ptr

template<class Matrix>
typedef Field::ConstElement_ptr ConstElement_ptr

Pointer to const Element type.

◆ RowIterator

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
typedef Matrix::ColIterator RowIterator
inherited

◆ ColIterator

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
typedef Matrix::RowIterator ColIterator
inherited

◆ Iterator

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
typedef Matrix::Iterator Iterator
inherited

◆ IndexedIterator

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
typedef Matrix::IndexedIterator IndexedIterator
inherited

◆ ConstRowIterator

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
typedef Matrix::ConstColIterator ConstRowIterator
inherited

◆ ConstColIterator

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
typedef Matrix::ConstRowIterator ConstColIterator
inherited

◆ ConstIterator

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
typedef Matrix::ConstIterator ConstIterator
inherited

◆ ConstIndexedIterator

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
typedef Matrix::ConstIndexedIterator ConstIndexedIterator
inherited

◆ Column

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
typedef Matrix::Row Column
inherited

◆ Col

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
typedef Matrix::Row Col
inherited

◆ Row

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
typedef Matrix::Col Row
inherited

Member Function Documentation

◆ copy()

template<class Matrix>
Self_t & copy ( const Self_t & A)
inline

◆ getStride()

template<class Matrix>
size_t getStride ( ) const
inline

◆ getPointer() [1/2]

template<class Matrix>
ConstElement_ptr getPointer ( ) const
inline

◆ getPointer() [2/2]

template<class Matrix>
Element_ptr getPointer ( )
inline

◆ getConstPointer()

template<class Matrix>
ConstElement_ptr getConstPointer ( ) const
inline

◆ apply()

template<class Matrix>
template<class Vector1, class Vector2>
Vector1 & apply ( Vector1 & y,
const Vector2 & x ) const
inline

◆ applyTranpose()

template<class Matrix>
template<class Vector1, class Vector2>
Vector1 & applyTranpose ( Vector1 & y,
const Vector2 & x ) const
inline

◆ random() [1/2]

template<class Matrix>
void random ( )
inline

◆ random() [2/2]

template<class Matrix>
template<typename RandIter>
void random ( RandIter & G)
inline

◆ getMatrix()

template<class Matrix>
Matrix & getMatrix ( ) const
inline

◆ field()

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
const Field & field ( ) const
inlineinherited

Get the field of the matrix.

Returns
field of the matrix

◆ rowdim()

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
size_t rowdim ( ) const
inlineinherited

Get the number of rows in the matrix.

Returns
Number of rows in matrix

◆ coldim()

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
size_t coldim ( ) const
inlineinherited

Get the number of columns in the matrix.

Returns
Number of columns in matrix

◆ write()

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
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()

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
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()

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
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]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
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]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
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

◆ rowBegin() [1/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
RowIterator rowBegin ( )
inlineinherited

◆ rowBegin() [2/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
ConstRowIterator rowBegin ( ) const
inlineinherited

◆ rowEnd() [1/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
RowIterator rowEnd ( )
inlineinherited

◆ rowEnd() [2/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
ConstRowIterator rowEnd ( ) const
inlineinherited

◆ colBegin() [1/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
ColIterator colBegin ( )
inlineinherited

◆ colBegin() [2/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
ConstColIterator colBegin ( ) const
inlineinherited

◆ colEnd() [1/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
ColIterator colEnd ( )
inlineinherited

◆ colEnd() [2/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
ConstColIterator colEnd ( ) const
inlineinherited

◆ Begin() [1/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
Iterator Begin ( )
inlineinherited

◆ Begin() [2/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
ConstIterator Begin ( ) const
inlineinherited

◆ End() [1/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
Iterator End ( )
inlineinherited

◆ End() [2/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
ConstIterator End ( ) const
inlineinherited

◆ IndexedBegin() [1/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
IndexedIterator IndexedBegin ( )
inlineinherited

◆ IndexedBegin() [2/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
ConstIndexedIterator IndexedBegin ( ) const
inlineinherited

◆ IndexedEnd() [1/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
IndexedIterator IndexedEnd ( )
inlineinherited

◆ IndexedEnd() [2/2]

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
ConstIndexedIterator IndexedEnd ( ) const
inlineinherited

Field Documentation

◆ _Mat

template<class Matrix, class Trait = typename MatrixTraits<Matrix>::MatrixCategory>
Matrix& _Mat
protectedinherited

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