Triangular BLAS matrix. More...

#include <blas-matrix.h>

Inheritance diagram for TriangularBlasMatrix< _Field >:

Public Types
typedef Field::Element	Element
	Element type.
typedef TriangularBlasMatrix < _Field >	Self_t
	Self type.
typedef RawVector< Element >::Dense	Rep
	Actually a `std::vector<Element>` (or alike.)
typedef RawVector< Element >::Dense	Rep
	Actually a `std::vector<Element>` (or alike.)
typedef Rep::pointer	pointer
	pointer type to elements
typedef Rep::pointer	pointer
	pointer type to elements
typedef const pointer	const_pointer
	const pointer type
typedef const pointer	const_pointer
	const pointer type
Public Member Functions
	TriangularBlasMatrix (const Field &F, const size_t m, const size_t n, LinBoxTag::Shape x=LinBoxTag::Upper, LinBoxTag::Diag y=LinBoxTag::NonUnit)
	Constructor for a new `TriangularBlasMatrix`.
	TriangularBlasMatrix (const BlasMatrix< _Field > &A, LinBoxTag::Shape x=LinBoxTag::Upper, LinBoxTag::Diag y=LinBoxTag::NonUnit)
	Constructor from a `BlasMatrix` (copy).
	TriangularBlasMatrix (BlasMatrix< _Field > &A, LinBoxTag::Shape x=LinBoxTag::Upper, LinBoxTag::Diag y=LinBoxTag::NonUnit)
	Constructor from a `BlasMatrix` (no copy).
	TriangularBlasMatrix (const TriangularBlasMatrix< _Field > &A)
	Constructor from a `TriangularBlasMatrix` (copy).
template<class Matrix >
	TriangularBlasMatrix (const Matrix &A, LinBoxTag::Shape x=LinBoxTag::Upper, LinBoxTag::Diag y=LinBoxTag::NonUnit)
	Generic constructor from a `Matrix` (no copy).
LinBoxTag::Shape	getUpLo () const
	get the shape of the matrix (upper or lower)
LinBoxTag::Diag	getDiag () const
	Is the diagonal implicitly unit ?
const Element &	getEntry (size_t i, size_t j) const
	Get a read-only reference to the entry in the (i, j) position.
Element &	getEntry (Element &x, size_t i, size_t j) const
	Copy the (i, j) entry into x, and return a reference to x.
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.
size_t &	getWriteStride ()
	Get a reference to the stride of the matrix.
void	resize (size_t m, size_t n, const Element &val=Element())
	Resize the matrix to the given dimensions.
pointer	getPointer () const
	.
pointer &	getWritePointer ()
	.
void	setEntry (size_t i, size_t j, const Element &a_ij)
	Set the entry at the (i, j) position to a_ij.
Element &	refEntry (size_t i, size_t j)
	Get a writeable reference to the entry in the (i, j) position.
BlasMatrix< _Field >	transpose (BlasMatrix< _Field > &tM) const
	Creates a transposed matrix of `*this`.
void	transpose ()
	Transpose (inplace).
void	reverseRows ()
	Reverse the rows of a matrix.
void	reverseCols ()
	Reverse the columns of a matrix.
void	reverse ()
	Reverse the rows/columns of a matrix.
std::istream &	read (std::istream &file)
	Read the matrix from an input stream.
std::ostream &	write (std::ostream &os, bool mapleFormat=true) const
	Write brutally the matrix to an output stream.
Vector &	columnDensity (Vector &v) const
	Compute column density.
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

Row	operator[] (size_t i)
	Retrieve a reference to a row.
ConstRow	operator[] (size_t i) const
	Retrieve a reference to a row.
Protected Attributes
LinBoxTag::Shape	_uplo
	upper or lower triangular
LinBoxTag::Diag	_diag
	unit or non unit diagonal
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
typedef Subvector< typename Rep::iterator, typename Rep::const_iterator >	Row
typedef Subvector< typename Rep::const_iterator >	ConstRow
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
typedef Subvector< Subiterator < typename Rep::iterator > >	Col
typedef Subvector< Subiterator < typename Rep::const_iterator > >	ConstCol
typedef Col	Column
typedef ConstCol	ConstColumn
ColIterator	colBegin ()
ConstColIterator	colBegin () const
ColIterator	colEnd ()
ConstColIterator	colEnd () const
Iterator
The 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.
typedef Rep::iterator	Iterator
typedef Rep::const_iterator	ConstIterator
Iterator	Begin ()
ConstIterator	Begin () const
Iterator	End ()
ConstIterator	End () const

Detailed Description

template<class _Field>
class LinBox::TriangularBlasMatrix< _Field >

Triangular BLAS matrix.

Constructor & Destructor Documentation

TriangularBlasMatrix	(	const Field &	F,
		const size_t	m,
		const size_t	n,
		LinBoxTag::Shape	x = `LinBoxTag::Upper`,
		LinBoxTag::Diag	y = `LinBoxTag::NonUnit`
	)

Constructor for a new TriangularBlasMatrix.

Parameters:

m	rows
n	cols
y	(non)unit diagonal
x	(upp/low)er matrix

TriangularBlasMatrix	(	const BlasMatrix< _Field > &	A,
		LinBoxTag::Shape	x = `LinBoxTag::Upper`,
		LinBoxTag::Diag	y = `LinBoxTag::NonUnit`
	)

Constructor from a BlasMatrix (copy).

Parameters:

A	matrix
y	(non)unit diagonal
x	(upp/low)er matrix

TriangularBlasMatrix	(	BlasMatrix< _Field > &	A,
		LinBoxTag::Shape	x = `LinBoxTag::Upper`,
		LinBoxTag::Diag	y = `LinBoxTag::NonUnit`
	)

Constructor from a BlasMatrix (no copy).

Parameters:

A	matrix
y	(non)unit diagonal
x	(upp/low)er matrix

TriangularBlasMatrix ( const TriangularBlasMatrix< _Field > & A )

Constructor from a TriangularBlasMatrix (copy).

Parameters:

A matrix

TriangularBlasMatrix	(	const Matrix &	A,
		LinBoxTag::Shape	x = `LinBoxTag::Upper`,
		LinBoxTag::Diag	y = `LinBoxTag::NonUnit`
	)

Generic constructor from a Matrix (no copy).

Parameters:

A	matrix
y	(non)unit diagonal
x	(upp/low)er matrix

Member Function Documentation

const Element& getEntry	(	size_t	i,
		size_t	j
	)		const `[inherited]`

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

Parameters:

i	Row index
j	Column index

Returns:: Const reference to matrix entry

Element& getEntry	(	Element &	x,
		size_t	i,
		size_t	j
	)		const `[inherited]`

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:

x	Element in which to store result
i	Row index
j	Column index

Returns:: Reference to x

size_t rowdim ( ) const [inherited]

Get the number of rows in the matrix.

Returns:: Number of rows in matrix

size_t coldim ( ) const [inherited]

Get the number of columns in the matrix.

Returns:: Number of columns in matrix

size_t& getWriteStride ( ) [inherited]

Get a reference to the stride of the matrix.

Modify stride this way.

void resize	(	size_t	m,
		size_t	n,
		const Element &	val = `Element()`
	)		`[inherited]`

Resize the matrix to the given dimensions.

The state of the matrix's entries after a call to this method is undefined

Parameters:

m	Number of rows
n	Number of columns
val

void setEntry	(	size_t	i,
		size_t	j,
		const Element &	a_ij
	)		`[inherited]`

Set the entry at the (i, j) position to a_ij.

Parameters:

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
	)		`[inherited]`

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

Parameters:

i	Row index of entry
j	Column index of entry

Returns:: Reference to matrix entry

BlasMatrix<_Field> transpose ( BlasMatrix< _Field > & tM ) const [inherited]

Creates a transposed matrix of *this.

Parameters:

[in] tM

Returns:: the transposed matrix of this.

void transpose ( ) [inherited]

Transpose (inplace).

If rows and columns agree, we can transpose inplace.

void reverseRows ( ) [inherited]

Reverse the rows of a matrix.

This is done inplace. Let J=antiDiag(1) (or the matrix of the reverse permutation or the matrix (i,j) = (i+j+1==m)). Then, we compute A <- J.A;

void reverseCols ( ) [inherited]

Reverse the columns of a matrix.

This is done inplace. This is A <- J.A

void reverse ( ) [inherited]

Reverse the rows/columns of a matrix.

This is done inplace. This is A <- J.A.J

std::istream& read ( std::istream & file ) [inherited]

Read the matrix from an input stream.

The stream is in SMS or DENSE format

Parameters:

file	Input stream from which to read
F	Field over which to read

std::ostream& write	(	std::ostream &	os,
		bool	mapleFormat = `true`
	)		const `[inherited]`

Write brutally the matrix to an output stream.

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

Parameters:

os	Output stream to which to write
mapleFormat	write in maple format ?

Row operator[] ( size_t i ) [inherited]

Retrieve a reference to a row.

Since rows may also be indexed, this allows A[i][j] notation to be used.

Parameters:

i Row index

ConstRow operator[] ( size_t i ) const [inherited]

Retrieve a reference to a row.

Since rows may also be indexed, this allows A[i][j] notation to be used.

Parameters:

i Row index

Vector& columnDensity ( Vector & v ) const [inherited]

Compute column density.

Parameters:

v

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

blas-matrix.h
blas-triangularmatrix.inl

Public Types

Public Member Functions

Protected Attributes

Column of rows iterator

Row of columns iterator

Iterator

Detailed Description

template<class _Field> class LinBox::TriangularBlasMatrix< _Field >

Constructor & Destructor Documentation

Member Function Documentation

template<class _Field>
class LinBox::TriangularBlasMatrix< _Field >