IG::Num::Func3dLinear Class Reference

Linear (Affine) function of 3 variables. Function is evaluated according to fl(x) = b^T*x + c where x is vector of parameters, b is the vector of linear coefficients (gradient at x=0) and c is the scalar term (function value at x=0). More...

Inheritance diagram for IG::Num::Func3dLinear:

Collaboration diagram for IG::Num::Func3dLinear:

List of all members.

Public Member Functions
	Func3dLinear (vec3 gradient0, double scalarTerm)
	Creation of a linear 3D scalar function. Parameters: gradient0 Vector of linear coefficients - gradient of the linear function. scalarTerm Constant term.
override double	Value (vec3 parameters)
	Calculates and returns value of the current 3D linear function.
override vec3	Gradient (vec3 parameters)
	Calculates and returns gradient of the current 3D linear function.
override mat3	Hessian (vec3 parameters)
	Calculates and returns Hessian of the current 3D linear function (identical to zero matrix) and returns it (in the form of a mat3 struct).
Static Public Member Functions
static int	GetNumConstants ()
	Returns the number of scalar constants that specify the current function.
Properties
vec3	Gradient0 [get, set]
	Vector of linear coefficients (equal to gradient of the function).
double	ScalarTerm [get, set]
	Scalar additive constant.
Private Member Functions
	Func3dLinear ()
Private Attributes
vec3	_b
double	_c

---

Detailed Description

Linear (Affine) function of 3 variables.

Function is evaluated according to fl(x) = b^T*x + c where x is vector of parameters, b is the vector of linear coefficients (gradient at x=0) and c is the scalar term (function value at x=0).

$A Igor Aug09;

---

Constructor & Destructor Documentation

IG::Num::Func3dLinear::Func3dLinear

(

)

[inline, private]

IG::Num::Func3dLinear::Func3dLinear	(	vec3	gradient0,
		double	scalarTerm
	)		[inline]

Creation of a linear 3D scalar function.

Parameters:

gradient0	Vector of linear coefficients - gradient of the linear function.
scalarTerm	Constant term.

---

Member Function Documentation

static int IG::Num::Func3dLinear::GetNumConstants

(

)

[inline, static]

Returns the number of scalar constants that specify the current function.

override double IG::Num::Func3dLinear::Value

(

vec3

parameters

)

[inline]

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

Parameters:

parameters

Vector of function parameters (in form of the vec3) struct.

Returns:

Function value.

Implements IG::Num::IFunc3d.

override vec3 IG::Num::Func3dLinear::Gradient

(

vec3

parameters

)

[inline]

Calculates and returns gradient of the current 3D linear function.

Parameters:

parameters

Vector of parameters (in form of the vec3 struct).

<returnreturns>Gradient of the current 3D scalar function (in form of the vec3 struct)</returnreturns>

Implements IG::Num::IFunc3d.

override mat3 IG::Num::Func3dLinear::Hessian

(

vec3

parameters

)

[inline]

Calculates and returns Hessian of the current 3D linear function (identical to zero matrix) and returns it (in the form of a mat3 struct).

Implements IG::Num::IFunc3d.

---

Member Data Documentation

vec3 IG::Num::Func3dLinear::_b [private]

double IG::Num::Func3dLinear::_c [private]

---

Property Documentation

vec3 IG::Num::Func3dLinear::Gradient0 [get, set]

Vector of linear coefficients (equal to gradient of the function).

double IG::Num::Func3dLinear::ScalarTerm [get, set]

Scalar additive constant.

---

The documentation for this class was generated from the following file:

• Function3d.cs