OptimizerMultivariableFunction.EvaluateDerivative Method (Double[], Boolean, OptimizerMultivariableFunctionResults, ITrackCalculationProgress)

Evaluates the gradients of this function. The default implementation of this method will numerically compute the gradients. To do that, the value of the function at the variables will be computed. When using the default implementation, the PerturbationValues must be set.

Namespace: AGI.Foundation.NumericalMethods
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 25.1.421.0 (25.1.421.0)

Syntax

C++

Copy

public virtual OptimizerMultivariableFunctionDerivativeResults EvaluateDerivative(
	double[] variables,
	bool multithreaded,
	OptimizerMultivariableFunctionResults valueResults,
	ITrackCalculationProgress progressTracker
)

Public Overridable Function EvaluateDerivative ( 
	variables As Double(),
	multithreaded As Boolean,
	valueResults As OptimizerMultivariableFunctionResults,
	progressTracker As ITrackCalculationProgress
) As OptimizerMultivariableFunctionDerivativeResults

public:
virtual OptimizerMultivariableFunctionDerivativeResults^ EvaluateDerivative(
	array<double>^ variables, 
	bool multithreaded, 
	OptimizerMultivariableFunctionResults^ valueResults, 
	ITrackCalculationProgress^ progressTracker
)

abstract EvaluateDerivative : 
        variables : float[] * 
        multithreaded : bool * 
        valueResults : OptimizerMultivariableFunctionResults * 
        progressTracker : ITrackCalculationProgress -> OptimizerMultivariableFunctionDerivativeResults 
override EvaluateDerivative : 
        variables : float[] * 
        multithreaded : bool * 
        valueResults : OptimizerMultivariableFunctionResults * 
        progressTracker : ITrackCalculationProgress -> OptimizerMultivariableFunctionDerivativeResults

Parameters

variables: Type:System.Double[]
The values to compute the gradients at.
multithreaded: Type: System.Boolean
Should the evaluation be done using as many cores as possible.
valueResults: Type: AGI.Foundation.NumericalMethods.OptimizerMultivariableFunctionResults
The evaluated value of the function at the variables. If this is null then this function will be evaluated at the variables as part of the default evaluation of the gradients.
progressTracker: Type: AGI.Foundation.ITrackCalculationProgress
An optional progress tracker.

Return Value

Type: OptimizerMultivariableFunctionDerivativeResults
The gradients of the cost function, equality constraints, and inequality constraints.

Reference

OptimizerMultivariableFunction Class

EvaluateDerivative Overload

AGI.Foundation.NumericalMethods Namespace