IGLib 1.4
The IGLib base library for development of numerical, technical and business applications.

IG::Num::ScalarFunctionExamples::Quadratic2d Class Reference

Example quadratic polynomial in 2D. f(x,y) = 2*x^2 + y^2 + x*y + x + y + 10. More...

Inheritance diagram for IG::Num::ScalarFunctionExamples::Quadratic2d:
Collaboration diagram for IG::Num::ScalarFunctionExamples::Quadratic2d:

List of all members.

Public Member Functions

 Quadratic2d ()
 Creates a new untransformed example quadratic polynomial in 2D.
 Quadratic2d (IAffineTransformation transf)
 Creates a new transformed example quadratic polynomial in 2D. Actual function is identical to the reference function applied to inverse transformed parameters.
override double ReferenceValue (IVector parameters)
 Returns the value of this function at the specified parameter in the reference coordinate system.
override void ReferenceGradientPlain (IVector parameters, IVector gradient)
 Calculates the first derivative (gradient) of this function at the specified parameter in the reference coordinate system.
override void ReferenceHessianPlain (IVector parameters, IMatrix hessian)
 Calculates the second derivative (Hessian) of this function at the specified parameters in the reference coordinate system.

Properties

override string Name [get]
 Returns a short name of the function.
override string Description [get]
 Returns a short description of the function.
override bool ValueDefined [get, set]
 Tells whether the first derivative is defined for this function (by implementation, not mathematically)
override bool GradientDefined [get, set]
 Tells whether the first derivative is defined for this function (by implementation, not mathematically)
override bool HessianDefined [get, set]
 Tells whether the second derivative is defined for this function (by implementation, not mathematically)

Detailed Description

Example quadratic polynomial in 2D. f(x,y) = 2*x^2 + y^2 + x*y + x + y + 10.

$A Igor Dec10;


Constructor & Destructor Documentation

IG::Num::ScalarFunctionExamples::Quadratic2d::Quadratic2d ( ) [inline]

Creates a new untransformed example quadratic polynomial in 2D.

IG::Num::ScalarFunctionExamples::Quadratic2d::Quadratic2d ( IAffineTransformation  transf) [inline]

Creates a new transformed example quadratic polynomial in 2D. Actual function is identical to the reference function applied to inverse transformed parameters.

Parameters:
transfAffine transformation that is applied to parameters. If null then the fuction is identical to the untransformed reference function.

Member Function Documentation

override double IG::Num::ScalarFunctionExamples::Quadratic2d::ReferenceValue ( IVector  parameters) [inline, virtual]

Returns the value of this function at the specified parameter in the reference coordinate system.

Parameters:
parametersVector of parameters (in the REFERENCE system) where function is evaluated.

Implements IG::Num::ScalarFunctionBase.

override void IG::Num::ScalarFunctionExamples::Quadratic2d::ReferenceGradientPlain ( IVector  parameters,
IVector  gradient 
) [inline, virtual]

Calculates the first derivative (gradient) of this function at the specified parameter in the reference coordinate system.

Parameters:
parametersVector of parameters (in the REFERENCE system) where derivatives are evaluated.
gradientVector where first derivatives (gradient) are stored.

Implements IG::Num::ScalarFunctionBase.

override void IG::Num::ScalarFunctionExamples::Quadratic2d::ReferenceHessianPlain ( IVector  parameters,
IMatrix  hessian 
) [inline, virtual]

Calculates the second derivative (Hessian) of this function at the specified parameters in the reference coordinate system.

Parameters:
parametersVector of parameters (in the REFERENCE system) where Hessian is evaluated.
hessianMatrix where second derivatives (Hessian) are stored.

Implements IG::Num::ScalarFunctionBase.


Property Documentation

override string IG::Num::ScalarFunctionExamples::Quadratic2d::Name [get]

Returns a short name of the function.

Implements IG::Num::IScalarFunctionUntransformed.

override string IG::Num::ScalarFunctionExamples::Quadratic2d::Description [get]

Returns a short description of the function.

Implements IG::Num::IScalarFunctionUntransformed.

override bool IG::Num::ScalarFunctionExamples::Quadratic2d::ValueDefined [get, set]

Tells whether the first derivative is defined for this function (by implementation, not mathematically)

Implements IG::Num::IScalarFunctionUntransformed.

override bool IG::Num::ScalarFunctionExamples::Quadratic2d::GradientDefined [get, set]

Tells whether the first derivative is defined for this function (by implementation, not mathematically)

Implements IG::Num::IScalarFunctionUntransformed.

override bool IG::Num::ScalarFunctionExamples::Quadratic2d::HessianDefined [get, set]

Tells whether the second derivative is defined for this function (by implementation, not mathematically)

Implements IG::Num::IScalarFunctionUntransformed.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties Events