ScalarMatrix< Field_ > Class Template Reference

Blackbox for aI. More...

#include <scalar-matrix.h>

Public Member Functions
	ScalarMatrix ()
	Constructs an initially 0 by 0 matrix.
	ScalarMatrix (const Field &F)
	Constructor of readable scalar matrix.
	ScalarMatrix (const Field &F, const size_t n, const typename Field::RandIter &iter)
	Constructor from a random element.
template<class OutVector, class InVector>
OutVector &	apply (OutVector &y, InVector &x) const
	Application of BlackBox matrix.
template<class OutVector, class InVector>
OutVector &	applyTranspose (OutVector &y, InVector &x) const
	Application of BlackBox matrix transpose.

Detailed Description

template<class Field_>
class LinBox::ScalarMatrix< Field_ >

Blackbox for aI.

Use particularly for representing 0 and I.

This is a class of blackbox square scalar matrices. Each scalar matrix occupies O(scalar-size) memory. The matrix itself is not stored in memory, just the scalar and the dimensions.

Constructor & Destructor Documentation

ScalarMatrix() [1/3]

template<class Field_>

ScalarMatrix ( )

inline

Constructs an initially 0 by 0 matrix.

Bug

this should not be allowed (unknown field)

ScalarMatrix() [2/3]

template<class Field_>

ScalarMatrix ( const Field & F )

inline

Constructor of readable scalar matrix.

Parameters

F	field in which to do arithmetic.

ScalarMatrix() [3/3]

template<class Field_>

ScalarMatrix ( const Field & F, const size_t n, const typename Field::RandIter & iter )

inline

Constructor from a random element.

Parameters

F	field in which to do arithmetic.
n	size of the matrix.
iter	Random iterator from which to get the diagonal scalar element.

Member Function Documentation

apply()

template<class Field_>

template<class OutVector, class InVector>

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

inline

Application of BlackBox matrix.

y= A*x. Requires time linear in n, the size of the matrix.

applyTranspose()

template<class Field_>

template<class OutVector, class InVector>

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

inline

Application of BlackBox matrix transpose.

y= transpose(A)*x. Requires time linear in n, the size of the matrix.

---

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

• quad-matrix.h
• scalar-matrix.h