linbox
|
Dense Submatrix representation. More...
#include <blas-matrix.h>
Data Structures | |
class | ConstIndexedIterator |
Raw Indexed Iterator (const version). More... | |
class | ConstIterator |
Raw Iterators (const version). More... | |
class | IndexedIterator |
Raw Indexed Iterator. More... | |
class | Iterator |
Raw Iterators. More... | |
Public Types | |
typedef _Element | Element |
Element type. | |
typedef BlasSubmatrix< _Element > | Self_t |
Self type. | |
typedef'd Row Iterators. | |
The row iterator gives the rows of the matrix in ascending order. Dereferencing the iterator yields a row vector in dense format | |
typedef BlasMatrix< Element > ::RowIterator | RowIterator |
typedef BlasMatrix< Element > ::ConstRowIterator | ConstRowIterator |
typedef BlasMatrix< Element >::Row | Row |
typedef BlasMatrix< Element > ::ConstRow | ConstRow |
typedef'd Column Iterators. | |
The columns iterator gives the columns of the matrix in ascending order. Dereferencing the iterator yields a column vector in dense format | |
typedef BlasMatrix< Element > ::ColIterator | ColIterator |
typedef BlasMatrix< Element > ::ConstColIterator | ConstColIterator |
typedef BlasMatrix< Element >::Col | Col |
typedef BlasMatrix< Element > ::Column | Column |
typedef BlasMatrix< Element > ::ConstCol | ConstCol |
Public Member Functions | |
BlasSubmatrix () | |
NULL constructor. | |
BlasSubmatrix (const BlasMatrix< Element > &M, size_t rowbeg, size_t colbeg, size_t Rowdim, size_t Coldim) | |
Constructor from an existing BlasMatrix and dimensions. | |
BlasSubmatrix (const BlasMatrix< Element > &M) | |
Constructor from an existing DenseMatrixBase. | |
BlasSubmatrix (const BlasSubmatrix< Element > &SM, size_t rowbeg, size_t colbeg, size_t Rowdim, size_t Coldim) | |
Constructor from an existing submatrix and dimensions. | |
BlasSubmatrix (const BlasSubmatrix< Element > &SM) | |
Copy constructor. | |
BlasSubmatrix & | operator= (const BlasSubmatrix< Element > &SM) |
Assignment operator. | |
size_t | rowdim () const |
Get the number of rows in the matrix. | |
size_t | coldim () const |
Get the number of columns in the matrix. | |
size_t | getStride () const |
Get the stride of the matrix. | |
template<class Field > | |
std::istream & | read (std::istream &file, const Field &field) |
Read the matrix from an input stream. | |
template<class Field > | |
std::ostream & | write (std::ostream &os, const Field &field, bool mapleFormat=true) const |
Write the matrix to an output stream. | |
std::ostream & | write (std::ostream &os, bool mapleFormat=true) const |
Write the matrix to an output stream. | |
void | setEntry (size_t i, size_t j, const Element &a_ij) |
Set the entry at (i, j). | |
Element & | refEntry (size_t i, size_t j) |
Get a writeable reference to an entry in the matrix. | |
const Element & | getEntry (size_t i, size_t j) const |
Get a read-only individual entry from the matrix. | |
Element & | getEntry (Element &x, size_t i, size_t j) const |
Get an entry and store it in the given value. | |
RowIterator | rowBegin () |
iterator to the begining of a row | |
RowIterator | rowEnd () |
iterator to the end of a row | |
ConstRowIterator | rowBegin () const |
const iterator to the begining of a row | |
ConstRowIterator | rowEnd () const |
const iterator to the end of a row | |
Row | operator[] (size_t i) |
operator[]. | |
Protected Attributes | |
BlasMatrix< Element > * | _M |
Parent BlasMatrix (ie raw vector) | |
size_t | _row |
row dimension of Submatrix | |
size_t | _col |
col dimension of Submatrix | |
size_t | _r0 |
upper left corner row of Submatrix in _M | |
size_t | _c0 |
upper left corner row of Submatrix in _M | |
size_t | _stride |
number of columns in _M (or stride of _M ) |
Dense Submatrix representation.
A BlasSubmatrix is a matrix of _Element
, with the structure of BLAS matrices. It is basically a read/write view on a vector of _Element
. In the Mother model, a BlasSubmatrix is not allocated.
This matrix type conforms to the same interface as BlasMatrix, except that you cannot resize it. It represents a submatrix of a dense matrix. Upon construction, one can freely manipulate the entries in the DenseSubmatrix, and the corresponding entries in the underlying BlasMatrix will be modified.
BlasSubmatrix | ( | ) |
NULL constructor.
BlasSubmatrix | ( | const BlasMatrix< Element > & | M, |
size_t | rowbeg, | ||
size_t | colbeg, | ||
size_t | Rowdim, | ||
size_t | Coldim | ||
) |
Constructor from an existing BlasMatrix and dimensions.
M | Pointer to BlasMatrix of which to construct submatrix |
rowbeg | Starting row |
colgeb | Starting column |
Rowdim | Row dimension |
Coldim | Column dimension |
BlasSubmatrix | ( | const BlasMatrix< Element > & | M | ) |
Constructor from an existing DenseMatrixBase.
M | Pointer to DenseMatrixBase of which to construct submatrix |
BlasSubmatrix | ( | const BlasSubmatrix< Element > & | SM, |
size_t | rowbeg, | ||
size_t | colbeg, | ||
size_t | Rowdim, | ||
size_t | Coldim | ||
) |
Constructor from an existing submatrix and dimensions.
SM | Constant reference to BlasSubmatrix from which to construct submatrix |
rowbeg | Starting row |
colbeg | Starting column |
Rowdim | Row dimension |
Coldim | Column dimension |
BlasSubmatrix | ( | const BlasSubmatrix< Element > & | SM | ) |
Copy constructor.
SM | Submatrix to copy |
BlasSubmatrix< _Element > & operator= | ( | const BlasSubmatrix< Element > & | SM | ) |
Assignment operator.
Assign the given submatrix to this one This is only renaming ! There is no copy because BlasSubmatrix owns nothing.
SM | Submatrix to assign |
size_t rowdim | ( | ) | const |
Get the number of rows in the matrix.
size_t coldim | ( | ) | const |
Get the number of columns in the matrix.
size_t getStride | ( | ) | const |
Get the stride of the matrix.
std::istream & read | ( | std::istream & | file, |
const Field & | F | ||
) |
Read the matrix from an input stream.
file | Input stream from which to read |
field |
std::ostream & write | ( | std::ostream & | os, |
const Field & | field, | ||
bool | mapleFormat = true |
||
) | const |
Write the matrix to an output stream.
os | Output stream to which to write |
field | |
mapleFormat | write in Maple(r) format ? |
std::ostream & write | ( | std::ostream & | os, |
bool | mapleFormat = true |
||
) | const |
Write the matrix to an output stream.
This a raw version of write(os,F)
(no field is given).
os | Output stream to which to write |
mapleFormat | write in Maple(r) format ? |
void setEntry | ( | size_t | i, |
size_t | j, | ||
const Element & | a_ij | ||
) |
Set the entry at (i, j).
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 | ||
) |
Get a writeable reference to an entry in the matrix.
i | Row index of entry |
j | Column index of entry |
const _Element & getEntry | ( | size_t | i, |
size_t | j | ||
) | const |
Get a read-only individual entry from the matrix.
i | Row index |
j | Column index |
_Element & getEntry | ( | Element & | x, |
size_t | i, | ||
size_t | j | ||
) | const |
Get an entry and store it in the given value.
This form is more in the Linbox style and is provided for interface compatibility with other parts of the library
x | Element in which to store result |
i | Row index |
j | Column index |
BlasSubmatrix< _Element >::Row operator[] | ( | size_t | i | ) |
operator[].
Retrieve a reference to a row
i | Row index |