mat::Vector< Treal > Class Template Reference

#include <Vector.h>

Inheritance diagram for mat::Vector< Treal >:

List of all members.

Public Member Functions
	Vector ()
void	allocate ()
void	assignFromFull (std::vector< Treal > const &fullVector)
void	addFromFull (std::vector< Treal > const &fullVector)
void	fullVector (std::vector< Treal > &fullVector) const
Vector< Treal > &	operator= (const Vector< Treal > &vec)
void	clear ()
	Set vector to zero and delete all arrays.
void	writeToFile (std::ofstream &file) const
void	readFromFile (std::ifstream &file)
Vector< Treal > &	operator= (int const k)
void	randomNormalized ()
void	random ()
Treal	eucl () const
Vector< Treal > &	operator*= (const Treal alpha)
Static Public Member Functions
static Treal	dot (Vector< Treal > const &x, Vector< Treal > const &y)
static void	axpy (Treal const &alpha, Vector< Treal > const &x, Vector< Treal > &y)
static void	gemv (bool const tA, Treal const alpha, Matrix< Treal > const &A, Vector< Treal > const &x, Treal const beta, Vector< Treal > &y)
	gemv: y = alpha * A * x + beta * y, or y = alpha * transpose(A) * x + beta * y
static void	symv (char const uplo, Treal const alpha, Matrix< Treal > const &A, Vector< Treal > const &x, Treal const beta, Vector< Treal > &y)
	symv: y = alpha * A * x + beta * y, where A is symmetric
static void	trmv (char const uplo, const bool tA, Matrix< Treal > const &A, Vector< Treal > &x)
	trmv: x = A * x, or x = transpose(A) * x, where A is triangular
Friends
class	Matrix< Treal >

template<class Treal>
class mat::Vector< Treal >

---

Constructor & Destructor Documentation

template<class Treal >

mat::Vector< Treal >::Vector

(

)

[inline]

---

Member Function Documentation

template<class Treal >

void mat::Vector< Treal >::addFromFull

(

std::vector< Treal > const &

fullVector

)

[inline]

References mat::Vector< Treal, Telement >::allocate(), mat::SizesAndBlocks::getNTotalScalars(), mat::SizesAndBlocks::getOffset(), mat::VectorHierarchicBase< Treal, Telement >::is_zero(), mat::VectorHierarchicBase< Treal, Telement >::n(), and mat::VectorHierarchicBase< Treal, Telement >::rows.

template<class Treal >

void mat::Vector< Treal >::allocate

(

)

[inline]

References mat::VectorHierarchicBase< Treal, Telement >::elements, mat::VectorHierarchicBase< Treal, Telement >::is_empty(), mat::VectorHierarchicBase< Treal, Telement >::is_zero(), and mat::VectorHierarchicBase< Treal, Telement >::n().

Referenced by axpy(), gemv(), and symv().

template<class Treal >

void mat::Vector< Treal >::assignFromFull

(

std::vector< Treal > const &

fullVector

)

[inline]

References mat::Vector< Treal, Telement >::addFromFull().

template<class Treal >

void mat::Vector< Treal >::axpy	(	Treal const &	alpha,
		Vector< Treal > const &	x,
		Vector< Treal > &	y
	)			[inline, static]

References allocate(), mat::Vector< Treal, Telement >::axpy(), mat::VectorHierarchicBase< Treal, Telement >::elements, mat::VectorHierarchicBase< Treal, Telement >::is_zero(), and mat::VectorHierarchicBase< Treal, Telement >::n().

template<class Treal >

void mat::Vector< Treal >::clear

(

)

[inline]

Set vector to zero and delete all arrays.

References mat::VectorHierarchicBase< Treal, Telement >::elements, and mat::freeElements().

template<class Treal >

Treal mat::Vector< Treal >::dot	(	Vector< Treal > const &	x,
		Vector< Treal > const &	y
	)			[inline, static]

References mat::Vector< Treal, Telement >::dot(), mat::VectorHierarchicBase< Treal, Telement >::elements, mat::VectorHierarchicBase< Treal, Telement >::is_zero(), and mat::VectorHierarchicBase< Treal, Telement >::n().

template<class Treal >

Treal mat::Vector< Treal >::eucl

(

)

const [inline]

References mat::Vector< Treal, Telement >::dot(), and template_blas_sqrt().

template<class Treal >

void mat::Vector< Treal >::fullVector

(

std::vector< Treal > &

fullVector

)

const [inline]

References mat::SizesAndBlocks::getNTotalScalars(), mat::SizesAndBlocks::getOffset(), mat::VectorHierarchicBase< Treal, Telement >::is_zero(), mat::VectorHierarchicBase< Treal, Telement >::n(), mat::VectorHierarchicBase< Treal, Telement >::nScalars(), and mat::VectorHierarchicBase< Treal, Telement >::rows.

template<class Treal >

void mat::Vector< Treal >::gemv	(	bool const	tA,
		Treal const	alpha,
		Matrix< Treal > const &	A,
		Vector< Treal > const &	x,
		Treal const	beta,
		Vector< Treal > &	y
	)			[inline, static]

gemv: y = alpha * A * x + beta * y, or y = alpha * transpose(A) * x + beta * y

References allocate(), mat::VectorHierarchicBase< Treal, Telement >::elements, mat::MatrixHierarchicBase< Treal, Telement >::elements, mat::Vector< Treal, Telement >::gemv(), mat::VectorHierarchicBase< Treal, Telement >::is_empty(), mat::VectorHierarchicBase< Treal, Telement >::is_zero(), mat::VectorHierarchicBase< Treal, Telement >::n(), mat::MatrixHierarchicBase< Treal, Telement >::ncols(), mat::MatrixHierarchicBase< Treal, Telement >::nrows(), mat::VectorHierarchicBase< Treal, Telement >::resetRows(), and mat::VectorHierarchicBase< Treal, Telement >::rows.

template<class Treal >

Vector< Treal > & mat::Vector< Treal >::operator*=

(

const Treal

alpha

)

[inline]

References mat::VectorHierarchicBase< Treal, Telement >::elements, mat::VectorHierarchicBase< Treal, Telement >::is_zero(), mat::VectorHierarchicBase< Treal, Telement >::n(), and mat::scal().

template<class Treal >

Vector< Treal > & mat::Vector< Treal >::operator=

(

int const

k

)

[inline]

References mat::Vector< Treal, Telement >::clear().

template<class Treal >

Vector<Treal>& mat::Vector< Treal >::operator=

(

const Vector< Treal > &

vec

)

[inline]

References mat::Vector< Treal, Telement >::operator=().

template<class Treal >

void mat::Vector< Treal >::random

(

)

[inline]

References mat::Vector< Treal, Telement >::allocate(), mat::VectorHierarchicBase< Treal, Telement >::is_zero(), and mat::VectorHierarchicBase< Treal, Telement >::n().

template<class Treal >

void mat::Vector< Treal >::randomNormalized

(

)

[inline]

References mat::Vector< Treal, Telement >::eucl(), and mat::Vector< Treal, Telement >::random().

template<class Treal >

void mat::Vector< Treal >::readFromFile

(

std::ifstream &

file

)

[inline]

References mat::Vector< Treal, Telement >::allocate(), mat::VectorHierarchicBase< Treal, Telement >::elements, mat::VectorHierarchicBase< Treal, Telement >::is_zero(), and mat::VectorHierarchicBase< Treal, Telement >::n().

template<class Treal >

void mat::Vector< Treal >::symv	(	char const	uplo,
		Treal const	alpha,
		Matrix< Treal > const &	A,
		Vector< Treal > const &	x,
		Treal const	beta,
		Vector< Treal > &	y
	)			[inline, static]

symv: y = alpha * A * x + beta * y, where A is symmetric

References allocate(), mat::VectorHierarchicBase< Treal, Telement >::elements, mat::MatrixHierarchicBase< Treal, Telement >::elements, mat::VectorHierarchicBase< Treal, Telement >::is_empty(), mat::VectorHierarchicBase< Treal, Telement >::is_zero(), mat::VectorHierarchicBase< Treal, Telement >::n(), mat::MatrixHierarchicBase< Treal, Telement >::ncols(), mat::MatrixHierarchicBase< Treal, Telement >::nrows(), mat::VectorHierarchicBase< Treal, Telement >::resetRows(), mat::VectorHierarchicBase< Treal, Telement >::rows, and mat::Vector< Treal, Telement >::symv().

template<class Treal >

void mat::Vector< Treal >::trmv	(	char const	uplo,
		const bool	tA,
		Matrix< Treal > const &	A,
		Vector< Treal > &	x
	)			[inline, static]

trmv: x = A * x, or x = transpose(A) * x, where A is triangular

References mat::VectorHierarchicBase< Treal, Telement >::elements, mat::MatrixHierarchicBase< Treal, Telement >::elements, mat::VectorHierarchicBase< Treal, Telement >::is_zero(), mat::VectorHierarchicBase< Treal, Telement >::n(), mat::MatrixHierarchicBase< Treal, Telement >::ncols(), mat::MatrixHierarchicBase< Treal, Telement >::nrows(), and mat::Vector< Treal, Telement >::trmv().

template<class Treal >

void mat::Vector< Treal >::writeToFile

(

std::ofstream &

file

)

const [inline]

References mat::VectorHierarchicBase< Treal, Telement >::elements, mat::VectorHierarchicBase< Treal, Telement >::is_zero(), and mat::VectorHierarchicBase< Treal, Telement >::n().

---

Friends And Related Function Documentation

template<class Treal >

friend class Matrix< Treal > [friend]

---

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

• source/matrix/Vector.h