LagrangianFunctionLagrangianGradientFunction Class

Class LagrangianGradientFunction derives from DoubleMultiVariableFunction for evaluating the gradient of the Lagrangian functions.

Inheritance Hierarchy

SystemObject
CenterSpace.NMath.CoreDoubleMultiVariableFunction
CenterSpace.NMath.CoreLagrangianFunctionLagrangianGradientFunction

Namespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4

Syntax

public class LagrangianGradientFunction : DoubleMultiVariableFunction

Public Class LagrangianGradientFunction
	Inherits DoubleMultiVariableFunction

public ref class LagrangianGradientFunction : public DoubleMultiVariableFunction

type LagrangianGradientFunction = 
    class
        inherit DoubleMultiVariableFunction
    end

The LagrangianFunctionLagrangianGradientFunction type exposes the following members.

Constructors

	Name	Description
	LagrangianFunctionLagrangianGradientFunction	Constructs a LagrangianGradientFunction object from the given deletate.

Properties

	Name	Description
	CentralDifferenceDelta	Sets the delta for using the central difference method for approximating the Jacobian. The Jacobian will be approximated only if the deriving class does not override the Jacobian method. (Inherited from DoubleMultiVariableFunction)
	XDimension	Gets and sets the dimension of the function domain. (Inherited from DoubleMultiVariableFunction)
	YDimension	Gets and sets the dimension of the function range. (Inherited from DoubleMultiVariableFunction)

Methods

	Name	Description
	Clone	ICloneable method. Not implemented here. Deriving classes must implement if desired. (Inherited from DoubleMultiVariableFunction)
	Evaluate(Double)	Evaluate the function at the point x. (Inherited from DoubleMultiVariableFunction)
	Evaluate(DoubleMatrix, DoubleMatrix)	Evaluate the function at the points X and place the results in Y. (Inherited from DoubleMultiVariableFunction)
	Evaluate(DoubleVector, DoubleVector)	Evaluates the Lagrangian gradient at a point x, placing the results in the vector y. (Overrides DoubleMultiVariableFunctionEvaluate(DoubleVector, DoubleVector))
	Jacobian(Double)	Evaluates the Jacobian of the function at the given point. (Inherited from DoubleMultiVariableFunction)
	Jacobian(DoubleVector, DoubleMatrix)	Virtual method for evaluating the Jacobian of the function at the given point. (Inherited from DoubleMultiVariableFunction)

Fields

	Name	Description
	centralDifferenceDelta_	Sets the delta for using the central difference method for approximating the Jacobian. The Jacobian will be approximated only if the deriving class does not override the Jacobian method. (Inherited from DoubleMultiVariableFunction)
	xDimension_	Dimension of the function domain. (Inherited from DoubleMultiVariableFunction)
	yDimension_	Dimension of the function range. (Inherited from DoubleMultiVariableFunction)