UnitVector Class Reference

Sparse vector .A UnitVector is an SVector that can take only one nonzero value with value 1 but arbitrary index. More...

#include <unitvector.h>

Inheritance diagram for UnitVector:

Public Member Functions
Access
Real	value (int n) const
	returns value = 1
Constructors / destructors
	UnitVector (int i=0)
	construct i 'th unit vector.
	UnitVector (const UnitVector &rhs)
	copy constructor
UnitVector &	operator= (const UnitVector &rhs)
	assignment
	~UnitVector ()
	destructor
Miscellaneous
bool	isConsistent () const
	consistency check
Public Member Functions inherited from SVector
void	add (int i, Real v)
	append one nonzero (i,v).
void	add (const SVector &sv)
	append nonzeros of sv.
void	add (int n, const int i[], const Real v[])
	append n nonzeros.
void	add (int n, const Element e[])
	append n nonzeros.
void	remove (int n, int m)
	remove nonzeros n thru m.
void	remove (int n)
	remove n 'th nonzero.
void	clear ()
	remove all indices.
void	sort ()
	sort nonzeros to increasing indices.
int	size () const
	number of used indices.
int	max () const
	maximal number indices.
int	dim () const
	dimension of the vector: maximal index + 1
int	number (int i) const
	Number of index i.
Real	operator[] (int i) const
	get value to index i.
Element &	element (int n)
	get reference to the n 'th nonzero element.
const Element &	element (int n) const
	get n 'th nonzero element.
int &	index (int n)
	get reference to index of n 'th nonzero.
int	index (int n) const
	get index of n 'th nonzero.
Real &	value (int n)
	get reference to value of n 'th nonzero.
Real	value (int n) const
	get value of n 'th nonzero.
Real	maxAbs () const
	infinity norm.
Real	minAbs () const
	the absolut smalest element in the vector.
Real	length () const
	eucledian norm.
Real	length2 () const
	squared eucledian norm.
SVector &	operator*= (Real x)
	scale with x.
Real	operator* (const Vector &w) const
	inner product.
SVector &	operator= (const SSVector &sv)
	assignment operator from semi sparse vector.
SVector &	operator= (const SVector &sv)
	assignment operator.
SVector &	operator= (const Vector &sv)
	assignment operator from vector.
	SVector (int n=0, Element *p_mem=0)
	default constructor.
	~SVector ()
	destructor
Element *	mem () const
	get pointer to internal memory.
void	set_size (int s)
	set the size of the Vector,
void	set_max (int m)
	set the maximum number of nonzeros in the Vector.
void	setMem (int n, Element *elmem)
	set the memory area where the nonzeros will be stored.
bool	isConsistent () const
	consistency check.

Private Attributes
Data
Element	themem [2]
	memory for 1st and 2nd sparse vector entry (themem[0]/themem[1])

Detailed Description

Sparse vector .

A UnitVector is an SVector that can take only one nonzero value with value 1 but arbitrary index.

Todo:

Several SVector modification methods are still accessible for UnitVector. They might be used to change the vector.

Todo:

UnitVector memory management must be changed when SVector is redesigned.

Definition at line 42 of file unitvector.h.

Constructor & Destructor Documentation

UnitVector ( int  i = 0 )

explicit

construct i 'th unit vector.

Definition at line 73 of file unitvector.h.

References SVector::add(), and UnitVector::isConsistent().

UnitVector

(

const UnitVector &

rhs

)

copy constructor

Definition at line 81 of file unitvector.h.

References UnitVector::isConsistent(), and UnitVector::themem.

~UnitVector

(

)

destructor

Definition at line 102 of file unitvector.h.

Member Function Documentation

bool isConsistent

(

)

const

consistency check

Definition at line 23 of file unitvector.cpp.

References SVector::isConsistent(), SVector::max(), SVector::mem(), MSGinconsistent, SVector::size(), and UnitVector::themem.

Referenced by UnitVector::operator=(), and UnitVector::UnitVector().

UnitVector& operator=

(

const UnitVector &

rhs

)

assignment

Definition at line 90 of file unitvector.h.

References UnitVector::isConsistent(), and UnitVector::themem.

Real value

(

int

n

)

const

returns value = 1

Precondition

n must be 0.

Definition at line 61 of file unitvector.h.

Member Data Documentation

Element themem[2]

private

memory for 1st and 2nd sparse vector entry (themem[0]/themem[1])

Definition at line 49 of file unitvector.h.

Referenced by UnitVector::isConsistent(), UnitVector::operator=(), and UnitVector::UnitVector().