 | Nonlinear |
Class NonlinearConstraint represents a nonlinear constraint in an optimization problem.
Inheritance HierarchyNamespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4
SyntaxThe NonlinearConstraint type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | NonlinearConstraint | Creates an empty NonlinearConstraint object. |
| NonlinearConstraint(NonlinearConstraint) | Creates a copy of a given NonlinearConstraint object. |
| NonlinearConstraint(DoubleFunctional, ConstraintType) | Creates a NonlinearConstraint object with the given constraint function and constraint type. |
| NonlinearConstraint(DoubleFunctional, ConstraintType, Double) | Creates a NonlinearConstraint object with the given constraint function, constraint type, and tolerance for determining constraint compliance. |
| NonlinearConstraint(Int32, FuncDoubleVector, Double, ConstraintType) | Creates a NonlinearConstraint object with the given constraint function, constraint function domain dimension, and constraint type. |
Properties| Name | Description | |
|---|---|---|
 | Tolerance |
Gets and sets the tolerance for determining whether or not this
constraint is satisfied at a particular point. For
example the equality constraint
c(x) = 0 will be considered to be satisfied at a point x0
if |c(x0)| < Tolerance, and a inequality constraint
c(x) >= 0 will be considered to be satisfied at a point x0
if c(x0) >= -tolerance_.
(Inherited from Constraint) |
| Type |
Gets and sets the type of the constraint, either equality or inequality.
(Inherited from Constraint) |
Methods| Name | Description | |
|---|---|---|
| Clone |
Returns a deep copy of self.
(Overrides ConstraintClone) |
| EvaluateConstraintFunction(Double) |
Evaluates the constraint function at the
given point.
(Inherited from Constraint) |
| EvaluateConstraintFunction(DoubleVector) |
Evaluates the constraint function at the
given point.
(Overrides ConstraintEvaluateConstraintFunction(DoubleVector)) |
| Gradient(DoubleVector) |
Evaluates the gradient of the constraint function and returns this value.
(Inherited from Constraint) |
| Gradient(DoubleVector, DoubleVector) |
Evaluates the gradient of the constraint function and places in the
given vector.
(Overrides ConstraintGradient(DoubleVector, DoubleVector)) |
| IsSatisfied(DoubleVector) |
Determines if the constraint represented by this instance is
satisfied at the given point.
(Inherited from Constraint) |
| IsSatisfied(DoubleVector, Double) |
Determines if the constraint represented by this instance is
satisfied at the given point withing the given tolerance. The
tolerance associated with this object, accessed with the
Tolerance property, is ignored.
(Inherited from Constraint) |
Fields| Name | Description | |
|---|---|---|
 | constraintType_ |
The constraint type.
(Inherited from Constraint) |
Remarks
In this context a nonlinear is of the form
c(x) <= 0, (inequality constraint), or
c(x) = 0, (equality constraint).
where c(x) is a real-valued, smooth function of the vector variable
x.
See Also