Triangular BLAS matrix. More...

#include <blas-matrix.h>

Public Types
typedef Field::Element	Element
	Element type.

typedef MatrixEltPointer< _Matrix >::pointer	pointer
	pointer type to elements

typedef MatrixEltPointer< const_Matrix >::pointer	const_pointer
	const pointer type to elements

Public Member Functions
	TriangularBlasMatrix (Matrix &A, Tag::Shape x=Tag::Shape::Upper, Tag::Diag y=Tag::Diag::NonUnit)
	Constructor from a `Matrix` (share data from the matrix)

Tag::Shape	getUpLo () const
	get the shape of the matrix (upper or lower)

Tag::Diag	getDiag () const
	Is the diagonal implicitly unit ?

template<class _AnyMatrix>
Self_t &	copy (const _AnyMatrix &A)
	(copying data) -> works only if dimensions are the same

template<class _AnyMatrix>
Self_t &	swap (_AnyMatrix &A)
	(swaping local data to same dimension (sub)part of A) -> works only if both dimensions of A are larger

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.

const Field &	field () const
	Get the field of the BlasSubMatrix.

pointer	getPointer ()


std::istream &	read (std::istream &file)
	Read the matrix from an input stream.

std::ostream &	write (std::ostream &os, Tag::FileFormat f=Tag::FileFormat::Plain) 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.

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

template<class Vector1, class Vector2>
Vector1 &	applyTranspose (Vector1 &y, const Vector2 &x) const

Protected Attributes
Tag::Shape	_uplo
	upper or lower triangular

Tag::Diag	_diag
	unit or non unit diagonal

pointer	_ptr
	pointer to the first elt of the submatrix

size_t	_row
	row dimension of Submatrix

size_t	_col
	col dimension of Submatrix

size_t	_stride
	stride of the original matrix

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
using	ColIterator = BlasMatrixIterator<Field, Storage, subVectorType>
	operator[].

using	ConstColIterator = BlasMatrixIterator<Field, Storage, constSubVectorType>
	operator[].

using	IndexedIterator = BlasMatrixIndexedIterator<Field, pointer, Element>
	operator[].

using	ConstIndexedIterator = BlasMatrixIndexedIterator<Field, const_pointer, const Element>
	operator[].

ColIterator	colBegin ()
	operator[].

ConstColIterator	colBegin () const
	operator[].

ColIterator	colEnd ()
	operator[].

ConstColIterator	colEnd () const
	operator[].

Iterator	Begin ()
	operator[].

ConstIterator	Begin () const
	operator[].

Iterator	End ()
	operator[].

ConstIterator	End () const
	operator[].

IndexedIterator	IndexedBegin ()
	operator[].

ConstIndexedIterator	IndexedBegin () const
	operator[].

IndexedIterator	IndexedEnd ()
	operator[].

ConstIndexedIterator	IndexedEnd () const
	operator[].

subVectorType	operator[] (size_t i)
	operator[].

constSubVectorType	operator[] (size_t i) const
	operator[].

Detailed Description

template<class Matrix>
class LinBox::TriangularBlasMatrix< Matrix >

Triangular BLAS matrix.

Member Typedef Documentation

◆ ColIterator

template<class _Matrix>

using ColIterator = BlasMatrixIterator<Field, Storage, subVectorType>

inherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ ConstColIterator

template<class _Matrix>

using ConstColIterator = BlasMatrixIterator<Field, Storage, constSubVectorType>

inherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ IndexedIterator

template<class _Matrix>

using IndexedIterator = BlasMatrixIndexedIterator<Field, pointer, Element>

inherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ ConstIndexedIterator

template<class _Matrix>

using ConstIndexedIterator = BlasMatrixIndexedIterator<Field, const_pointer, const Element>

inherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

Constructor & Destructor Documentation

◆ TriangularBlasMatrix()

template<class Matrix>

TriangularBlasMatrix	(	Matrix &	A,
		Tag::Shape	x = Tag::Shape::Upper,
		Tag::Diag	y = Tag::Diag::NonUnit )

inline

Constructor from a Matrix (share data from the matrix)

Parameters

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

Member Function Documentation

◆ rowdim()

template<class _Matrix>

size_t rowdim ( ) const

inlineinherited

Get the number of rows in the matrix.

Returns: Number of rows in matrix

◆ coldim()

template<class _Matrix>

size_t coldim ( ) const

inlineinherited

Get the number of columns in the matrix.

Returns: Number of columns in matrix

◆ getStride()

template<class _Matrix>

size_t getStride ( ) const

inlineinherited

Get the stride of the matrix.

Returns: stride of submatrix (number of cols of dense base matrix)

◆ field()

template<class _Matrix>

const Field & field ( ) const

inlineinherited

Get the field of the BlasSubMatrix.

Returns: Const reference to Field

◆ read()

template<class _Matrix>

std::istream & read ( std::istream & file )

inherited

Read the matrix from an input stream.

Parameters

file	Input stream from which to read

Bug: reading a submatrix should not be allowed !!

◆ write()

template<class _Matrix>

std::ostream & write	(	std::ostream &	os,
		Tag::FileFormat	f = Tag::FileFormat::Plain ) const

inherited

Write the matrix to an output stream.

Parameters

os	Output stream to which to write
f	write in some format (Tag::FileFormat::Format). Default is MM's.

◆ setEntry()

template<class _Matrix>

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

inherited

Set the entry at (i, j).

Parameters

i	Row number, 0...rowdim () - 1
j	Column number 0...coldim () - 1
a_ij	Element to set

◆ refEntry()

template<class _Matrix>

BlasSubmatrix< _Matrix >::Element & refEntry	(	size_t	i,
		size_t	j )

inherited

Get a writeable reference to an entry in the matrix.

Parameters

i	Row index of entry
j	Column index of entry

Returns: Reference to matrix entry

◆ getEntry() [1/2]

template<class _Matrix>

const BlasSubmatrix< _Matrix >::Element & getEntry	(	size_t	i,
		size_t	j ) const

inherited

Get a read-only individual entry from the matrix.

Parameters

i	Row index
j	Column index

Returns: Const reference to matrix entry

◆ getEntry() [2/2]

template<class _Matrix>

BlasSubmatrix< _Matrix >::Element & getEntry	(	Element &	x,
		size_t	i,
		size_t	j ) const

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

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

Returns: Reference to x

◆ apply()

template<class _Matrix>

template<class Vector1, class Vector2>

Vector1 & apply	(	Vector1 &	y,
		const Vector2 &	x ) const

inlineinherited

Bug: every vector we use here should have a stride/be blas vectors so it's not really templated by Vector1 Vector2 in general

◆ applyTranspose()

template<class _Matrix>

template<class Vector1, class Vector2>

Vector1 & applyTranspose	(	Vector1 &	y,
		const Vector2 &	x ) const

inlineinherited

Bug

use Matrix domain

since removal of ApplyDomain this does not handle the case where Field if Givaro::Extension needed for charpoly computation

◆ colBegin() [1/2]

template<class _Matrix>

ColIterator colBegin ( )

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ colBegin() [2/2]

template<class _Matrix>

ConstColIterator colBegin ( ) const

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ colEnd() [1/2]

template<class _Matrix>

ColIterator colEnd ( )

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ colEnd() [2/2]

template<class _Matrix>

ConstColIterator colEnd ( ) const

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ Begin() [1/2]

template<class _Matrix>

Iterator Begin ( )

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ Begin() [2/2]

template<class _Matrix>

ConstIterator Begin ( ) const

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ End() [1/2]

template<class _Matrix>

Iterator End ( )

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ End() [2/2]

template<class _Matrix>

ConstIterator End ( ) const

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ IndexedBegin() [1/2]

template<class _Matrix>

IndexedIterator IndexedBegin ( )

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ IndexedBegin() [2/2]

template<class _Matrix>

ConstIndexedIterator IndexedBegin ( ) const

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ IndexedEnd() [1/2]

template<class _Matrix>

IndexedIterator IndexedEnd ( )

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ IndexedEnd() [2/2]

template<class _Matrix>

ConstIndexedIterator IndexedEnd ( ) const

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ operator[]() [1/2]

template<class _Matrix>

subVectorType operator[] ( size_t i )

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

◆ operator[]() [2/2]

template<class _Matrix>

constSubVectorType operator[] ( size_t i ) const

inlineinherited

operator[].

Retrieve a reference to a row

Parameters

i Row index

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

Public Types

Public Member Functions

Protected Attributes

typedef'd Column Iterators.

Detailed Description

Member Typedef Documentation

◆ ColIterator

◆ ConstColIterator

◆ IndexedIterator

◆ ConstIndexedIterator

Constructor & Destructor Documentation

◆ TriangularBlasMatrix()

Member Function Documentation

◆ rowdim()

◆ coldim()

◆ getStride()

◆ field()

◆ read()

◆ write()

◆ setEntry()

◆ refEntry()

◆ getEntry() [1/2]

◆ getEntry() [2/2]

◆ apply()

◆ applyTranspose()

◆ colBegin() [1/2]

◆ colBegin() [2/2]

◆ colEnd() [1/2]

◆ colEnd() [2/2]

◆ Begin() [1/2]

◆ Begin() [2/2]

◆ End() [1/2]

◆ End() [2/2]

◆ IndexedBegin() [1/2]

◆ IndexedBegin() [2/2]

◆ IndexedEnd() [1/2]

◆ IndexedEnd() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]