Dense vectorClass Vector provides dense linear algebra vectors. It does not provide memory management for the array of values. Instead, the constructor requires a pointer to a memory block large enough to fit the desired dimension of Real values. More...

#include <vector.h>

Inheritance diagram for Vector:

[legend]

Public Member Functions
Construction and assignment
	Vector (int p_dimen, Real *p_val)
	construction

Vector &	operator= (const Vector &vec)
	Assignment operator.

Vector &	operator= (const SVector &vec)
	Assignment operator.

Vector &	operator= (const SSVector &vec)
	Assignment operator.

Vector &	operator= (const Vector_exact &vec)
	Assignment operator.

Vector &	assign (const SVector &sv)
	Assign values of `sv`.

Vector &	assign (const SSVector &sv)
	Assign values of `sv`.

Access
int	dim () const
	dimension of vector

Real &	operator[] (int n)
	return `n` 'th value by reference

Real	operator[] (int n) const
	return `n` 'th value

Algebraic methods
Vector &	operator+= (const Vector &vec)
	vector addition

Vector &	operator+= (const SVector &vec)
	vector addition

Vector &	operator+= (const SSVector &vec)
	vector addition

Vector &	operator-= (const Vector &vec)
	vector difference

Vector &	operator-= (const SVector &vec)
	vector difference

Vector &	operator-= (const SSVector &vec)
	vector difference

Vector &	operator*= (Real x)
	scaling

Real	operator* (const SSVector &v) const
	inner product.

Real	operator* (const SVector &v) const
	inner product.

Real	operator* (const Vector &v) const
	inner product.

Real	maxAbs () const
	absolute biggest element (infinity norm).

Real	minAbs () const
	absolute smallest element.

Real	length () const
	euclidian norm.

Real	length2 () const
	squared norm.

Vector &	multAdd (Real x, const SVector &vec)
	addition of scaled vector

Vector &	multAdd (Real x, const SSVector &svec)
	addition of scaled vector

Vector &	multAdd (Real x, const Vector &vec)
	addition of scaled vector

Protected Attributes
Data
int	dimen
	dimension of vector

Real *	val
	values of a vector

Private Member Functions
Blocked
	Vector ()
	we have no default constructor.

Utilities
Real *	get_ptr ()
	Conversion to C-style pointer.

const Real *	get_const_ptr () const
	Conversion to C-style pointer.

bool	isConsistent () const
	consistency check.

void	clear ()
	set vector to 0.

std::ostream &	operator<< (std::ostream &s, const Vector &vec)
	output operator.

Detailed Description

Dense vector

Class Vector provides dense linear algebra vectors. It does not provide memory management for the array of values. Instead, the constructor requires a pointer to a memory block large enough to fit the desired dimension of Real values.

After construction, the values of a Vector can be accessed with the subscript operator[]() . Safety is provided by

checking of array bound when accessing elements with the subscript operator[]() (only when compiled without -DNDEBUG).

A Vector is distinguished from a simple array of Reals by providing a set of mathematical operations. Since Vector does not provide any memory management features, no operations are available that would require allocation of temporary memory space.

The following mathematical operations are provided by class Vector (Vector a, b; Real x):

Operation	Description
`-=`	subtraction	`a` `-=` `b`
`+=`	addition	`a` `+=` `b`
`*`	scalar product	`x` = `a` `*` `b`
`*=`	scaling	`a` `*=` `x`
maxAbs()	infinity norm	`a.maxAbs()` == $\\|a\\|_{\infty}$
minAbs()		`a.minAbs()` == $\min \|a_i\|$
length()	euclidian norm	`a.length()` == $\sqrt{a^2}$
length2()	square norm	`a.length2()` ==
multAdd(`x`,`b`)	add scaled vector	`a` += `x` * `b`

When using any of these operations, the vectors involved must be of the same dimension. Also an SVector b is allowed if it does not contain nonzeros with index greater than the dimension of a.

Definition at line 82 of file vector.h.

Constructor & Destructor Documentation

Vector	(	int	p_dimen,
		Real *	p_val
	)

construction

There is no default constructor since the storage for a Vector must be provided externally. Storage must be passed as a memory block val at construction. It must be large enough to fit at least dimen Real values.

Definition at line 109 of file vector.h.

References Vector::dimen, and Vector::isConsistent().

Vector ( )

private

we have no default constructor.

Referenced by SSVector::operator-=().