Diffpack Documentation

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Search

LinEqVector_prm Class Reference

parameters for initializing a "LinEqVector" object. More...

#include <LinEqVector_prm.h>

Inheritance diagram for LinEqVector_prm::

Public Methods
	LinEqVector_prm (int nblockvecs=1, bool allocate=true)
	~LinEqVector_prm ()
bool	redim (int nblockvecs, bool allocate=true)
int	size () const
void	operator= (const LinEqVector_prm &pm)
Vector(prm_NUMT)&	vec (int i=1)
const Vector(prm_NUMT)&	vec (int i=1) const
void	attach (const Vector(prm_NUMT) &vecpm, int i=1)
bool	ok () const
Protected Attributes
VecSimplest(Handle(Vector(prm_NUMT)))	vecvec_prm

Detailed Description

parameters for initializing a "LinEqVector" object.

NAME: LinEqVector_prm - parameters for initializing a "LinEqVector" object

DESCRIPTION:

The object contains a vector of "Handle(Vector(prm_NUMT))" instances, one instance for each block in a "LinEqVector" class object. The present class "LinEqVector_prm" is used as input to the constructor of "LinEqVector" if "LinEqVector" is to allocate memory or redimension its internal arrays.

Since most applications where "LinEqVector_prm" is used involve only a single block (i.e. the length of the vector containing "Handle(Vector(prm_NUMT))" is 1), indices for the blocks can be omitted if there is only a single block (cf. the default values of the parameters in the member functions of the class).

Constructor & Destructor Documentation

LinEqVector_prm::LinEqVector_prm ( int nblockvecs = 1,

bool allocate = true )

The constructor takes the number of block vectors in "LinEqVector" as argument (default value equals 1). In addition, a "bool" variable indicating whether a new "Vector_prm(NUMT)" object should be allocated and attached to this "LinEqVector_prm" must be given (default: "true"). If not, the user must supply "Vector_prm(NUMT)" objects and attach them to this "LinEqVector_prm" object.
Further initialization is necessary: each "Handle(Vector(prm_NUMT))" must be initialized (using "attach") by the programmer, or if the "Vector_prm(NUMT)" objects are allocated internally the contents of the "Vector_prm(NUMT)" objects must be filled. For this purpose the "vec" function can be used to access a particular "Vector_prm(NUMT)" object. The member function "ok" can be used to ensure that the object is properly initialized.

LinEqVector_prm::~LinEqVector_prm ( )

Member Function Documentation

void LinEqVector_prm::attach ( const Vector(prm_NUMT) & vecpm,

int i = 1 ) [inline]

attaches a "Vector_prm(NUMT)" object.

bool LinEqVector_prm::ok ( ) const

checks if the object is properly initialized (all handles are non-empty).

void LinEqVector_prm::operator= ( const LinEqVector_prm & pm )

bool LinEqVector_prm::redim ( int nblockvecs,

bool allocate = true )

int LinEqVector_prm::size ( ) const [inline]

const Vector(prm_NUMT) & LinEqVector_prm::vec ( int i = 1 ) const [inline]

See documentation of one of the overloaded functions.

Vector(prm_NUMT) & LinEqVector_prm::vec ( int i = 1 ) [inline]

enables indexing of the internal array of "Handle(Vector(prm_NUMT))" objects.

Member Data Documentation

VecSimplest(Handle(Vector(prm_NUMT))) LinEqVector_prm::vecvec_prm [protected]

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

LinEqVector_prm.h