FunctionMath.FindMaximum Method

Definition

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

Overload List

FindMaximum(Func<Vector<Double>, Double>, Vector<Double>)	Computes a maximum of the specified function.
FindMaximum(Func<Double, Double>, Double)	Computes a maximum of the specified function.
FindMaximum(Func<Vector<Double>, Double>, Func<Vector<Double>, Vector<Double>, Vector<Double>>, Vector<Double>)	Computes a maximum of the specified function.
FindMaximum(Func<Double, Double>, Double, Double)	Computes a maximum of the specified function.

FindMaximum(Func<Vector<Double>, Double>, Vector<Double>)

Computes a maximum of the specified function.

public static OptimizationSolutionReport FindMaximum(
	this Func<Vector<double>, double> objectiveFunction,
	Vector<double> initialGuess
)

Visual Basic

<ExtensionAttribute>
Public Shared Function FindMaximum ( 
	objectiveFunction As Func(Of Vector(Of Double), Double),
	initialGuess As Vector(Of Double)
) As OptimizationSolutionReport

C++/CLI

public:
[ExtensionAttribute]
static OptimizationSolutionReport^ FindMaximum(
	Func<Vector<double>^, double>^ objectiveFunction, 
	Vector<double>^ initialGuess
)

[<ExtensionAttribute>]
static member FindMaximum : 
        objectiveFunction : Func<Vector<float>, float> * 
        initialGuess : Vector<float> -> OptimizationSolutionReport

Parameters

objectiveFunction Func<Vector<Double>, Double>: A delegate that represents a function of one variable that specifies the objective function.
initialGuess Vector<Double>: The starting point for the iteration.

Return Value

OptimizationSolutionReport
A local maximum of objectiveFunction.

Usage Note

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

ConvergenceException

The algorithm failed to converge and ThrowExceptionOnFailure is set to true.

FindMaximum(Func<Double, Double>, Double)

Computes a maximum of the specified function.

public static SolutionReport<double, double> FindMaximum(
	this Func<double, double> objectiveFunction,
	double initialGuess
)

Visual Basic

<ExtensionAttribute>
Public Shared Function FindMaximum ( 
	objectiveFunction As Func(Of Double, Double),
	initialGuess As Double
) As SolutionReport(Of Double, Double)

C++/CLI

public:
[ExtensionAttribute]
static SolutionReport<double, double>^ FindMaximum(
	Func<double, double>^ objectiveFunction, 
	double initialGuess
)

[<ExtensionAttribute>]
static member FindMaximum : 
        objectiveFunction : Func<float, float> * 
        initialGuess : float -> SolutionReport<float, float>

Parameters

objectiveFunction Func<Double, Double>: A delegate that represents a function of one variable that specifies the objective function.
initialGuess Double: An initial guess for the maximum.

Return Value

SolutionReport<Double, Double>
A local maximum of objectiveFunction.

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

ConvergenceException

The algorithm failed to converge and ThrowExceptionOnFailure is set to true.

FindMaximum(Func<Vector<Double>, Double>, Func<Vector<Double>, Vector<Double>, Vector<Double>>, Vector<Double>)

Computes a maximum of the specified function.

public static OptimizationSolutionReport FindMaximum(
	this Func<Vector<double>, double> objectiveFunction,
	Func<Vector<double>, Vector<double>?, Vector<double>> gradientOfObjectiveFunction,
	Vector<double> initialGuess
)

Visual Basic

<ExtensionAttribute>
Public Shared Function FindMaximum ( 
	objectiveFunction As Func(Of Vector(Of Double), Double),
	gradientOfObjectiveFunction As Func(Of Vector(Of Double), Vector(Of Double), Vector(Of Double)),
	initialGuess As Vector(Of Double)
) As OptimizationSolutionReport

C++/CLI

public:
[ExtensionAttribute]
static OptimizationSolutionReport^ FindMaximum(
	Func<Vector<double>^, double>^ objectiveFunction, 
	Func<Vector<double>^, Vector<double>^, Vector<double>^>^ gradientOfObjectiveFunction, 
	Vector<double>^ initialGuess
)

[<ExtensionAttribute>]
static member FindMaximum : 
        objectiveFunction : Func<Vector<float>, float> * 
        gradientOfObjectiveFunction : Func<Vector<float>, Vector<float>, Vector<float>> * 
        initialGuess : Vector<float> -> OptimizationSolutionReport

Parameters

objectiveFunction Func<Vector<Double>, Double>: A delegate that represents a function of one variable that specifies the objective function.
gradientOfObjectiveFunction Func<Vector<Double>, Vector<Double>, Vector<Double>>: A delegate that represents a function that returns the gradient function of objectiveFunction in its second argument.
initialGuess Vector<Double>: An initial guess for the maximum.

Return Value

OptimizationSolutionReport
A local maximum of objectiveFunction.

Usage Note

Exceptions

ConvergenceException

The algorithm failed to converge and ThrowExceptionOnFailure is set to true.

FindMaximum(Func<Double, Double>, Double, Double)

Computes a maximum of the specified function.

public static SolutionReport<double, double> FindMaximum(
	this Func<double, double> objectiveFunction,
	double lowerBound,
	double upperBound
)

Visual Basic

<ExtensionAttribute>
Public Shared Function FindMaximum ( 
	objectiveFunction As Func(Of Double, Double),
	lowerBound As Double,
	upperBound As Double
) As SolutionReport(Of Double, Double)

C++/CLI

public:
[ExtensionAttribute]
static SolutionReport<double, double>^ FindMaximum(
	Func<double, double>^ objectiveFunction, 
	double lowerBound, 
	double upperBound
)

[<ExtensionAttribute>]
static member FindMaximum : 
        objectiveFunction : Func<float, float> * 
        lowerBound : float * 
        upperBound : float -> SolutionReport<float, float>

Parameters

objectiveFunction Func<Double, Double>: A delegate that represents a function of one variable that specifies the objective function.
lowerBound Double: The lower bound of the interval where a maximum is to be located.
upperBound Double: The upper bound of the interval where a maximum is to be located.

Return Value

SolutionReport<Double, Double>
A local maximum of objectiveFunction.

Usage Note

Exceptions

ConvergenceException

The algorithm failed to converge and ThrowExceptionOnFailure is set to true.

FunctionMath.FindMaximum Method

Definition

Overload List

FindMaximum(Func<Vector<Double>, Double>, Vector<Double>)

Parameters

Return Value

Usage Note

Exceptions

FindMaximum(Func<Double, Double>, Double)

Parameters

Return Value

Usage Note

Exceptions

FindMaximum(Func<Vector<Double>, Double>, Func<Vector<Double>, Vector<Double>, Vector<Double>>, Vector<Double>)

Parameters

Return Value

Usage Note

Exceptions

FindMaximum(Func<Double, Double>, Double, Double)

Parameters

Return Value

Usage Note

Exceptions

See Also

Reference