Constraint Class |
The Constraint type exposes the following members.
Name | Description | |
---|---|---|
Constraint | Constructs an empty constraint object. Behavior of the constructed object is undefined. | |
Constraint(Constraint) | Creates a copy of the given other constraint object. | |
Constraint(ConstraintType) | Constructs a constraint object with the given constraint type. | |
Constraint(ConstraintType, Double) | Constructs a constraint object with the given constraint type and tolerance. |
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_. | |
Type | Gets and sets the type of the constraint, either equality or inequality. |
Name | Description | |
---|---|---|
Clone | Returns a copy of self. | |
EvaluateConstraintFunction(Double) | Evaluates the constraint function at the given point. | |
EvaluateConstraintFunction(DoubleVector) | Evaluates the constraint function at the given point. | |
Gradient(DoubleVector) | Evaluates the gradient of the constraint function and returns this value. | |
Gradient(DoubleVector, DoubleVector) | Evaluates the gradient of the constraint function and places in the given vector. | |
IsSatisfied(DoubleVector) | Determines if the constraint represented by this instance is satisfied at the given point. | |
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. |
Name | Description | |
---|---|---|
constraintType_ | The constraint type. | |
DEFAULT_TOLERANCE | Default value for the tolerance used when determining whether or not a constraint is satified. This tolerance value will be used if no tolerance value is supplied when constructing a Constraint object, or set via the Tolerance property. |