PUBLIC

SimplexC::SimplexC(istream &) SimplexC::SimplexC(IntT) SimplexC::SimplexC(const SimplexC &) SimplexC::SimplexC(SimplexBodyC &) SimplexC::Body(void) SimplexC::Body(void) const SimplexC::Initialise(const VectorC &,const VectorC &) SimplexC::SetHiLoVertices(void) SimplexC::CalculateSum(void) SimplexC::Extrapolate(RealT) const SimplexC::MultiContract(void) SimplexC::GetYhi(void) const SimplexC::GetPhi(void) const SimplexC::GetYnhi(void) const SimplexC::GetYlo(void) const SimplexC::GetIlo(void) const SimplexC::GetVertices(void) const SimplexC::Values(void) SimplexC::ReplaceHi(const VectorC &,RealT) SimplexC::operator<<(ostream &,const SimplexC &) SimplexC::operator>>(istream &,SimplexC &) RCHandleAC::Abstract(void) RCHandleAC::IsHandleType(const DT &) const RCHandleAC::CheckHandleType(const DT &) const RCHandleAC::Save(ostream &) const RCHandleAC::Copy(void) const RCHandleC::IsValid(void) const RCHandleC::IsValidObject(void) const RCHandleC::operator=(const RCHandleC &) RCHandleC::operator==(const RCHandleC &) const RCHandleC::operator!=(const RCHandleC &) const RCHandleC::Hash(void) const RCHandleC::IsConst(void) const RCHandleC::IsNotConst(void) const RCHandleC::SetConst(void) const RCHandleC::Invalidate(void) RCHandleC::Body(void) RCHandleC::Body(void) const

SimplexC
Put a brief description of your class here
include	"amma/Num/Simplex.hh"
User Level:	Default
Library:	NumOptimise
Example:	testNumOptimise.cc
Section:	Optimisation Numerical Methods.Optimisation
In Scope:	std

Comments:
Put a more detailed description of your class handle here. You use embedded html to make it clearer in the html documentation

public RCHandleAC<class Bod>

SimplexC(istream & in)

Stream constructor
This creates a new instance of the class from an input stream.

SimplexC(IntT ndim)

Constructor

SimplexC(const SimplexC & oth)

SimplexC(SimplexBodyC & bod)

Body Constructor
This creates a new handle to a body class, it can be usefull if you wish to return handles to the class from within a body function.

SimplexBodyC & Body()

Access body.
This isn't really needed, they're just to ensure all derived classes work properly.

const SimplexBodyC & Body() const

Constant access body.
This isn't really needed, they're just to ensure all derived classes work properly.

void Initialise(const VectorC & Xmin,const VectorC & Xmax)

void SetHiLoVertices()

void CalculateSum()

Calculates the sum of the vertices; used in extrapolation operation

VectorC Extrapolate(RealT fac) const

Extrapolates by a factor 'fac' through the face of the simplex across from the high point; does not modify the simplex - just returns the candidate vertex

SArray1dC<VectorC> MultiContract()

Contract around the lowest (best) point.

RealT GetYhi() const

VectorC GetPhi() const

RealT GetYnhi() const

RealT GetYlo() const

IndexC GetIlo() const

SArray1dC<VectorC> GetVertices() const

VectorC & Values()

void ReplaceHi(const VectorC & ptry,RealT ytry)

ostream & operator<<(ostream & s,const SimplexC & out)

output stream operator

istream & operator>>(istream & s,SimplexC & in)

input stream operator

RCAbstractC Abstract()

Create an abstract handle to this object.

BooleanT IsHandleType(const DT &) const

Is handle of given type ?

void CheckHandleType(const DT & dummy) const

Check handle type. Throw an expception if not.

BooleanT Save(ostream & out) const

Save to ostream.

RCHandleAC<SimplexBodyC> Copy() const

Creat a deep copy of this object.
protected:

BooleanT IsValid() const

Check its a valid handle.

BooleanT IsValidObject() const

Check its a valid handle, and that the object is pointed to is also valid.

RCHandleC<SimplexBodyC> & operator=(const RCHandleC<SimplexBodyC> & oth)

Assignment.

BooleanT operator==(const RCHandleC<SimplexBodyC> & oth) const

Comparison operator.

BooleanT operator!=(const RCHandleC<SimplexBodyC> & oth) const

Comparison operator.

UIntT Hash() const

Hash function.x

BooleanT IsConst() const

Is object constant ?

BooleanT IsNotConst() const

Is object not constant ?

void SetConst(void) const

Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:

void Invalidate()

Turn this into an invalid handle.

SimplexBodyC & Body()

Direct access to body.

const SimplexBodyC & Body() const

Constant access to body.