PUBLIC

NumMagnitudeEuclideanC::NumMagnitudeEuclideanC(void) NumMagnitudeEuclideanC::NumMagnitudeEuclideanC(BooleanT) NumMagnitudeEuclideanC::IsA(const DPEntityC &) NumMagnitudeEuclideanC::NumMagnitudeEuclideanC(const DPProcessBaseC &) NumMagnitudeC::IsA(const DPEntityC &) NumMagnitudeC::Copy(void) const NumMagnitudeC::Magnitude(const VectorC &) const NumMagnitudeC::Magnitude(const DListC &) const NumMagnitudeC::Body(void) const NumMagnitudeC::Body(void) 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 NumFuncC::Body(void) NumFuncC::Body(void) const DPProcessC::Body(void) DPProcessC::Body(void) const DPProcessC::Apply(const InT &) DPProcessC::ApplyArray(const SArray1dC &,SArray1dC &) DPProcessC::operator=(const DPProcessC &) DPProcessC::Copy(void) const DPProcessBaseC::Body(void) DPProcessBaseC::Body(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

NumMagnitudeEuclideanC
Euclidean magnitude metric.
include	"amma/Num/NumMagnitudeEuclidean.hh"
User Level:	Default
Library:	NumMagnitude
Example:	testNumMagnitude.cc
Section:	Numerical Methods.Magnitude Metrics.Implementation
In Scope:	std

Comments:
Class for calculating Euclidean magnitude of a vector s=|X|.

public NumMagnitudeC

NumMagnitudeEuclideanC()

Constructor takes no parameters
NB. For new code use constructor below.

NumMagnitudeEuclideanC(BooleanT)

Constructor takes no parameters

BooleanT IsA(const DPEntityC & pb)

Check if an object is a NumFuncConstant.

NumMagnitudeEuclideanC(const DPProcessBaseC & pb)

Base class constructor.

BooleanT IsA(const DPEntityC & pb)

Check if an object is a NumFuncConstant.

NumMagnitudeC Copy() const

Makes a deep copy

RealT Magnitude(const VectorC & X) const

Calculate the magnitude of the vector X

DListC<RealT> Magnitude(const DListC<VectorC> & listX) const

Calculate the magnitudes of a list of vectors X

const NumMagnitudeBC & Body() const

Body Access function.

NumMagnitudeBC & Body()

Body Access function.

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

NumFuncBC & Body()

Access body.

const NumFuncBC & Body() const

Access body.

DPProcessBodyC<VectorC,VectorC> & Body()

Access body.

const DPProcessBodyC<VectorC,VectorC> & Body() const

Access body.

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.

DPProcessBaseBodyC & Body()

Access body.

const DPProcessBaseBodyC & Body() const

Access body.

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.