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

IG::Num::Func3dFromScalarFunction Class Reference

Scalar function of 3 variables that is based on a general scalar function of vector argument. More...

Inheritance diagram for IG::Num::Func3dFromScalarFunction:
Collaboration diagram for IG::Num::Func3dFromScalarFunction:

List of all members.

Public Member Functions

 Func3dFromScalarFunction (IScalarFunction originalFunction)
 Constructs a scalar function of 3 variables from the specified scalar function of a vector argument.
override double Value (double x, double y, double z)
 Calculates and returns value of the current 3D scalar function.
override void Gradient (double x, double y, double z, out double gradx, out double grady, out double gradz)
 Calculates gradient of the current 3D scalar function and returns its components through the specified output variables.
override void Hessian (double x, double y, double z, out double dxx, out double dyy, out double dzz, out double dxy, out double dxz, out double dyz)
 Calculates Hessian of the current 3D scalar function and returns its component through the specified output variables.

Protected Member Functions

 Func3dFromScalarFunction ()

Properties

IScalarFunction OriginalFunction [get, set]
 Scalar function of vector argument that is used for evaluation of the current function value, gradient, and Hessian.

Private Attributes

IScalarFunction _originalFunction

Detailed Description

Scalar function of 3 variables that is based on a general scalar function of vector argument.

$A Igor Oct11;


Constructor & Destructor Documentation

IG::Num::Func3dFromScalarFunction::Func3dFromScalarFunction ( ) [inline, protected]
IG::Num::Func3dFromScalarFunction::Func3dFromScalarFunction ( IScalarFunction  originalFunction) [inline]

Constructs a scalar function of 3 variables from the specified scalar function of a vector argument.

Parameters:
scalarFunctionOriginal scalar function of vector argument used for evaluation.

Member Function Documentation

override double IG::Num::Func3dFromScalarFunction::Value ( double  x,
double  y,
double  z 
) [inline]

Calculates and returns value of the current 3D scalar function.

Parameters:
xFirst parameter.
ySecond parameter.
zThird parameter.

Implements IG::Num::IFunc3d.

override void IG::Num::Func3dFromScalarFunction::Gradient ( double  x,
double  y,
double  z,
out double  gradx,
out double  grady,
out double  gradz 
) [inline]

Calculates gradient of the current 3D scalar function and returns its components through the specified output variables.

Parameters:
xFirst parameter.
ySecond parameter.
zThird parameter.
gradxFirst component of the returned gradient.
gradySecond component of the returned gradient.
gradzThird component of the returned gradient.

Implements IG::Num::IFunc3d.

override void IG::Num::Func3dFromScalarFunction::Hessian ( double  x,
double  y,
double  z,
out double  dxx,
out double  dyy,
out double  dzz,
out double  dxy,
out double  dxz,
out double  dyz 
) [inline]

Calculates Hessian of the current 3D scalar function and returns its component through the specified output variables.

Parameters:
xFirst parameter.
ySecond parameter.
zThird parameter.
dxxComponent 1-1 of the calculated Hessian.
dyyComponent 2-2 of the calculated Hessian.
dzzComponent 3-3 of the calculated Hessian.
dxyComponent 1-2 of the calculated Hessian.
dxzComponent 1-3 of the calculated Hessian.
dyzComponent 2-3 of the calculated Hessian.

Implements IG::Num::IFunc3d.


Member Data Documentation


Property Documentation

IScalarFunction IG::Num::Func3dFromScalarFunction::OriginalFunction [get, set]

Scalar function of vector argument that is used for evaluation of the current function value, gradient, and Hessian.


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