Nonlinear Constraint Class
Definition
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
public class NonlinearConstraint : Constraint
- Inheritance
- Object → OptimizationModelEntity → Constraint → NonlinearConstraint
Remarks
A NonlinearConstraint object represents a constraint in a NonlinearProgram. NonlinearConstraint objects are created using the [o:NonlinearProgram.AddNonlinearConstraint] method of the NonlinearProgram class.
Each constraint has a Name, which may be generated automatically. The LowerBound and UpperBound properties specify the left and right hand sides of the constraint. The ConstraintFunction property specifies the function whose value must lie between those bounds.
The FastConstraintGradient property specifies the gradient of the constraint function. If this value is null, a numerical approximation is used.
Properties
Constraint | Gets or sets the constraint function. |
Constraint | Gets or sets a delegate that evaluates the constraint value and its gradient. |
Constraint |
Gets the type of row.
(Inherited from Constraint) |
Fast | Gets or sets the gradient of the constraint function. |
Gradient |
Gets the current value of the constraint gradient.
(Inherited from Constraint) |
IsLinear |
Gets whether the constraint is linear.
(Overrides Constraint.IsLinear) |
Lower |
Gets or sets the lower bound of the variable.
(Inherited from OptimizationModelEntity) |
Name |
Gets the name of the variable.
(Inherited from OptimizationModelEntity) |
Position |
Gets the position of the current instance in the collection.
(Inherited from OptimizationModelEntity) |
Upper |
Gets or sets the upper bound of the variable.
(Inherited from OptimizationModelEntity) |
Value |
Gets the current value of the constraint.
(Inherited from Constraint) |
Methods
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
Evaluate |
Evaluates the constraint at the specified point.
(Overrides Constraint.Evaluate(Vector<Double>)) |
Evaluate |
Evaluates both the constrain value and its gradient in one operation.
(Overrides Constraint.EvaluateConstraintAndGradient(Vector<Double>)) |
Evaluate |
Evaluates the gradient of the constraint at the specified point.
(Overrides Constraint.EvaluateGradient(Vector<Double>)) |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
Get | Serves as the default hash function. (Inherited from Object) |
Get | Gets the Type of the current instance. (Inherited from Object) |
Memberwise | Creates a shallow copy of the current Object. (Inherited from Object) |
ToString | Returns a string that represents the current object. (Inherited from Object) |