Diffpack Documentation

---

              Search  

---

Vector(Type) Class Reference

abstract base class for vectors with arithmetic operations. More...

#include <Vector_Type.h>

Inheritance diagram for Vector(Type)::

List of all members.

Public Methods
	Vector(Type) ()
virtual	~Vector(Type) (;) virtual int getNoEntries() const=0
virtual int	getWork (const VectorWork work_tp=NORM_WORK) const
virtual real	getStorage () const=0
virtual bool	makeItSimilar (Handle(Vector(Type)) &v) const=0
virtual bool	redim (const Vector(prm_Type) &pm)=0
Vector(Type)&	operator= (const Vector(Type) &X)
Vector(Type)&	operator= (Type a)
virtual void	fill (const Vector(Type) &X)=0
virtual void	fill (const Type &a)=0
virtual void	assemble (const Vec(Type) &ev, const VecSimple(int) &idx_trans, int elm_no)
virtual void	add (const Vector(Type) &yb, const Vector(Type) &zb)=0
virtual void	add (const Vector(Type) &yb, char s, const Vector(Type) &zb)=0
virtual void	add (const Vector(Type) &yb, Type b, const Vector(Type) &zb)=0
virtual void	add (Type a, const Vector(Type) &yb, Type b, const Vector(Type) &zb)=0
virtual void	mult (Type value)=0
virtual real	norm (Norm_type lp=l2) const=0
virtual real	normDiff (const Vector(Type) &y, Norm_type lp=l2) const=0
virtual Type	inner (const Vector(Type) &yb) const=0
virtual void	randomize (real low=-1, real high=1, real seed=1)=0
virtual void	print (Os os, const char *header=NULL, int nentries_per_line=3) const=0
virtual void	printAscii (Os os, const char *header=NULL) const=0
virtual void	scan (Is is)=0
virtual void	save (const char *filename, const char *name="X") const
virtual void	load (const char *filename, const char *name="X")
Protected Methods
virtual void	reset ()

---

Detailed Description

abstract base class for vectors with arithmetic operations.

NAME: Vector(Type) - abstract base class for vectors with arithmetic operations

DESCRIPTION:

The class serves as base for various vector classes, such as standard vectors implemented as one-dimensional arrays, and vectors represented by two- and three-dimensional arrays. The latter formats are useful in connection with point operator matrices (e.g. in finite difference methods).

---

Constructor & Destructor Documentation

Vector(Type)::Vector_Type ( )

The only constructor requires no input. No further initialization of this class is required.

Vector(Type)::~Vector(Type) ( ; ) const [pure virtual]

---

Member Function Documentation

void Vector(Type)::add ( Type a, const Vector(Type) & yb, Type b, const Vector(Type) & zb ) [pure virtual]

Reimplemented in ArrayGenSel(Type), and Vec(Type).

void Vector(Type)::add ( const Vector(Type) & yb, Type b, const Vector(Type) & zb ) [pure virtual]

Reimplemented in ArrayGenSel(Type), and Vec(Type).

void Vector(Type)::add ( const Vector(Type) & yb, char s, const Vector(Type) & zb ) [pure virtual]

Reimplemented in ArrayGenSel(Type), and Vec(Type).

void Vector(Type)::add ( const Vector(Type) & yb, const Vector(Type) & zb ) [pure virtual]

Reimplemented in ArrayGenSel(Type), and Vec(Type).

void Vector(Type)::assemble ( const Vec(Type) & ev, const VecSimple(int) & idx_trans, int elm_no ) [virtual]

Reimplemented in Vec(Type).

void Vector(Type)::fill ( const Type & a ) [pure virtual]

Reimplemented in ArrayGen(Type), ArrayGenSel(Type), and Vec(Type).

void Vector(Type)::fill ( const Vector(Type) & X ) [pure virtual]

Reimplemented in ArrayGen(Type), ArrayGenSel(Type), and Vec(Type).

real Vector(Type)::getStorage ( ) const [pure virtual]

Reimplemented in Vec(Type).

int Vector(Type)::getWork ( const VectorWork work_tp = NORM_WORK ) const [virtual]

returns the operation count for the last computation of the type indicated by the "VectorWork" argument.

Type Vector(Type)::inner ( const Vector(Type) & yb ) const [pure virtual]

Reimplemented in ArrayGenSel(Type), and Vec(Type).

void Vector(Type)::load ( const char * filename, const char * name = "X" ) [virtual]

Reimplemented in Vec(Type).

bool Vector(Type)::makeItSimilar ( Handle(Vector(Type)) & v ) const [pure virtual]

Reimplemented in ArrayGen(Type), ArrayGenSel(Type), and Vec(Type).

void Vector(Type)::mult ( Type value ) [pure virtual]

Reimplemented in ArrayGenSel(Type), and Vec(Type).

real Vector(Type)::norm ( Norm_type lp = l2 ) const [pure virtual]

Reimplemented in ArrayGenSel(Type), and Vec(Type).

real Vector(Type)::normDiff ( const Vector(Type) & y, Norm_type lp = l2 ) const [pure virtual]

Reimplemented in ArrayGenSel(Type), and Vec(Type).

Vector(Type) & Vector(Type)::operator= ( Type a ) [inline]

Vector(Type) & Vector(Type)::operator= ( const Vector(Type) & X ) [inline]

void Vector(Type)::print ( Os os, const char * header = NULL, int nentries_per_line = 3 ) const [pure virtual]

Reimplemented in ArrayGen(Type), ArrayGenSel(Type), and Vec(Type).

void Vector(Type)::printAscii ( Os os, const char * header = NULL ) const [pure virtual]

Reimplemented in ArrayGen(Type), and Vec(Type).

void Vector(Type)::randomize ( real low = -1, real high = 1, real seed = 1 ) [pure virtual]

Reimplemented in Vec(Type).

bool Vector(Type)::redim ( const Vector(prm_Type) & pm ) [pure virtual]

Reimplemented in ArrayGen(Type), ArrayGenSel(Type), and Vec(Type).

void Vector(Type)::reset ( ) [protected, virtual]

Reimplemented in ArrayGenSel(Type).

void Vector(Type)::save ( const char * filename, const char * name = "X" ) const [virtual]

Reimplemented in Vec(Type).

void Vector(Type)::scan ( Is is ) [pure virtual]

Reimplemented in ArrayGen(Type), ArrayGenSel(Type), and Vec(Type).

---

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

• Vector_Type.h

---