linalg::matrix< _Tp > Class Template Reference
[Classes and types for basic data management]

Sparse Matrix Template Class (row major). More...

#include <linalg.h>

Inheritance diagram for linalg::matrix< _Tp >:

[legend]

List of all members.

Public Types
typedef mtl::matrix< _Tp, mtl::rectangle <>, mtl::compressed <>, mtl::row_major >::type	_Base
typedef _Base::OneD	Row
Public Member Functions
	matrix ()
	matrix (const _Self &__m)
	matrix (const size_t &n, const size_t &m)
void	setOutputFormat (const linalg_output_format &f)
const linalg_output_format &	getOutputFormat () const
_Self &	operator= (const _Self &a)
_Self &	operator+= (const _Self &a)
_Self &	operator*= (_Tp a)
bool	operator== (const _Self &a) const
bool	operator!= (const _Self &a) const
Protected Attributes
linalg_output_format	output_format
Friends
template<typename _Tq >
std::ostream &	std::operator<< (std::ostream &s, const matrix< _Tq > &A)

---

Detailed Description

template<class _Tp>
class linalg::matrix< _Tp >

This class is the base class for all matrix storage/computation in the COCONUT environment. It is based on the MTL, but wraps the MTL classes to make changing the matrix library possible (and hopefully not too awkward. The matrix is general rectangular row-major.

Definition at line 247 of file linalg.h.

---

Member Typedef Documentation

template<class _Tp>

typedef mtl::matrix<_Tp, mtl::rectangle<>, mtl::compressed<>, mtl::row_major>::type linalg::matrix< _Tp >::_Base

The base class

Definition at line 253 of file linalg.h.

template<class _Tp>

typedef _Base::OneD linalg::matrix< _Tp >::Row

This is the row type of the matrix class.

Definition at line 255 of file linalg.h.

---

Constructor & Destructor Documentation

template<class _Tp>

linalg::matrix< _Tp >::matrix

(

)

[inline]

The Standard Constructor

Definition at line 269 of file linalg.h.

template<class _Tp>

linalg::matrix< _Tp >::matrix

(

const _Self &

__m

)

[inline]

The Standard Copy Constructor

Definition at line 271 of file linalg.h.

template<class _Tp>

linalg::matrix< _Tp >::matrix	(	const size_t &	n,
		const size_t &	m
	)			[inline]

Constructor, which builds a matrix with n rows and m columns.

Definition at line 275 of file linalg.h.

---

Member Function Documentation

template<class _Tp>

const linalg_output_format& linalg::matrix< _Tp >::getOutputFormat

(

)

const [inline]

This method returns the output format of the matrix.

Definition at line 284 of file linalg.h.

template<class _Tp>

bool linalg::matrix< _Tp >::operator!=

(

const _Self &

a

)

const

Standard comparison operator.

template<class _Tp>

_Self& linalg::matrix< _Tp >::operator*=

(

_Tp

a

)

[inline]

This operator multiplies this matrix by a.

Definition at line 324 of file linalg.h.

template<class _Tp>

_Self& linalg::matrix< _Tp >::operator+=

(

const _Self &

a

)

[inline]

This operator adds a to this matrix.

Definition at line 316 of file linalg.h.

template<class _Tp>

_Self& linalg::matrix< _Tp >::operator=

(

const _Self &

a

)

[inline]

Standard assignment operator.

Definition at line 307 of file linalg.h.

template<class _Tp>

bool linalg::matrix< _Tp >::operator==

(

const _Self &

a

)

const

Standard comparison operator.

template<class _Tp>

void linalg::matrix< _Tp >::setOutputFormat

(

const linalg_output_format &

f

)

[inline]

This method sets the output format of the matrix.

Definition at line 281 of file linalg.h.

---

Friends And Related Function Documentation

template<class _Tp>

template<typename _Tq >

std::ostream& std::operator<<	(	std::ostream &	s,
		const matrix< _Tq > &	A
	)			[friend]

---

Member Data Documentation

template<class _Tp>

linalg_output_format linalg::matrix< _Tp >::output_format [protected]

This variable describes the output format for matrix output. Its possible values are linalg_output_sparse and linalg_output_full.

Definition at line 265 of file linalg.h.

---

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

• linalg.h