class HCL_EvalFunctionalProductDomainGrad_d : public HCL_EvaluateFunctionalGrad_d

HCL_EvalFunctionalProductDomainGrad_d is the base class for the evaluation object created by an object of type HCL_FunctionalProductDomainGrad_, a real-valued function defined on a product vector space

Inheritance:

Public Methods

virtual HCL_VectorSpace_d&	Domain () Domain returns a reference to the domain of the underlying function
virtual void	Gradient ( HCL_Vector_d & g ) Gradient computes the gradient of the function
	HCL_EvalFunctionalProductDomainGrad_d ( int n ) Constructor called by derived classes; needs the number of factors in the domain space
virtual void	PartialGradient ( HCL_Vector_d & g, int i ) PartialGradient computes the component of the gradient corresponding to the ith component of the independent variable
virtual const HCL_Vector_d&	PartialGradientRef ( int i ) PartialGradientRef returns a reference to the component of the gradient corresponding to the ith component of the independent variable
virtual HCL_ProductVectorSpace_d&	ProductDomain () ProductDomain returns a reference to the domain as a product vector space
virtual double	Value () Value computes the value of the function
virtual ostream&	Write ( ostream & str ) Debugging information

Inherited from HCL_EvaluateFunctionalGrad_d:

Public Methods

virtual const HCL_Vector_d& GradientRef()

virtual double ValueRef()

Inherited from HCL_Base:

Public Methods

int Count()

void DecCount()

void IncCount()

Private Fields

int ReferenceCount

HCL_EvalFunctionalProductDomainGrad_d( int n )

Constructor called by derived classes; needs the number of factors in the domain space

virtual HCL_VectorSpace_d& Domain()

Domain returns a reference to the domain of the underlying function

virtual HCL_ProductVectorSpace_d& ProductDomain()

ProductDomain returns a reference to the domain as a product vector space

virtual double Value()

Value computes the value of the function. This function must be implemented in each concrete derived class. It is recommended that any calculations that are required for both the value and gradient be done in the constructor; Value should then complete the computation of the functional value.

virtual void Gradient( HCL_Vector_d & g )

Gradient computes the gradient of the function. It is recommended that any calculations that are required for both the value and gradient be done in the constructor; Gradient should then complete the computation of the gradient.

virtual void PartialGradient( HCL_Vector_d & g, int i )

PartialGradient computes the component of the gradient corresponding to the ith component of the independent variable

virtual const HCL_Vector_d& PartialGradientRef( int i )

PartialGradientRef returns a reference to the component of the gradient corresponding to the ith component of the independent variable. This relieves the calling program of the responsibility of managing the storage of the gradient. This method is implemented in this (the base) class, and need not be re-implemented in derived classes.

virtual ostream& Write( ostream & str )

Debugging information. Write should be implemented to print a description of the object that will be useful for debugging. If a complete description is lengthy, an implementor should consider just printing out a useful subset. This method will likely be used to send information to the screen when a error condition is encountered.

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de