Public Member Functions | Data Fields

VOL_dvector Class Reference

vector of doubles. More...

#include <VolVolume.h>

Public Member Functions

 VOL_dvector (const int s)
 Construct a vector of size s.
 VOL_dvector ()
 Default constructor creates a vector of size 0.
 VOL_dvector (const VOL_dvector &x)
 Copy constructor makes a replica of x.
 ~VOL_dvector ()
 The destructor deletes the data array.
int size () const
 Return the size of the vector.
double & operator[] (const int i)
 Return a reference to the i-th entry.
double operator[] (const int i) const
 Return the i-th entry.
void clear ()
 Delete the content of the vector and replace it with a vector of length 0.
void cc (const double gamma, const VOL_dvector &w)
 Convex combination.
void allocate (const int s)
 delete the current vector and allocate space for a vector of size s.
void swap (VOL_dvector &w)
 swaps the vector with w.
VOL_dvectoroperator= (const VOL_dvector &w)
 Copy w into the vector.
VOL_dvectoroperator= (const double w)
 Replace every entry in the vector with w.

Data Fields

double * v
 The array holding the vector.
int sz
 The size of the vector.

Detailed Description

vector of doubles.

It is used for most vector operations.

Note: If VOL_DEBUG is defined to be 1 then each time an entry is accessed in the vector the index of the entry is tested for nonnegativity and for being less than the size of the vector. It's good to turn this on while debugging, but in final runs it should be turned off (beause of the performance hit).


Constructor & Destructor Documentation

VOL_dvector::VOL_dvector ( const int  s  )  [inline]

Construct a vector of size s.

The content of the vector is undefined.

References sz, and v.

VOL_dvector::VOL_dvector (  )  [inline]

Default constructor creates a vector of size 0.

VOL_dvector::VOL_dvector ( const VOL_dvector x  )  [inline]

Copy constructor makes a replica of x.

References sz, and v.

VOL_dvector::~VOL_dvector (  )  [inline]

The destructor deletes the data array.

References v.


Member Function Documentation

void VOL_dvector::allocate ( const int  s  )  [inline]

delete the current vector and allocate space for a vector of size s.

References sz, and v.

void VOL_dvector::cc ( const double  gamma,
const VOL_dvector w 
) [inline]

Convex combination.

Replace the current vector v with v = (1-gamma) v + gamma w.

References sz, and v.

void VOL_dvector::clear (  )  [inline]

Delete the content of the vector and replace it with a vector of length 0.

References sz, and v.

VOL_dvector & VOL_dvector::operator= ( const VOL_dvector w  ) 

Copy w into the vector.

Usage: v=w; where w is a VOL_dvector.

References size(), sz, and v.

VOL_dvector & VOL_dvector::operator= ( const double  w  ) 

Replace every entry in the vector with w.

Usage v=w; where w is a double. It copies w in every entry of v.

References sz, and v.

double& VOL_dvector::operator[] ( const int  i  )  [inline]

Return a reference to the i-th entry.

References sz, and v.

double VOL_dvector::operator[] ( const int  i  )  const [inline]

Return the i-th entry.

References sz, and v.

int VOL_dvector::size (  )  const [inline]
void VOL_dvector::swap ( VOL_dvector w  )  [inline]

swaps the vector with w.

References sz, and v.


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