FunctionMath.GetDifferentiator Method

Creates a function of one variable that represents the numerical derivative of the specified function of one variable using forward differences.

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4

public static Func<double, double> GetDifferentiator(
	this Func<double, double> targetFunction,
	int derivativeOrder = 1,
	DifferencesDirection direction = DifferencesDirection.Central,
	int accuracyOrder = 2,
	bool adaptive = false,
	double xMin = -1.79769313486232E+308,
	double xMax = 1.79769313486232E+308,
	double noiseFactor = 10
)

Visual Basic

<ExtensionAttribute>
Public Shared Function GetDifferentiator ( 
	targetFunction As Func(Of Double, Double),
	Optional derivativeOrder As Integer = 1,
	Optional direction As DifferencesDirection = DifferencesDirection.Central,
	Optional accuracyOrder As Integer = 2,
	Optional adaptive As Boolean = false,
	Optional xMin As Double = -1.79769313486232E+308,
	Optional xMax As Double = 1.79769313486232E+308,
	Optional noiseFactor As Double = 10
) As Func(Of Double, Double)

C++/CLI

public:
[ExtensionAttribute]
static Func<double, double>^ GetDifferentiator(
	Func<double, double>^ targetFunction, 
	int derivativeOrder = 1, 
	DifferencesDirection direction = DifferencesDirection::Central, 
	int accuracyOrder = 2, 
	bool adaptive = false, 
	double xMin = -1.79769313486232E+308, 
	double xMax = 1.79769313486232E+308, 
	double noiseFactor = 10
)

[<ExtensionAttribute>]
static member GetDifferentiator : 
        targetFunction : Func<float, float> * 
        ?derivativeOrder : int * 
        ?direction : DifferencesDirection * 
        ?accuracyOrder : int * 
        ?adaptive : bool * 
        ?xMin : float * 
        ?xMax : float * 
        ?noiseFactor : float 
(* Defaults:
        let _derivativeOrder = defaultArg derivativeOrder 1
        let _direction = defaultArg direction DifferencesDirection.Central
        let _accuracyOrder = defaultArg accuracyOrder 2
        let _adaptive = defaultArg adaptive false
        let _xMin = defaultArg xMin -1.79769313486232E+308
        let _xMax = defaultArg xMax 1.79769313486232E+308
        let _noiseFactor = defaultArg noiseFactor 10
*)
-> Func<float, float>

Parameters

targetFunction Func<Double, Double>: A delegate that represents a function of one variable.
derivativeOrder Int32 (Optional): The order of the derivative to compute.
direction DifferencesDirection (Optional): Optional. The direction in which to compute the finite differences. The default is central differences.
accuracyOrder Int32 (Optional): Optional. The accuracy order of the finite difference method. The default is 2.
adaptive Boolean (Optional): Optional. If true, the step size is computed based on the function values around the points where the function's derivative is requested. If false (the default), a default step size is used.
xMin Double (Optional): Optional. The smallest value for which the function may be evaluated. The default is MinValue.
xMax Double (Optional): Optional. The largest value for which the function may be evaluated. The default is MaxValue.
noiseFactor Double (Optional): Optional. An estimate for the noise in the function values relative to the machine precision. The default is 10.

Return Value

Func<Double, Double>
A delegate that returns a numerical approximation to the derivative of order derivativeOrder of targetFunction at its argument.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Func<Double, Double>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

ArgumentNullException

targetFunction is null.

ArgumentOutOfRangeException

derivativeOrder is less than zero.

-or-

accuracyOrder is less than one.