NonlinearProgram.AddSymbolicConstraint Method

Definition

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

Overload List

AddSymbolicConstraint(Expression<Func<Vector<Double>, Double>>, ConstraintType, Double)	Adds a constraint that is defined by an expression to the nonlinear program.
AddSymbolicConstraint(Expression<Func<Vector<Double>, Double>>, Double, Double)	Adds a constraint that is defined by an expression to the nonlinear program.
AddSymbolicConstraint(String, Expression<Func<Vector<Double>, Double>>, ConstraintType, Double)	Adds a constraint that is defined by an expression to the nonlinear program.
AddSymbolicConstraint(String, Expression<Func<Vector<Double>, Double>>, Double, Double)	Adds a constraint that is defined by an expression to the nonlinear program.

AddSymbolicConstraint(Expression<Func<Vector<Double>, Double>>, ConstraintType, Double)

Adds a constraint that is defined by an expression to the nonlinear program.

public Constraint AddSymbolicConstraint(
	Expression<Func<Vector<double>, double>> constraintFunction,
	ConstraintType constraintType,
	double rightHandSide
)

Visual Basic

Public Function AddSymbolicConstraint ( 
	constraintFunction As Expression(Of Func(Of Vector(Of Double), Double)),
	constraintType As ConstraintType,
	rightHandSide As Double
) As Constraint

C++/CLI

public:
Constraint^ AddSymbolicConstraint(
	Expression<Func<Vector<double>^, double>^>^ constraintFunction, 
	ConstraintType constraintType, 
	double rightHandSide
)

member AddSymbolicConstraint : 
        constraintFunction : Expression<Func<Vector<float>, float>> * 
        constraintType : ConstraintType * 
        rightHandSide : float -> Constraint

Parameters

constraintFunction Expression<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

Constraint
The new Constraint.

Remarks

The type of the return value depends on the constraint. If the constraint is linear in the variables, a LinearConstraint is returned, and the bounds of the constraint may be adjusted to take into account constant terms in the expression. Otherwise, a NonlinearConstraint is returned.

AddSymbolicConstraint(Expression<Func<Vector<Double>, Double>>, Double, Double)

Adds a constraint that is defined by an expression to the nonlinear program.

public Constraint AddSymbolicConstraint(
	Expression<Func<Vector<double>, double>> constraintFunction,
	double lowerBound,
	double upperBound
)

Visual Basic

Public Function AddSymbolicConstraint ( 
	constraintFunction As Expression(Of Func(Of Vector(Of Double), Double)),
	lowerBound As Double,
	upperBound As Double
) As Constraint

C++/CLI

public:
Constraint^ AddSymbolicConstraint(
	Expression<Func<Vector<double>^, double>^>^ constraintFunction, 
	double lowerBound, 
	double upperBound
)

member AddSymbolicConstraint : 
        constraintFunction : Expression<Func<Vector<float>, float>> * 
        lowerBound : float * 
        upperBound : float -> Constraint

Parameters

constraintFunction Expression<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

Constraint
A NonlinearConstraint object that represents the new constraint.

Remarks

Exceptions

ArgumentNullException

constraintFunction is null.

AddSymbolicConstraint(String, Expression<Func<Vector<Double>, Double>>, ConstraintType, Double)

Adds a constraint that is defined by an expression to the nonlinear program.

public Constraint AddSymbolicConstraint(
	string? name,
	Expression<Func<Vector<double>, double>> constraintFunction,
	ConstraintType constraintType,
	double rightHandSide
)

Visual Basic

Public Function AddSymbolicConstraint ( 
	name As String,
	constraintFunction As Expression(Of Func(Of Vector(Of Double), Double)),
	constraintType As ConstraintType,
	rightHandSide As Double
) As Constraint

C++/CLI

public:
Constraint^ AddSymbolicConstraint(
	String^ name, 
	Expression<Func<Vector<double>^, double>^>^ constraintFunction, 
	ConstraintType constraintType, 
	double rightHandSide
)

member AddSymbolicConstraint : 
        name : string * 
        constraintFunction : Expression<Func<Vector<float>, float>> * 
        constraintType : ConstraintType * 
        rightHandSide : float -> Constraint

Parameters

name String: The name of the constraint.
constraintFunction Expression<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

Constraint
The new NonlinearConstraint.

Remarks

Exceptions

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

AddSymbolicConstraint(String, Expression<Func<Vector<Double>, Double>>, Double, Double)

Adds a constraint that is defined by an expression to the nonlinear program.

public Constraint AddSymbolicConstraint(
	string? name,
	Expression<Func<Vector<double>, double>> constraintFunction,
	double lowerBound,
	double upperBound
)

Visual Basic

Public Function AddSymbolicConstraint ( 
	name As String,
	constraintFunction As Expression(Of Func(Of Vector(Of Double), Double)),
	lowerBound As Double,
	upperBound As Double
) As Constraint

C++/CLI

public:
Constraint^ AddSymbolicConstraint(
	String^ name, 
	Expression<Func<Vector<double>^, double>^>^ constraintFunction, 
	double lowerBound, 
	double upperBound
)

member AddSymbolicConstraint : 
        name : string * 
        constraintFunction : Expression<Func<Vector<float>, float>> * 
        lowerBound : float * 
        upperBound : float -> Constraint

Parameters

name String: The name of the new constraint.
constraintFunction Expression<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

Constraint
A NonlinearConstraint object that represents the new constraint.

Remarks

Exceptions

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

NonlinearProgram.AddSymbolicConstraint Method

Definition

Overload List

AddSymbolicConstraint(Expression<Func<Vector<Double>, Double>>, ConstraintType, Double)

Parameters

Return Value

Remarks

AddSymbolicConstraint(Expression<Func<Vector<Double>, Double>>, Double, Double)

Parameters

Return Value

Remarks

Exceptions

AddSymbolicConstraint(String, Expression<Func<Vector<Double>, Double>>, ConstraintType, Double)

Parameters

Return Value

Remarks

Exceptions

AddSymbolicConstraint(String, Expression<Func<Vector<Double>, Double>>, Double, Double)

Parameters

Return Value

Remarks

Exceptions

See Also

Reference