Vector function containing lineer basis in a n-dimensional vector space. Composed of n+1 functions: 1, x1, ..., xn. More...

Inheritance diagram for IG.Num.LinearBasis:

Collaboration diagram for IG.Num.LinearBasis:

Public Member Functions
	LinearBasis (int dimension)
	Constructs a vector function containing linear basis for the specified dimension. Composed of n+1 functions: 1, x1, ..., xn. More...

override double	Value (IVectorFunctionResults evaluationData, int which)
	Calculates and returns the particular component of the vector function value. More...

override double	Derivative (IVectorFunctionResults evaluationData, int which, int component)
	Calculates and returns the particular component of the vector function's derivative. More...

override double	SecondDerivative (IVectorFunctionResults evaluationData, int which, int rowNum, int columnNum)
	Calculates and returns the particular component of the vector function's second derivative (Hessian), which is always 0 in this case. More...

Public Member Functions inherited from IG.Num.VectorFunctionBaseComponentWise
override void	Evaluate (IVectorFunctionResults evaluationData)
	Performs evaluation of requwester function results and writes them to the provided data structure. Uses Evaluate(IVector, ref bool, ref List{double}, ref bool, ref List{IVector}, ref bool, ref List{IMatrix}) to do the job. More...

override void	Evaluate (IVector parameters, ref bool calculateValues, ref List< double > values, ref bool calculateGradients, ref List< IVector > gradients, ref bool calculateHessians, ref List< IMatrix > hessians)
	Calculation of values, gradients, and hessians of the vector function according to request flags. Uses functions for component-wise evaluation to do the job. More...

Public Member Functions inherited from IG.Num.VectorFunctionBaseGeneral
	VectorFunctionBaseGeneral ()

void	SetNumParameters (int num)
	Sets number of parameters of the current vector function to the specified value. More...

void	SetNumValues (int num)
	Sets number of values of the vector function to the specified value. More...

virtual double	Value (IVector parameters, int which)
	Calculates and returns the particular component of the vector function value. More...

virtual double	Derivative (IVector parameters, int which, int component)
	Calculates and returns the particular component of the vector function derivative. More...

virtual double	SecondDerivative (IVector parameters, int which, int rowNum, int columnNum)
	Calculates and returns the particular component of the vector function's second derivative (Hessian). More...

void	Value (IVector parameters, ref List< double > values)
	Returns the value of vector function at the specified parameter. More...

void	Derivative (IVector parameters, ref List< IVector > gradients)
	Returns the first derivative of this function at the specified parameter. More...

void	SecondDerivative (IVector parameters, ref List< IMatrix > hessians)
	Returns the second derivative (Hessian) of this function at the specified arameter. More...

double	LinearCombinationValue (IVectorFunctionResults evaluationData, IVector coefficients)
	Returns value of linear combination of functions contained in this vector function, with specified coefficients at specified parameters. More...

void	LinearCombinationDerivative (IVectorFunctionResults evaluationData, IVector coefficients, ref IVector res)
	Returns gradient of linear combination of functions contained in this vector function, with specified coefficients at specified parameters. More...

double	LinearCombinationDerivative (IVectorFunctionResults evaluationData, IVector coefficients, int component)
	Returns the specified component of gradient of combination of functions contained in this vector function, with specified coefficients at specified parameters. More...

void	LinearCombinationSecondDerivative (IVectorFunctionResults evaluationData, IVector coefficients, ref IMatrix res)

double	LinearCombinationSecondDerivative (IVectorFunctionResults evaluationData, IVector coefficients, int rowNum, int columnNum)
	Returns the specified component of Hessian of combination of functions contained in this vector function, with specified coefficients at specified parameters. More...

double	LinearCombinationValue (IVector parameters, IVector coefficients)
	Returns value of linear combination of functions contained in this vector function, with specified coefficients at specified parameters. More...

void	LinearCombinationDerivative (IVector parameters, IVector coefficients, ref IVector res)
	Returns gradient of linear combination of functions contained in this vector function, with specified coefficients at specified parameters. More...

double	LinearCombinationDerivative (IVector parameters, IVector coefficients, int component)
	Returns the specified component of gradient of combination of functions contained in this vector function, with specified coefficients at specified parameters. More...

void	LinearCombinationSecondDerivative (IVector parameters, IVector coefficients, ref IMatrix res)
	Calculates second derivatives of the linear combination of components of vector functions and stores them to the specified matrix. More...

double	LinearCombinationSecondDerivative (IVector parameters, IVector coefficients, int rowNum, int columnNum)
	Returns the specified component of Hessian of combination of functions contained in this vector function, with specified coefficients at specified parameters. More...

virtual void	NumericalDerivative (IVector x, IVector stepSize, ref List< IVector > derivative)
	Calculates numerical derivative of this function. Central difference formula is used. More...

virtual void	NumericalSecondDerivative (IVector x, IVector stepsizes, ref List< IVector > secondDerivatives)
	Calculates numerical second order derivative of this function. Central difference formula is used. More...

Static Public Member Functions
static int	NumLinearBasisFunctions (int dimension)
	Returns number of basis functions in linear polynomial basis of the specified dimenson. This is a helper method. More...

static void	Example ()
	Examples for this class. More...

Private Member Functions
	LinearBasis ()

Additional Inherited Members
Protected Attributes inherited from IG.Num.VectorFunctionBaseGeneral
object	_lock = new object()

string	_name

string	_description

int	_numParameters = -1

int	_numValues = -1

bool	_valuesDefined = true

bool	_derivativeDefined = false

bool	_secondDerivativeDefined = false

bool	_componentEvaluation = false

Properties inherited from IG.Num.VectorFunctionBaseComponentWise
override bool	ComponentWiseEvaluation `[get, protected set]`
	Returns true, indicating that individual components of functions and eventually their deirvatives is performed directly. More...

Properties inherited from IG.Num.VectorFunctionBaseGeneral
object	Lock `[get]`

virtual string	Name `[get, set]`
	Returns a short name of the function. More...

virtual string	Description `[get, set]`
	Returns a short description of the function. More...

virtual int	NumParameters `[get, protected set]`
	Gets number of parameters of the current vector function (-1 for not defined, in case that function works with different numbers of parameters). More...

virtual int	NumValues `[get, protected set]`
	Gets number of values of the current vector function (-1 for not defined, e.g. in case that function works with different numbers of parameters and number of functions depends on number of parameters). More...

virtual bool	ComponentWiseEvaluation `[get, protected set]`
	Tells whether the function supports evaluation of individual components. If not then evaluation is performed through the Evaluate function. More...

virtual bool	ValueDefined `[get, protected set]`
	Tells whether value of the function is defined by implementation. More...

virtual bool	DerivativeDefined `[get, protected set]`
	Tells whether the first derivative is defined for this function (by implementation, not mathematically) More...

virtual bool	SecondDerivativeDefined `[get, protected set]`
	Tells whether the second derivative is defined for this function (by implementation, not mathematically) More...

IVectorFunctionResults	AuxResults `[get]`

VectorFunctionBase.ObjectStoreResults	ResultsStore `[get]`
	Store of result objects for reuse. More...

Properties inherited from IG.Num.IVectorFunction
string	Name `[get]`
	Returns a short name of the function. More...

string	Description `[get]`
	Returns a short description of the function. More...

int	NumParameters `[get]`
	Gets number of parameters of the current vector function (-1 for not defined, in case that function works with different numbers of parameters). More...

int	NumValues `[get]`
	Gets number of values of the current vector function (-1 for not defined, e.g. in case that function works with different numbers of parameters and number of functions depends on number of parameters). More...

bool	ValueDefined `[get]`
	Tells whether value of the function is defined by implementation. More...

bool	DerivativeDefined `[get]`
	Tells whether the first derivative is defined for this function (by implementation, not mathematically) More...

bool	SecondDerivativeDefined `[get]`
	Tells whether the second derivative is defined for this function (by implementation, not mathematically) More...

bool	ComponentWiseEvaluation `[get]`
	Tells whether the function supports evaluation of individual components. If not then evaluation is performed through the Evaluate function. More...

Properties inherited from IG.Lib.ILockable
object	Lock `[get]`

Detailed Description

Vector function containing lineer basis in a n-dimensional vector space. Composed of n+1 functions: 1, x1, ..., xn.

$A Igor xx Apr10;

Constructor & Destructor Documentation

IG.Num.LinearBasis.LinearBasis ( )

inlineprivate

IG.Num.LinearBasis.LinearBasis ( int dimension )

inline

Constructs a vector function containing linear basis for the specified dimension. Composed of n+1 functions: 1, x1, ..., xn.

Parameters

dimension Space dimension.

Member Function Documentation

static int IG.Num.LinearBasis.NumLinearBasisFunctions ( int dimension )

inlinestatic

Returns number of basis functions in linear polynomial basis of the specified dimenson. This is a helper method.

Parameters

dimension Dimension of the space in which linear polynomial basis functions are calculated.

override double IG.Num.LinearBasis.Value	(	IVectorFunctionResults	evaluationData,
		int	which
	)

inlinevirtual

Calculates and returns the particular component of the vector function value.

Parameters

evaluationData	Evaluation data that contains function parameters and can store function resuts. If the function does not support component-wise evaluation then results will be stored to this structure and returned from it. This makes reuse possible - when different components are evaluated subsequently with the same parameters, results are calculated only for the first time.
which	Specifies which function to evaluate.

Implements IG.Num.VectorFunctionBaseComponentWise.

Reimplemented in IG.Num.LinearBasisSafer.

References IG.Num.IVectorFunctionResults.GetParameter().

override double IG.Num.LinearBasis.Derivative	(	IVectorFunctionResults	evaluationData,
		int	which,
		int	component
	)

inlinevirtual

Calculates and returns the particular component of the vector function's derivative.

Parameters

evaluationData	Evaluation data that contains function parameters and can store function resuts. Not used in this class, can be null.
which	Specifies which function to take.
component	Specifies which compoonent of the gradient should be returned.

Implements IG.Num.VectorFunctionBaseComponentWise.

Reimplemented in IG.Num.LinearBasisSafer.

override double IG.Num.LinearBasis.SecondDerivative	(	IVectorFunctionResults	evaluationData,
		int	which,
		int	rowNum,
		int	columnNum
	)

inlinevirtual

Calculates and returns the particular component of the vector function's second derivative (Hessian), which is always 0 in this case.

Parameters

evaluationData	Evaluation data that contains function parameters and can store function resuts. Not used in this class, can be null.
which	Specifies which function to take.
rowNum	Specifies which row of the Hessian (matrix of second derivatives) should be returned.
columnNum	Specifies which column of the Hessian (matrix of second derivatives) should be returned.

Implements IG.Num.VectorFunctionBaseComponentWise.

Reimplemented in IG.Num.LinearBasisSafer.

static void IG.Num.LinearBasis.Example ( )

inlinestatic

Examples for this class.

References IG.Num.IVectorFunction.Evaluate(), IG.Num.VectorFunctionResults.ReqGradients, IG.Num.VectorFunctionResults.ReqHessians, IG.Num.VectorFunctionResults.ReqValues, IG.Num.VectorFunctionResults.SetParametersReference(), and IG.Num.VectorFunctionResults.ToString().

Referenced by IG.Num.LinearBasisSafer.Example(), IG.Num.QuadraticBasis.Example(), and IG.Num.QuadraticBasisSafer.Example().

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

igbase/numeric/approximation/linear/ApproxBasis.cs

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation