Compose< _Blackbox1, _Blackbox2 > Class Template Reference

Blackbox of a product: \(C = AB\), i.e \(Cx \gets A(Bx)\). More...

#include <compose.h>

Inheritance diagram for Compose< _Blackbox1, _Blackbox2 >:

Data Structures
struct	rebind

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

Public Member Functions
	Compose (const Blackbox1 &A, const Blackbox2 &B)
	Constructor of C := A*B from blackbox matrices A and B.
	Compose (const Blackbox1 *A_ptr, const Blackbox2 *B_ptr)
	Constructor of C := (A_ptr)(*B_ptr).
	Compose (const Compose< Blackbox1, Blackbox2 > &Mat)
	Copy constructor.
	~Compose ()
	Destructor.
template<class OutVector, class InVector>
OutVector &	apply (OutVector &y, const InVector &x) const
	Matrix * column vector product.
template<class OutVector, class InVector>
OutVector &	applyTranspose (OutVector &y, const InVector &x) const
	row vector * matrix product.
size_t	rowdim (void) const
	The number of rows.
size_t	coldim (void) const
	The number of columns.
const Field &	field () const
	The field.
const Blackbox1 *	getLeftPtr () const
	accessor to the blackboxes
const Blackbox2 *	getRightPtr () const
	accessor to the blackboxes

Protected Attributes
const Blackbox1 *	_A_ptr
const Blackbox2 *	_B_ptr
BlasVector< Field >	_z

Detailed Description

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

Blackbox of a product: \(C = AB\), i.e \(Cx \gets A(Bx)\).

This is a class that multiplies two matrices by implementing an apply method that calls the apply methods of both of the consituent matrices, one after the other.

This class, like the Black Box archetype from which it is derived, is templatized by the vector type to which the matrix is applied. Both constituent matrices must also use this same vector type. For specification of the blackbox members see BlackboxArchetype.

Template parameter: must meet the vector requirement. General case

Examples

examples/minpoly.C, examples/smithsparse.C, and examples/valence.C.

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 Blackbox2::Field Field

Element

template<class _Blackbox1, class _Blackbox2>

typedef Field::Element Element

Constructor & Destructor Documentation

Compose() [1/3]

template<class _Blackbox1, class _Blackbox2>

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

inline

Constructor of C := A*B from blackbox matrices A and B.

Build the product A*B of any two black box matrices of compatible dimensions.

Precondition

A.coldim() == B.rowdim().

Parameters

A	blackbox
B	blackbox

Compose() [2/3]

template<class _Blackbox1, class _Blackbox2>

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

inline

Constructor of C := (A_ptr)(*B_ptr).

This constructor creates a matrix that is a product of two black box matrices: A*B from pointers to them.

Parameters

A_ptr	blackbox
B_ptr	blackbox

Compose() [3/3]

template<class _Blackbox1, class _Blackbox2>

Compose ( const Compose< Blackbox1, Blackbox2 > & Mat )

inline

Copy constructor.

Copies the composed matrix (a small handle). The underlying two matrices are not copied.

Parameters

[in]

Mat

blackbox to copy.

~Compose()

template<class _Blackbox1, class _Blackbox2>

~Compose ( )

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

Matrix * column vector product.

\( y \gets (A\cdot B)\cdot x\) Applies B, then A.

Returns

reference to vector y containing output.

Parameters

	x	constant reference to vector to contain input
[out]	y	the result.

applyTranspose()

template<class _Blackbox1, class _Blackbox2>

template<class OutVector, class InVector>

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

inline

row vector * matrix product.

\( y \gets (A\cdot B)^t \cdot x\). Applies A^t then B^t.

Returns

reference to vector y containing output.

Parameters

	x	constant reference to vector to contain input
[out]	y	the result.

rowdim()

template<class _Blackbox1, class _Blackbox2>

size_t rowdim ( void ) const

inline

The number of rows.

Examples

examples/valence.C.

coldim()

template<class _Blackbox1, class _Blackbox2>

size_t coldim ( void ) const

inline

The number of columns.

Examples

examples/valence.C.

field()

template<class _Blackbox1, class _Blackbox2>

const Field & field ( ) const

inline

The field.

getLeftPtr()

template<class _Blackbox1, class _Blackbox2>

const Blackbox1 * getLeftPtr ( ) const

inline

accessor to the blackboxes

getRightPtr()

template<class _Blackbox1, class _Blackbox2>

const Blackbox2 * getRightPtr ( ) const

inline

accessor to the blackboxes

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

_z

template<class _Blackbox1, class _Blackbox2>

BlasVector<Field> _z

mutableprotected

---

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

• compose.h