Click or drag to resize

NonlinearConstraint Class

Class NonlinearConstraint represents a nonlinear constraint in an optimization problem.
Inheritance Hierarchy
SystemObject
  CenterSpace.NMath.CoreConstraint
    CenterSpace.NMath.CoreNonlinearConstraint

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.3
Syntax
[SerializableAttribute]
public class NonlinearConstraint : Constraint

The NonlinearConstraint type exposes the following members.

Constructors
  NameDescription
Public methodNonlinearConstraint
Creates an empty NonlinearConstraint object.
Public methodNonlinearConstraint(NonlinearConstraint)
Creates a copy of a given NonlinearConstraint object.
Public methodNonlinearConstraint(DoubleFunctional, ConstraintType)
Creates a NonlinearConstraint object with the given constraint function and constraint type.
Public methodNonlinearConstraint(Int32, FuncDoubleVector, Double, ConstraintType)
Creates a NonlinearConstraint object with the given constraint function, constraint function domain dimension, and constraint type.
Public methodNonlinearConstraint(DoubleFunctional, ConstraintType, Double)
Creates a NonlinearConstraint object with the given constraint function, constraint type, and tolerance for determining constraint compliance.
Top
Properties
  NameDescription
Public propertyTolerance
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.)
Public propertyType
Gets and sets the type of the constraint, either equality or inequality.
(Inherited from Constraint.)
Top
Methods
  NameDescription
Public methodClone
Returns a deep copy of self.
(Overrides ConstraintClone.)
Public methodEvaluateConstraintFunction(Double)
Evaluates the constraint function at the given point.
(Inherited from Constraint.)
Public methodEvaluateConstraintFunction(DoubleVector)
Evaluates the constraint function at the given point.
(Overrides ConstraintEvaluateConstraintFunction(DoubleVector).)
Public methodGradient(DoubleVector)
Evaluates the gradient of the constraint function and returns this value.
(Inherited from Constraint.)
Public methodGradient(DoubleVector, DoubleVector)
Evaluates the gradient of the constraint function and places in the given vector.
(Overrides ConstraintGradient(DoubleVector, DoubleVector).)
Public methodIsSatisfied(DoubleVector)
Determines if the constraint represented by this instance is satisfied at the given point.
(Inherited from Constraint.)
Public methodIsSatisfied(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.)
Top
Fields
  NameDescription
Protected fieldconstraintType_
The constraint type.
(Inherited from Constraint.)
Top
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