FunctionMath.FindZero(Func<Vector<Double>, Vector<Double>, Vector<Double>>, Func<Vector<Double>, Matrix<Double>, Matrix<Double>>, Vector<Double>) Method

Finds a zero of a function starting from an initial guess.

Definition

Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

public static Vector<double> FindZero(
	this Func<Vector<double>, Vector<double>, Vector<double>> targetFunction,
	Func<Vector<double>, Matrix<double>, Matrix<double>> jacobianFunction,
	Vector<double> initialGuess
)

Visual Basic

<ExtensionAttribute>
Public Shared Function FindZero ( 
	targetFunction As Func(Of Vector(Of Double), Vector(Of Double), Vector(Of Double)),
	jacobianFunction As Func(Of Vector(Of Double), Matrix(Of Double), Matrix(Of Double)),
	initialGuess As Vector(Of Double)
) As Vector(Of Double)

C++/CLI

public:
[ExtensionAttribute]
static Vector<double>^ FindZero(
	Func<Vector<double>^, Vector<double>^, Vector<double>^>^ targetFunction, 
	Func<Vector<double>^, Matrix<double>^, Matrix<double>^>^ jacobianFunction, 
	Vector<double>^ initialGuess
)

[<ExtensionAttribute>]
static member FindZero : 
        targetFunction : Func<Vector<float>, Vector<float>, Vector<float>> * 
        jacobianFunction : Func<Vector<float>, Matrix<float>, Matrix<float>> * 
        initialGuess : Vector<float> -> Vector<float>

Parameters

targetFunction Func<Vector<Double>, Vector<Double>, Vector<Double>>: A delegate that represents a multivariate function that specifies the functions on the left-hand side of the equations.
jacobianFunction Func<Vector<Double>, Matrix<Double>, Matrix<Double>>: A delegate that represents a multivariate function that specifies the Jacobian function of targetFunction.
initialGuess Vector<Double>: An initial guess for ther zero.

Return Value

Vector<Double>
The best approximation to a zero of targetFunction.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Func<Vector<Double>, Vector<Double>, Vector<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).

Remarks

Use this method when you have very little information about the location of the zero.

Exceptions

ConvergenceException

The algorithm failed to converge to a solution.