PUBLIC

SimplexBodyC::SimplexBodyC(IntT) SimplexBodyC::SimplexBodyC(istream &) SimplexBodyC::SimplexBodyC(const SimplexBodyC &) SimplexBodyC::Save(ostream &) const SimplexBodyC::Copy(void) const SimplexBodyC::Initialise(const VectorC &,const VectorC &) SimplexBodyC::SetHiLoVertices(void) SimplexBodyC::CalculateSum(void) SimplexBodyC::Extrapolate(RealT) const SimplexBodyC::MultiContract(void) SimplexBodyC::GetYhi(void) const SimplexBodyC::GetPhi(void) const SimplexBodyC::GetYnhi(void) const SimplexBodyC::GetYlo(void) const SimplexBodyC::GetIlo(void) const SimplexBodyC::GetVertices(void) const SimplexBodyC::Values(void) SimplexBodyC::ReplaceHi(const VectorC &,RealT) SimplexBodyC::operator<<(ostream &,const SimplexBodyC &) SimplexBodyC::operator>>(istream &,SimplexBodyC &) BodyRefCounterVC::Copy(void) const BodyRefCounterVC::operator==(const BodyRefCounterVC &) const BodyRefCounterVC::operator!=(const BodyRefCounterVC &) const BodyRefCounterVC::Save(ostream &) const BodyRefCounterC::AddReference(void) BodyRefCounterC::RemoveReference(void) BodyRefCounterC::SetConst(void) const BodyRefCounterC::SetConst(void) BodyRefCounterC::IsConst(void) const BodyRefCounterC::IsNotConst(void) const BodyRefCounterC::ToBeDeleted(void) const BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void) BodyRefCounterC::ToBeDeletedRemove(void) BodyRefCounterC::BodyMightBeDeleted(void) const BodyRefCounterC::IsCountZero(void) const BodyRefCounterC::BRCPtrCanDeleteObject(void) const BodyRefCounterC::Count(void) const BodyRefCounterC::operator=(const BodyRefCounterC &) BodyRefCounterC::IsValidObject(void) const BodyRefCounterC::UserBitTest(IntT) const BodyRefCounterC::UserBitSet(IntT,BooleanT) BodyRefCounterC::UserBitZero(IntT) BodyRefCounterC::ReportBRCError(char *) BodyRefCounterC::Hash(void) const BodyRefCounterC::SetUndeletable(void) BodyRefCounterC::ReportInvalidObject(char *) const RefCounterBaseC::Label(void) const

SimplexBodyC
Implementation class for simplex an a few operations
include	"amma/Num/Simplex.hh"
User Level:	Default
Library:	NumOptimise
Example:	testNumOptimise.cc
Section:	Optimisation Numerical Methods.Optimisation
In Scope:	std

Comments:

public BodyRefCounterVC

SArray1dC vertices;

VectorC values;

VectorC psum;

IndexC ihi;

IndexC ilo;

IndexC inhi;

SimplexBodyC(IntT ndim)

Constructor

SimplexBodyC(istream & in)

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

SimplexBodyC(const SimplexBodyC & oth)

Copy constructor

BooleanT Save(ostream & out) const

Save to ostream.
This allows a streaming from base class without knowing what the full class type is.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

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

initialise the vertices in the simplex

void SetHiLoVertices()

Finds the highest and lowest points in the simplex and stores them.

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)

Replaces the highest point by the candidate point and updates the sum of the vertives of the simplex

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

output stream operator

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

input stream operator

BodyRefCounterVC & Copy() const

Creat a copy of this object.

BooleanT operator==(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT operator!=(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT Save(ostream & out) const

Save to ostream.

void AddReference()

Another reference to the object has been created.

void RemoveReference()

One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.

void SetConst(void) const

This locks the object.
Often objects you wish to lock are already const.

void SetConst(void)

This locks the object.

BooleanT IsConst(void) const

Returns TRUE if the object is locked, ie. it is assumed to be constant.

BooleanT IsNotConst(void) const

Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------

BooleanT ToBeDeleted() const

Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.

BooleanT ToBeDeletedRemoveIgnoreNoRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object.

BooleanT ToBeDeletedRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.

BooleanT BodyMightBeDeleted() const

Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .

BooleanT IsCountZero() const

Are there any refrences left ?

BooleanT BRCPtrCanDeleteObject() const

Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.

IntT Count() const

Returns the current state of the counter, ie. how many references to this object exist.

const BodyRefCounterC & operator=(const BodyRefCounterC & b)

It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.

BooleanT IsValidObject() const

Test if object is valid.
When amma check is disabled this always returns true.

BooleanT UserBitTest(IntT x) const

Test user flag.

void UserBitSet(IntT x,BooleanT setit = TRUE)

Test user flag.

void UserBitZero(IntT x)

Set bit to zero.

void ReportBRCError(char * Msg)

Report error, used in BRCPtrC.

UIntT Hash() const

Hash on address of object.

void SetUndeletable()

Make object undeletable.
Usefull to prevent recursive deleting in graph structures. Only hackers need this function.

void ReportInvalidObject(char * Msg = 0) const

Tell user about validation failure.

LabelT Label() const

Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.