NumLib.FunctionWithGradient Class Reference

Base class for implementation of various functions with gradients. More...

Inheritance diagram for NumLib.FunctionWithGradient:

Public Member Functions
abstract double	Value (double[] parameters)
	Returns function value at the specified parameters. More...
abstract double[]	Gradient (double[] parameters)
	Returns function value at the specified parameters. More...

Static Public Member Functions
static double	Norm (double[] x)
	Calculates and returns Euclidean norm of the specified vector. More...
static string	ArrayToString (double[] x)

Properties
abstract string	Description [get]

Detailed Description

Base class for implementation of various functions with gradients.

Member Function Documentation

abstract double NumLib.FunctionWithGradient.Value ( double[]  parameters )

pure virtual

Returns function value at the specified parameters.

Parameters

parameters

Parameters where function is evaluated.

Implemented in NumLib.RosenbrockFunction.

Referenced by NumLib.MinimizerLbfgs.Minimize(), NumLib.MinimizerLbfgs.NextIteration(), and NumLib.ExampleAlgLib2008.OptimizeQuadratic().

abstract double [] NumLib.FunctionWithGradient.Gradient ( double[]  parameters )

pure virtual

Returns function value at the specified parameters.

Parameters

parameters

Parameters where function is evaluated.

Implemented in NumLib.RosenbrockFunction.

Referenced by NumLib.MinimizerLbfgs.Minimize(), NumLib.MinimizerLbfgs.NextIteration(), and NumLib.ExampleAlgLib2008.OptimizeQuadratic().

static double NumLib.FunctionWithGradient.Norm ( double[]  x )

inlinestatic

Calculates and returns Euclidean norm of the specified vector.

Parameters

x	Array of elements of the vector for which norm is calculated.

Returns

Referenced by NumLib.MinimizerLbfgs.Minimize(), NumLib.MinimizerLbfgs.NextIteration(), NumLib.ExampleAlgLib2008.OptimizeQuadratic(), and NumLib.ExampleAlgLib2008.OptimizeRosenbrock().

static string NumLib.FunctionWithGradient.ArrayToString ( double[]  x )

inlinestatic

Referenced by NumLib.MinimizerLbfgs.Minimize(), NumLib.MinimizerLbfgs.NextIteration(), and NumLib.ExampleAlgLib2008.OptimizeQuadratic().

Property Documentation

abstract string NumLib.FunctionWithGradient.Description

get

Referenced by NumLib.MinimizerLbfgs.Minimize(), and NumLib.ExampleAlgLib2008.OptimizeQuadratic().

---

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

• igtest/IGLibTestDev/opt/alglib/Alglib_Old_UniMb/0Functions.cs