NonlinearProgram.AddNonlinearConstraint Method

Definition

Namespace: Numerics.NET.Optimization
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3

Overload List

AddNonlinearConstraint(Func<Vector<Double>, Double>, ConstraintType, Double)	Adds a nonlinear constraint to the nonlinear program.
AddNonlinearConstraint(Func<Vector<Double>, Double>, Double, Double)	Adds a nonlinear constraint to the nonlinear program.
AddNonlinearConstraint(Func<Vector<Double>, Double>, ConstraintType, Double, Func<Vector<Double>, Vector<Double>, Vector<Double>>)	Adds a nonlinear constraint to the nonlinear program.
AddNonlinearConstraint(Func<Vector<Double>, Double>, Double, Double, Func<Vector<Double>, Vector<Double>, Vector<Double>>)	Adds a nonlinear constraint to the nonlinear program.
AddNonlinearConstraint(String, Func<Vector<Double>, Double>, ConstraintType, Double)	Adds a nonlinear constraint to the nonlinear program.
AddNonlinearConstraint(String, Func<Vector<Double>, Double>, Double, Double)	Adds a nonlinear constraint to the nonlinear program.
AddNonlinearConstraint(String, Func<Vector<Double>, Double>, ConstraintType, Double, Func<Vector<Double>, Vector<Double>, Vector<Double>>)	Adds a nonlinear constraint to the nonlinear program.
AddNonlinearConstraint(String, Func<Vector<Double>, Double>, Double, Double, Func<Vector<Double>, Vector<Double>, Vector<Double>>)	Adds a nonlinear constraint to the nonlinear program.

AddNonlinearConstraint(Func<Vector<Double>, Double>, ConstraintType, Double)

Adds a nonlinear constraint to the nonlinear program.

public NonlinearConstraint AddNonlinearConstraint(
	Func<Vector<double>, double> constraintFunction,
	ConstraintType constraintType,
	double rightHandSide
)

Visual Basic

Public Function AddNonlinearConstraint ( 
	constraintFunction As Func(Of Vector(Of Double), Double),
	constraintType As ConstraintType,
	rightHandSide As Double
) As NonlinearConstraint

C++/CLI

public:
NonlinearConstraint^ AddNonlinearConstraint(
	Func<Vector<double>^, double>^ constraintFunction, 
	ConstraintType constraintType, 
	double rightHandSide
)

member AddNonlinearConstraint : 
        constraintFunction : Func<Vector<float>, float> * 
        constraintType : ConstraintType * 
        rightHandSide : float -> NonlinearConstraint

Parameters

constraintFunction Func<Vector<Double>, Double>: A delegate that represents the function that defines the constraint.
constraintType ConstraintType: A ConstraintType value that speicifies the type of constraint.
rightHandSide Double: The right-hand side of the constraint.

Return Value

NonlinearConstraint
The new NonlinearConstraint.

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

Adds a nonlinear constraint to the nonlinear program.

public NonlinearConstraint AddNonlinearConstraint(
	Func<Vector<double>, double> constraintFunction,
	double lowerBound,
	double upperBound
)

Visual Basic

Public Function AddNonlinearConstraint ( 
	constraintFunction As Func(Of Vector(Of Double), Double),
	lowerBound As Double,
	upperBound As Double
) As NonlinearConstraint

C++/CLI

public:
NonlinearConstraint^ AddNonlinearConstraint(
	Func<Vector<double>^, double>^ constraintFunction, 
	double lowerBound, 
	double upperBound
)

member AddNonlinearConstraint : 
        constraintFunction : Func<Vector<float>, float> * 
        lowerBound : float * 
        upperBound : float -> NonlinearConstraint

Parameters

constraintFunction Func<Vector<Double>, Double>: A delegate that represents the function that defines the constraint.
lowerBound Double: The lower bound of the constraint.
upperBound Double: The upper bound of the constraint.

Return Value

NonlinearConstraint
A NonlinearConstraint object that represents the new constraint.

Exceptions

ArgumentNullException

constraintFunction is null.

AddNonlinearConstraint(Func<Vector<Double>, Double>, ConstraintType, Double, Func<Vector<Double>, Vector<Double>, Vector<Double>>)

Adds a nonlinear constraint to the nonlinear program.

public NonlinearConstraint AddNonlinearConstraint(
	Func<Vector<double>, double> constraintFunction,
	ConstraintType constraintType,
	double rightHandSide,
	Func<Vector<double>, Vector<double>?, Vector<double>> constraintGradient
)

Visual Basic

Public Function AddNonlinearConstraint ( 
	constraintFunction As Func(Of Vector(Of Double), Double),
	constraintType As ConstraintType,
	rightHandSide As Double,
	constraintGradient As Func(Of Vector(Of Double), Vector(Of Double), Vector(Of Double))
) As NonlinearConstraint

C++/CLI

public:
NonlinearConstraint^ AddNonlinearConstraint(
	Func<Vector<double>^, double>^ constraintFunction, 
	ConstraintType constraintType, 
	double rightHandSide, 
	Func<Vector<double>^, Vector<double>^, Vector<double>^>^ constraintGradient
)

member AddNonlinearConstraint : 
        constraintFunction : Func<Vector<float>, float> * 
        constraintType : ConstraintType * 
        rightHandSide : float * 
        constraintGradient : Func<Vector<float>, Vector<float>, Vector<float>> -> NonlinearConstraint

Parameters

constraintFunction Func<Vector<Double>, Double>: A delegate that represents the function that defines the constraint.
constraintType ConstraintType: A ConstraintType value that speicifies the type of constraint.
rightHandSide Double: The right-hand side of the constraint.
constraintGradient Func<Vector<Double>, Vector<Double>, Vector<Double>>: A delegate that represents the gradient of constraintFunction.

Return Value

NonlinearConstraint
The new NonlinearConstraint.

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

Adds a nonlinear constraint to the nonlinear program.

public NonlinearConstraint AddNonlinearConstraint(
	Func<Vector<double>, double> constraintFunction,
	double lowerBound,
	double upperBound,
	Func<Vector<double>, Vector<double>?, Vector<double>> constraintGradient
)

Visual Basic

Public Function AddNonlinearConstraint ( 
	constraintFunction As Func(Of Vector(Of Double), Double),
	lowerBound As Double,
	upperBound As Double,
	constraintGradient As Func(Of Vector(Of Double), Vector(Of Double), Vector(Of Double))
) As NonlinearConstraint

C++/CLI

public:
NonlinearConstraint^ AddNonlinearConstraint(
	Func<Vector<double>^, double>^ constraintFunction, 
	double lowerBound, 
	double upperBound, 
	Func<Vector<double>^, Vector<double>^, Vector<double>^>^ constraintGradient
)

member AddNonlinearConstraint : 
        constraintFunction : Func<Vector<float>, float> * 
        lowerBound : float * 
        upperBound : float * 
        constraintGradient : Func<Vector<float>, Vector<float>, Vector<float>> -> NonlinearConstraint

Parameters

constraintFunction Func<Vector<Double>, Double>: A delegate that represents the function that defines the constraint.
lowerBound Double: The lower bound of the constraint.
upperBound Double: The upper bound of the constraint.
constraintGradient Func<Vector<Double>, Vector<Double>, Vector<Double>>: A delegate that represents the gradient of the constraint function.

Return Value

NonlinearConstraint
A NonlinearConstraint object that represents the new constraint.

Exceptions

ArgumentNullException

constraintFunction is null.

AddNonlinearConstraint(String, Func<Vector<Double>, Double>, ConstraintType, Double)

Adds a nonlinear constraint to the nonlinear program.

public NonlinearConstraint AddNonlinearConstraint(
	string? name,
	Func<Vector<double>, double> constraintFunction,
	ConstraintType constraintType,
	double rightHandSide
)

Visual Basic

Public Function AddNonlinearConstraint ( 
	name As String,
	constraintFunction As Func(Of Vector(Of Double), Double),
	constraintType As ConstraintType,
	rightHandSide As Double
) As NonlinearConstraint

C++/CLI

public:
NonlinearConstraint^ AddNonlinearConstraint(
	String^ name, 
	Func<Vector<double>^, double>^ constraintFunction, 
	ConstraintType constraintType, 
	double rightHandSide
)

member AddNonlinearConstraint : 
        name : string * 
        constraintFunction : Func<Vector<float>, float> * 
        constraintType : ConstraintType * 
        rightHandSide : float -> NonlinearConstraint

Parameters

name String: The name of the constraint.
constraintFunction Func<Vector<Double>, Double>: A delegate that represents the function that defines the constraint.
constraintType ConstraintType: A ConstraintType value that speicifies the type of constraint.
rightHandSide Double: The right-hand side of the constraint.

Return Value

NonlinearConstraint
The new NonlinearConstraint.

Exceptions

ArgumentException	The nonlinear program already contains a constraint named name.
ArgumentNullException	constraintFunction is null.

AddNonlinearConstraint(String, Func<Vector<Double>, Double>, Double, Double)

Adds a nonlinear constraint to the nonlinear program.

public NonlinearConstraint AddNonlinearConstraint(
	string? name,
	Func<Vector<double>, double> constraintFunction,
	double lowerBound,
	double upperBound
)

Visual Basic

Public Function AddNonlinearConstraint ( 
	name As String,
	constraintFunction As Func(Of Vector(Of Double), Double),
	lowerBound As Double,
	upperBound As Double
) As NonlinearConstraint

C++/CLI

public:
NonlinearConstraint^ AddNonlinearConstraint(
	String^ name, 
	Func<Vector<double>^, double>^ constraintFunction, 
	double lowerBound, 
	double upperBound
)

member AddNonlinearConstraint : 
        name : string * 
        constraintFunction : Func<Vector<float>, float> * 
        lowerBound : float * 
        upperBound : float -> NonlinearConstraint

Parameters

name String: The name of the new constraint.
constraintFunction Func<Vector<Double>, Double>: A delegate that represents the function that defines the constraint.
lowerBound Double: The lower bound of the constraint.
upperBound Double: The upper bound of the constraint.

Return Value

NonlinearConstraint
A NonlinearConstraint object that represents the new constraint.

Exceptions

ArgumentException	The nonlinear program already contains a constraint named name.
ArgumentNullException	constraintFunction is null.

AddNonlinearConstraint(String, Func<Vector<Double>, Double>, ConstraintType, Double, Func<Vector<Double>, Vector<Double>, Vector<Double>>)

Adds a nonlinear constraint to the nonlinear program.

public NonlinearConstraint AddNonlinearConstraint(
	string? name,
	Func<Vector<double>, double> constraintFunction,
	ConstraintType constraintType,
	double rightHandSide,
	Func<Vector<double>, Vector<double>?, Vector<double>>? constraintGradient
)

Visual Basic

Public Function AddNonlinearConstraint ( 
	name As String,
	constraintFunction As Func(Of Vector(Of Double), Double),
	constraintType As ConstraintType,
	rightHandSide As Double,
	constraintGradient As Func(Of Vector(Of Double), Vector(Of Double), Vector(Of Double))
) As NonlinearConstraint

C++/CLI

public:
NonlinearConstraint^ AddNonlinearConstraint(
	String^ name, 
	Func<Vector<double>^, double>^ constraintFunction, 
	ConstraintType constraintType, 
	double rightHandSide, 
	Func<Vector<double>^, Vector<double>^, Vector<double>^>^ constraintGradient
)

member AddNonlinearConstraint : 
        name : string * 
        constraintFunction : Func<Vector<float>, float> * 
        constraintType : ConstraintType * 
        rightHandSide : float * 
        constraintGradient : Func<Vector<float>, Vector<float>, Vector<float>> -> NonlinearConstraint

Parameters

name String: The name of the constraint.
constraintFunction Func<Vector<Double>, Double>: A delegate that represents the function that defines the constraint.
constraintType ConstraintType: A ConstraintType value that speicifies the type of constraint.
rightHandSide Double: The right-hand side of the constraint.
constraintGradient Func<Vector<Double>, Vector<Double>, Vector<Double>>: A delegate that represents the gradient of the constraint function.

Return Value

NonlinearConstraint
The new NonlinearConstraint.

Exceptions

ArgumentException	The nonlinear program already contains a constraint named name.
ArgumentNullException	constraintFunction is null.

AddNonlinearConstraint(String, Func<Vector<Double>, Double>, Double, Double, Func<Vector<Double>, Vector<Double>, Vector<Double>>)

Adds a nonlinear constraint to the nonlinear program.

public NonlinearConstraint AddNonlinearConstraint(
	string? name,
	Func<Vector<double>, double> constraintFunction,
	double lowerBound,
	double upperBound,
	Func<Vector<double>, Vector<double>?, Vector<double>>? constraintGradient
)

Visual Basic

Public Function AddNonlinearConstraint ( 
	name As String,
	constraintFunction As Func(Of Vector(Of Double), Double),
	lowerBound As Double,
	upperBound As Double,
	constraintGradient As Func(Of Vector(Of Double), Vector(Of Double), Vector(Of Double))
) As NonlinearConstraint

C++/CLI

public:
NonlinearConstraint^ AddNonlinearConstraint(
	String^ name, 
	Func<Vector<double>^, double>^ constraintFunction, 
	double lowerBound, 
	double upperBound, 
	Func<Vector<double>^, Vector<double>^, Vector<double>^>^ constraintGradient
)

member AddNonlinearConstraint : 
        name : string * 
        constraintFunction : Func<Vector<float>, float> * 
        lowerBound : float * 
        upperBound : float * 
        constraintGradient : Func<Vector<float>, Vector<float>, Vector<float>> -> NonlinearConstraint

Parameters

name String: The name of the new constraint.
constraintFunction Func<Vector<Double>, Double>: A delegate that represents the function that defines the constraint.
lowerBound Double: The lower bound of the constraint.
upperBound Double: The upper bound of the constraint.
constraintGradient Func<Vector<Double>, Vector<Double>, Vector<Double>>: A delegate that represents the gradient of the constraint function.

Return Value

NonlinearConstraint
A NonlinearConstraint object that represents the new constraint.

Exceptions

ArgumentException	The nonlinear program already contains a constraint named name.
ArgumentNullException	constraintFunction is null.

NonlinearProgram.AddNonlinearConstraint Method

Definition

Overload List

AddNonlinearConstraint(Func<Vector<Double>, Double>, ConstraintType, Double)

Parameters

Return Value

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

Parameters

Return Value

Exceptions

AddNonlinearConstraint(Func<Vector<Double>, Double>, ConstraintType, Double, Func<Vector<Double>, Vector<Double>, Vector<Double>>)

Parameters

Return Value

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

Parameters

Return Value

Exceptions

AddNonlinearConstraint(String, Func<Vector<Double>, Double>, ConstraintType, Double)

Parameters

Return Value

Exceptions

AddNonlinearConstraint(String, Func<Vector<Double>, Double>, Double, Double)

Parameters

Return Value

Exceptions

AddNonlinearConstraint(String, Func<Vector<Double>, Double>, ConstraintType, Double, Func<Vector<Double>, Vector<Double>, Vector<Double>>)

Parameters

Return Value

Exceptions

AddNonlinearConstraint(String, Func<Vector<Double>, Double>, Double, Double, Func<Vector<Double>, Vector<Double>, Vector<Double>>)

Parameters

Return Value

Exceptions

See Also

Reference