NumParametersBC - Implementation class for optimisation parameter bounds.

Developer Documentation

Centre for Vision, Speech & Signal Processing

Comments:
This is the implemtation class for optimisation parameter bounds. The NumParametersC handle class should be used.

Parent Classes:

BodyRefCounterC

Variables:

VectorC _minP;
VectorC _maxP;
VectorC _constP;
IntSArray1dC _steps;
IntSArray1dC _mask;

Methods:

NumParametersBC(const VectorC & minP,const VectorC & maxP,const IntSArray1dC & steps)

Constructor

minP	lower bound on function input
maxP	upper bound on function input
steps	number of steps to use with each parameter (if applicable)

All parameters are enabled in optimisation.

NumParametersBC(const VectorC & minP,const VectorC & maxP,const IntSArray1dC & steps,const IntSArray1dC & mask)

Constructor

minP	lower bound on function input
maxP	upper bound on function input
steps	number of steps to use with each parameter (if applicable)
mask	specifies which elements of P to use in X

Only the parameters with a mask value of 1 are presented to the optimiser.

NumParametersBC(SizeT nparams)

Constructor.
This setsup nparams with defaults settings of : minP=0 maxP=1 Steps=1 mask=0 (constP = 0)

NumParametersBC(istream & in)

Constructs for a stream

NumParametersBC(const NumParametersBC & oth)

Copy constructor

NumParametersBC & Copy() const

Makes a deep copy

SizeT N() const

Get number of paramtiers in set.

void SetMask(const IntSArray1dC & mask)

Changes the parameter mask

void SetConstP(const VectorC & constP)

Specifies the values to use for constant parameters

const VectorC MinX() const

Lower parameter bound for optimisation

const VectorC MaxX() const

Upper parameter bound for optimisation

const IntSArray1dC Steps() const

Number of steps in each parameter for optimisation

const MatrixC TransP2X() const

Transformation between P and X

const MatrixC TransX2P() const

Transformation between X and P

const VectorC ConstP() const

Vector with constant P elements set, else 0

const VectorC StartX() const

Returns initial parameter value which is TransP2X * constP

void Setup(IndexT p,RealT min,RealT max,IntT steps,IntT mask = 1)

Setup paramiter p.

void Setup(IndexT p,RealT min,RealT max,IntT steps,RealT constV,IntT mask = 1)

Setup paramiter p, and constant value.

void Save(ostream & out) const

Saves to stream, from which can be constructed

#include "amma/BRefCnt.hh"

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.

#include "amma/RefCBase.hh"

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.

Programmer:Robert Crida, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

NumParametersBC

Implementation class for optimisation parameter bounds.

include	"amma/Num/NumParametersB.hh"
User Level:	Default
Library:	NumCost
Example:	testNumCost.cc
Section:	Optimisation.Cost Functions Numerical Methods.Optimisation.Cost Functions
In Scope:	std