PUBLIC

NumParametersC::NumParametersC(void) NumParametersC::NumParametersC(const VectorC &,const VectorC &,const IntSArray1dC &) NumParametersC::NumParametersC(const VectorC &,const VectorC &,const IntSArray1dC &,const IntSArray1dC &) NumParametersC::NumParametersC(SizeT) NumParametersC::NumParametersC(istream &) NumParametersC::NumParametersC(const NumParametersC &) NumParametersC::NumParametersC(NumParametersBC &) NumParametersC::Copy(void) const NumParametersC::N(void) const NumParametersC::operator=(const NumParametersC &) NumParametersC::SetMask(const IntSArray1dC &) NumParametersC::SetConstP(const VectorC &) NumParametersC::MinX(void) const NumParametersC::MaxX(void) const NumParametersC::Steps(void) const NumParametersC::TransP2X(void) const NumParametersC::TransX2P(void) const NumParametersC::ConstP(void) const NumParametersC::StartX(void) const NumParametersC::Setup(IndexT,RealT,RealT,IntT,IntT) NumParametersC::Setup(IndexT,RealT,RealT,IntT,RealT,IntT) NumParametersC::Save(ostream &) 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

NumParametersC
Handle class for optimisation parameter bounds.
include	"amma/Num/NumParameters.hh"
User Level:	Default
Library:	NumCost
Example:	testNumCost.cc
Section:	Optimisation.Cost Functions Numerical Methods.Optimisation.Cost Functions
In Scope:	std

Comments:
Handle class for parameter bounds class. Used to specify constraints for the optimiser on starting conditions, parameter boundaries and resolution for each parameter. Also used to fix certain parameters as constants during optimisation. this is achieved as follows: A mask is used to disable some parameters which will then be treated by the cost function as constants and become invisible to the optimiser.

Note that there is a distinction made here between the vector X which is input to the cost function and optimised and the input parameters to the function P. X is a subset of P.

public RCHandleC<class Bod>

NumParametersC()

Default constructor

NumParametersC(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.

NumParametersC(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.

NumParametersC(SizeT nparams)

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

NumParametersC(istream & in)

Constructs from stream

NumParametersC(const NumParametersC & oth)

Copy constructor

NumParametersC(NumParametersBC & oth)

Constructs from base class

NumParametersC Copy() const

Makes a deep copy

SizeT N() const

Get number of paramtiers in set.

NumParametersC & operator=(const NumParametersC & oth)

Assignment operator

void SetMask(const IntSArray1dC & mask)

Sets which parameters are enabled

void SetConstP(const VectorC & constP)

Sets const parameter values and starting point for enabled ones

const VectorC MinX() const

Lower bound on optimisation parameters

const VectorC MaxX() const

Upper bound on optimisation parameters

const IntSArray1dC Steps() const

Number of steps to use for each dimension

const MatrixC TransP2X() const

Matrix for converting P to X

const MatrixC TransX2P() const

Matrix for converting X to P.
Note that const P elements will be 0 and must add the vector ConstP below for proper estimate of P.

const VectorC ConstP() const

Vector containing constant P elements and 0s

const VectorC StartX() const

Starting vector for X which is subset of value specified in SetConstP.

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

Writes object to stream, cna be loaded using constructor

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<NumParametersBC> & operator=(const RCHandleC<NumParametersBC> & oth)

Assignment.

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

Comparison operator.

BooleanT operator!=(const RCHandleC<NumParametersBC> & 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.

NumParametersBC & Body()

Direct access to body.

const NumParametersBC & Body() const

Constant access to body.