PUBLIC

StateVectorC::StateVectorC(void) StateVectorC::StateVectorC(int) StateVectorC::StateVectorC(const StateVectorC &) StateVectorC::operator=(const StateVectorC &) StateVectorC::~StateVectorC(void) StateVectorC::operator+(const StateVectorC &) StateVectorC::operator-(const StateVectorC &) StateVectorC::operator*(const RealT &) StateVectorC::Assign(const StateVectorC &) StateVectorC::Copy(void) StateVectorC::MaxDiff(const StateVectorC &) StateVectorC::Abs(void) StateVectorC::LargerThan(const StateVectorC &,const RealT &) StateVectorC::LargerThan(const RealT &,const RealT &) StateVectorC::IsEmpty(void) StateVectorC::DisplayVal(void) const

StateVectorC
An example class used in for instance the example program ex_kutta
include	"amma/StateVec.hh"
User Level:	Default
Library:	diffeq
Example:	ex_kutta.cc
Section:	Numerical Methods
In Scope:	std

Comments:
Resembles a VectorC class, but has different member functions, most of which are specific for use with the template class RungeKuttaC. Because the member 'vec' is a big object, this class is a big object as well.

SArray1dC vec;

int dimens;

StateVectorC()

null constructor

StateVectorC(int dim)

constructor

StateVectorC(const StateVectorC & q)

copy constructor; makes new handle

StateVectorC & operator=(const StateVectorC & q)

~StateVectorC()

destructor

StateVectorC operator+(const StateVectorC & q)

overloaded operator to add two vectors with the same dimension

StateVectorC operator-(const StateVectorC & q)

overloaded operator to subtract two vectors with the same dimension

StateVectorC operator*(const RealT & val)

overloaded operator to multiply each element in the vector with a value

void Assign(const StateVectorC & v)

copy contents of v into 'this', since = is handle reassignment

StateVectorC Copy(void)

makes a copy of 'this'

double MaxDiff(const StateVectorC & v)

maximum difference between any element of *this and v

StateVectorC Abs()

absolute values of the member 'vec'

BooleanT LargerThan(const StateVectorC & q,const RealT & threshold)

true if (threshold*this > q) for all elements of this & q

BooleanT LargerThan(const RealT & val,const RealT & threshold)

true if (all elements of threshold*this) > val

BooleanT IsEmpty()

true if member 'vec' contains no elements

void DisplayVal() const

displays the contents of member 'vec'