PUBLIC

NumCostFunctionC::NumCostFunctionC(const NumParametersC &,const VectorC &,const NumFuncC &,const NumMagnitudeC &) NumCostC::Copy(void) const NumCostC::Cost(const VectorC &) const NumCostC::SetMask(const IntSArray1dC &) NumCostC::SetConstP(const VectorC &) NumCostC::MinX(void) const NumCostC::MaxX(void) const NumCostC::StartX(void) const NumCostC::ConvertX2P(const VectorC &) const NumCostC::Steps(void) const NumCostC::GetParameters(void) const NumFuncC::IsA(const DPEntityC &) NumFuncC::Copy(void) const NumFuncC::operator=(const NumFuncC &) NumFuncC::Evaluate(const VectorC &) const NumFuncC::Evaluate(const DListC &) const NumFuncC::operator()(const VectorC &) const NumFuncC::Jacobian(const VectorC &) const NumFuncC::GetInfo(void) const NumFuncC::GetName(void) const NumFuncC::SizeX(void) const NumFuncC::SizeY(void) const NumFuncC::Save(ostream &) const DPProcessC::Apply(const InT &) DPProcessC::ApplyArray(const SArray1dC &,SArray1dC &) DPProcessC::operator=(const DPProcessC &) DPProcessC::Copy(void) const DPProcessBaseC::InputType(void) const DPProcessBaseC::OutputType(void) const DPProcessBaseC::IsStateless(void) const DPProcessBaseC::OpType(void) const DPProcessBaseC::operator=(const DPProcessBaseC &) DPEntityC::operator=(const DPEntityC &) DPEntityC::Body(void) DPEntityC::Body(void) const DPEntityC::Save(ostream &) const 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

NumCostFunctionC
Optimisation cost function interface to functions derived from NumFuncC.
include	"amma/Num/NumCostFunction.hh"
User Level:	Default
Library:	NumCost
Example:	testNumCost.cc
Section:	Optimisation.Cost Functions.Implementation Numerical Methods.Optimisation.Cost Functions.Implementation
In Scope:	std

Comments:
Provides an interface to allow numerical optimisation with any class that is derived from NumFuncC. Some degree of constrained optimisation can be achieved in that the NumParametersC object specifies which inputs to the function can be varied and which are fixed. The value of the fixed parameters can be specified.

public NumCostC

NumCostFunctionC(const NumParametersC & parameters,const VectorC & Yd,const NumFuncC & function,const NumMagnitudeC & metric)

Constructor

parameters	describes which parameters to use for optimisation
Yd	the desired output from the function
function	the function to be optimised
metric	a method for calculating the size of |f(X)-Yd|

NumCostC Copy() const

Makes a deep copy

RealT Cost(const VectorC & X) const

Calculates the cost of the current vector X

void SetMask(const IntSArray1dC & mask)

Sets the mask of enables parameters

void SetConstP(const VectorC & constP)

Sets the values for constant parameters.
The value of non-constant parameters will be used as a starting point

const VectorC MinX() const

Lower bound on optimisation vector X

const VectorC MaxX() const

Upper bound on optimisation vector X

const VectorC StartX() const

Initial X value obtained from SetConstP

VectorC ConvertX2P(const VectorC & X) const

Converts an X vector to a full P vector

const IntSArray1dC Steps() const

Gets number of steps to use for each dimension

const NumParametersC & GetParameters() const

Access to the parameter storage class

BooleanT IsA(const DPEntityC & pb)

Check if an object is a NumFuncC.

NumFuncC Copy() const

Makes a deep copy

NumFuncC & operator=(const NumFuncC & oth)

Assignment operator

VectorC Evaluate(const VectorC & X) const

Evaluates function Y=f(X)

DListC<VectorC> Evaluate(const DListC<VectorC> & listX) const

Evaluates function Y=f(X) for a list of X

VectorC operator()(const VectorC & X) const

Evaluates function Y=f(X)

MatrixC Jacobian(const VectorC & X) const

Evaluates Jacobian df(X)/dX
Note that this is not const=0 since the base class will calculate a numerical estimate of the Jacobian using differences if the member function is not overloaded in derived classes to provide an analytical solution.

const StringC GetInfo() const

Gets string describing object

const StringC GetName() const

Gets type name of the object

UIntT SizeX() const

Input vector dimension

UIntT SizeY() const

Output vector dimension

BooleanT Save(ostream & out) const

Writes object to stream, cna be loaded using constructor

VectorC Apply(const VectorC & dat)

Apply operation.
NB. This may become constant in the future, but the situation isn't clear at the moment.

IntT ApplyArray(const SArray1dC<VectorC> & in,SArray1dC<VectorC> & out)

Streaming version.

const DPProcessC<VectorC,VectorC> operator=(const DPProcessC<VectorC,VectorC> & in)

Assignment operator

const DPProcessC<VectorC,VectorC> Copy() const

Make a copy of this process. Some type defs.

const type_info & InputType() const

Get input type.

const type_info & OutputType() const

Get input type.

BooleanT IsStateless() const

Is operation stateless ?

DPProcessBaseBodyC::ProcTypeT OpType() const

Operation type lossy/lossless.

const DPProcessBaseC & operator=(const DPProcessBaseC & oth)

Assignment operator.

const DPEntityC & operator=(const DPEntityC & dat)

Assignment.

DPEntityBodyC & Body()

Access body.

const DPEntityBodyC & Body() const

Access body.

BooleanT Save(ostream & out) const

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

Assignment.

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

Comparison operator.

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

DPEntityBodyC & Body()

Direct access to body.

const DPEntityBodyC & Body() const

Constant access to body.