linbox
Public Types | Public Member Functions | Protected Attributes
TriangularBlasMatrix< Element > Class Template Reference

Triangular BLAS matrix. More...

#include <blas-matrix.h>

Inheritance diagram for TriangularBlasMatrix< Element >:

Public Types

typedef Element Element
 Element type.
typedef BlasMatrix< ElementSelf_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 DenseMatrixBase
< Element >::RowIterator 
RowIterator
typedef DenseMatrixBase
< Element >::ConstRowIterator 
ConstRowIterator
typedef DenseMatrixBase
< Element >::Row 
Row
typedef DenseMatrixBase
< 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 DenseMatrixBase
< Element >::ColIterator 
ColIterator
typedef DenseMatrixBase
< Element >::ConstColIterator 
ConstColIterator
typedef DenseMatrixBase
< Element >::Col 
Col
typedef DenseMatrixBase
< Element >::Column 
Column
typedef DenseMatrixBase
< Element >::ConstCol 
ConstCol

Public Member Functions

 TriangularBlasMatrix (const size_t m, const size_t n, BlasTag::uplo x=BlasTag::up, BlasTag::diag y=BlasTag::nonunit)
 Constructor for a new TriangularBlasMatrix.
 TriangularBlasMatrix (const BlasMatrix< Element > &A, BlasTag::uplo x=BlasTag::up, BlasTag::diag y=BlasTag::nonunit)
 Constructor from a BlasMatrix (copy).
 TriangularBlasMatrix (BlasMatrix< Element > &A, BlasTag::uplo x=BlasTag::up, BlasTag::diag y=BlasTag::nonunit)
 Constructor from a BlasMatrix (no copy).
 TriangularBlasMatrix (const TriangularBlasMatrix< Element > &A)
 Constructor from a TriangularBlasMatrix (copy).
template<class Matrix >
 TriangularBlasMatrix (const Matrix &A, BlasTag::uplo x=BlasTag::up, BlasTag::diag y=BlasTag::nonunit)
 Generic constructor from a Matrix (no copy).
BlasTag::uplo getUpLo () const
 get the shape of the matrix (upper or lower)
BlasTag::diag getDiag () const
 Is the diagonal implicitly unit ?
pointer getPointer () const
  
pointer & getWritePointer ()
  
size_t getStride () const
  
size_t & getWriteStride ()
  
size_t rowdim () const
 Get the number of rows in the matrix.
size_t coldim () const
 Get the number of columns in the matrix.
std::istream & read (std::istream &file, const Field &field)
 Read the matrix from an input stream.
std::ostream & write (std::ostream &os, const Field &field, bool mapleFormat=false) const
 Write the matrix to an output stream.
std::ostream & write (std::ostream &os, bool mapleFormat=false) 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).
ElementrefEntry (size_t i, size_t j)
 Get a writeable reference to an entry in the matrix.
const ElementgetEntry (size_t i, size_t j) const
 Get a read-only individual entry from the matrix.
ElementgetEntry (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
ConstRowIterator rowBegin () const
 const iterator to the begining of a row
RowIterator rowEnd ()
 iterator to the end of a row
ConstRowIterator rowEnd () const
 const iterator to the end of a row
DenseSubmatrix< Elementtranspose (DenseMatrixBase< Element > &tM)
 Creates a transposed matrix of *this.
DenseSubmatrix< Element > & transpose (DenseSubmatrix< Element > &tA)
 Creates a transposed matrix of *this.

Protected Attributes

BlasTag::uplo _uplo
 upper or lower triangular
BlasTag::diag _diag
 unit or non unit diagonal

Detailed Description

template<class Element>
class LinBox::TriangularBlasMatrix< Element >

Triangular BLAS matrix.


Constructor & Destructor Documentation

TriangularBlasMatrix ( const size_t  m,
const size_t  n,
BlasTag::uplo  x = BlasTag::up,
BlasTag::diag  y = BlasTag::nonunit 
) [inline]

Constructor for a new TriangularBlasMatrix.

Parameters:
mrows
ncols
y(non)unit diagonal
x(upp/low)er matrix
TriangularBlasMatrix ( const BlasMatrix< Element > &  A,
BlasTag::uplo  x = BlasTag::up,
BlasTag::diag  y = BlasTag::nonunit 
) [inline]

Constructor from a BlasMatrix (copy).

Parameters:
Amatrix
y(non)unit diagonal
x(upp/low)er matrix
TriangularBlasMatrix ( BlasMatrix< Element > &  A,
BlasTag::uplo  x = BlasTag::up,
BlasTag::diag  y = BlasTag::nonunit 
) [inline]

Constructor from a BlasMatrix (no copy).

Parameters:
Amatrix
y(non)unit diagonal
x(upp/low)er matrix

Constructor from a TriangularBlasMatrix (copy).

Parameters:
Amatrix
TriangularBlasMatrix ( const Matrix A,
BlasTag::uplo  x = BlasTag::up,
BlasTag::diag  y = BlasTag::nonunit 
) [inline]

Generic constructor from a Matrix (no copy).

Parameters:
Amatrix
y(non)unit diagonal
x(upp/low)er matrix

Member Function Documentation

size_t rowdim ( ) const [inline, inherited]

Get the number of rows in the matrix.

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

Get the number of columns in the matrix.

Returns:
Number of columns in matrix
std::istream& read ( std::istream &  file,
const Field field 
) [inherited]

Read the matrix from an input stream.

Parameters:
fileInput stream from which to read
field
std::ostream& write ( std::ostream &  os,
const Field field,
bool  mapleFormat = false 
) const [inherited]

Write the matrix to an output stream.

Parameters:
osOutput stream to which to write
field
mapleFormatwrite in Maple(r) format ?
std::ostream& write ( std::ostream &  os,
bool  mapleFormat = false 
) const [inherited]

Write the matrix to an output stream.

This a raw version of write(os,F) (no field is given).

Parameters:
osOutput stream to which to write
mapleFormatwrite in Maple(r) format ?
void setEntry ( size_t  i,
size_t  j,
const Element a_ij 
) [inline, inherited]

Set the entry at (i, j).

Parameters:
iRow number, 0...rowdim () - 1
jColumn number 0...coldim () - 1
a_ijElement to set
Element& refEntry ( size_t  i,
size_t  j 
) [inline, inherited]

Get a writeable reference to an entry in the matrix.

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, inherited]

Get a read-only individual entry from the matrix.

Parameters:
iRow index
jColumn index
Returns:
Const reference to matrix entry
Element& getEntry ( Element x,
size_t  i,
size_t  j 
) const [inline, inherited]

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

Parameters:
xElement in which to store result
iRow index
jColumn index
Returns:
Reference to x
DenseSubmatrix<Element> transpose ( DenseMatrixBase< Element > &  tM) [inline, inherited]

Creates a transposed matrix of *this.

Parameters:
[in]tM
Returns:
the transposed matrix of this.
DenseSubmatrix<Element>& transpose ( DenseSubmatrix< Element > &  tA) [inline, inherited]

Creates a transposed matrix of *this.

Returns:
the transposed matrix of this.

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