Sum< _Blackbox1, _Blackbox2 > Class Template Reference

blackbox of a matrix sum without copying. More...

#include <sum.h>

Inheritance diagram for Sum< _Blackbox1, _Blackbox2 >:

Data Structures
struct	rebind

Public Types
typedef _Blackbox1	Blackbox1
typedef _Blackbox2	Blackbox2
typedef Blackbox1::Field	Field
typedef Blackbox1::Element	Element

Public Member Functions
	Sum (const Blackbox1 &A, const Blackbox2 &B)
	Constructor from black box matrices.
	Sum (const Blackbox1 *A_ptr, const Blackbox2 *B_ptr)
	Constructor from black box pointers.
	Sum (const Sum< Blackbox1, Blackbox2 > &M)
	Copy constructor.
	~Sum (void)
	Destructor.
template<class OutVector, class InVector>
OutVector &	apply (OutVector &y, const InVector &x) const
	Application of BlackBox matrix.
template<class OutVector, class InVector>
OutVector &	applyTranspose (OutVector &y, const InVector &x) const
	Application of BlackBox matrix transpose.
size_t	rowdim (void) const
	Retreive row dimensions of BlackBox matrix.
size_t	coldim (void) const
	Retreive column dimensions of BlackBox matrix.
const Field &	field () const
const Blackbox1 *	getLeftPtr () const
const Blackbox2 *	getRightPtr () const
std::ostream &	write (std::ostream &os) const

Protected Attributes
const Blackbox1 *	_A_ptr
const Blackbox2 *	_B_ptr
std::vector< Element >	_z1
std::vector< Element >	_z2
VectorDomain< Field >	VD

Detailed Description

template<class _Blackbox1, class _Blackbox2>
class LinBox::Sum< _Blackbox1, _Blackbox2 >

blackbox of a matrix sum without copying.

Adds only at apply time. Given two black boxes A and B of the same dimensions, form a black box representing A+B, i.e., Sum(A,B)x=(A+B)x=Ax+Bx

Parameters

Vector

LinBox dense or sparse vector of field elements

Member Typedef Documentation

Blackbox1

template<class _Blackbox1, class _Blackbox2>

typedef _Blackbox1 Blackbox1

Blackbox2

template<class _Blackbox1, class _Blackbox2>

typedef _Blackbox2 Blackbox2

Field

template<class _Blackbox1, class _Blackbox2>

typedef Blackbox1::Field Field

Element

template<class _Blackbox1, class _Blackbox2>

typedef Blackbox1::Element Element

Constructor & Destructor Documentation

Sum() [1/3]

template<class _Blackbox1, class _Blackbox2>

Sum ( const Blackbox1 & A, const Blackbox2 & B )

inline

Constructor from black box matrices.

This constructor creates a matrix that is the sum, A + B, of black box matrices.

Parameters

A,B	black box matrices.

Sum() [2/3]

template<class _Blackbox1, class _Blackbox2>

Sum ( const Blackbox1 * A_ptr, const Blackbox2 * B_ptr )

inline

Constructor from black box pointers.

This constructor creates a matrix that is the sum, A + B, of black box matrices.

Parameters

A_ptr,B_ptr

pointers to black box matrices.

Sum() [3/3]

template<class _Blackbox1, class _Blackbox2>

Sum ( const Sum< Blackbox1, Blackbox2 > & M )

inline

Copy constructor.

Creates new black box objects in dynamic memory.

Parameters

M	constant reference to compose black box matrix

~Sum()

template<class _Blackbox1, class _Blackbox2>

~Sum ( void )

inline

Destructor.

Member Function Documentation

apply()

template<class _Blackbox1, class _Blackbox2>

template<class OutVector, class InVector>

OutVector & apply ( OutVector & y, const InVector & x ) const

inline

Application of BlackBox matrix.

\(y= (A+B)\cdot x\). Requires one vector conforming to the LinBox vector archetype. Required by abstract base class.

Returns

reference to vector y containing output.

Parameters

x	constant reference to vector to contain input
y

applyTranspose()

template<class _Blackbox1, class _Blackbox2>

template<class OutVector, class InVector>

OutVector & applyTranspose ( OutVector & y, const InVector & x ) const

inline

Application of BlackBox matrix transpose.

\( y= (A+B)^T\cdot x\). Requires one vector conforming to the LinBox vector archetype. Required by abstract base class.

Returns

reference to vector y containing output.

Parameters

x	constant reference to vector to contain input
y

rowdim()

template<class _Blackbox1, class _Blackbox2>

size_t rowdim ( void ) const

inline

Retreive row dimensions of BlackBox matrix.

This may be needed for applying preconditioners. Required by abstract base class.

Returns

integer number of rows of black box matrix.

coldim()

template<class _Blackbox1, class _Blackbox2>

size_t coldim ( void ) const

inline

Retreive column dimensions of BlackBox matrix.

Required by abstract base class.

Returns

integer number of columns of black box matrix.

field()

template<class _Blackbox1, class _Blackbox2>

const Field & field ( ) const

inline

getLeftPtr()

template<class _Blackbox1, class _Blackbox2>

const Blackbox1 * getLeftPtr ( ) const

inline

getRightPtr()

template<class _Blackbox1, class _Blackbox2>

const Blackbox2 * getRightPtr ( ) const

inline

write()

template<class _Blackbox1, class _Blackbox2>

std::ostream & write ( std::ostream & os ) const

inline

Field Documentation

_A_ptr

template<class _Blackbox1, class _Blackbox2>

const Blackbox1* _A_ptr

protected

_B_ptr

template<class _Blackbox1, class _Blackbox2>

const Blackbox2* _B_ptr

protected

_z1

template<class _Blackbox1, class _Blackbox2>

std::vector<Element> _z1

mutableprotected

_z2

template<class _Blackbox1, class _Blackbox2>

std::vector<Element> _z2

mutableprotected

VD

template<class _Blackbox1, class _Blackbox2>

VectorDomain<Field> VD

protected

---

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

• sum.h