Click or drag to resize

StoppingConditionEvaluator Properties

The StoppingConditionEvaluator type exposes the following members.

Public propertyAngularSetting
Gets the indication that the value being computed is an angle and, if so, should that angle be between negative PI and PI, or if it should be between 0 and 2*PI.
Public propertyConstraints
Gets the constraints that must also be satisfied for this stopping condition to stop propagation. If a constraint prevents an event from stopping propagation, it will not increment the count that gets compared to the StopOnEventNumber.
Public propertyDiscontinuityTolerance
Gets the tolerance to use to detect discontinuities in the value computed by the stopping condition. If the difference between two function values is greater than this value, then it should be considered a discontinuity and not counted as an event. It is up to the function sampling the stopping condition value to use this to detect discontinuities. This is PositiveInfinity if the AngularSetting is NotCircular, or PI for the other CircularRange values.
Public propertyEnabled
Gets or sets if this evaluator should be used during propagation.
Public propertyFunctionTolerance
Gets how close the function value must get to the Threshold to be considered equal to.
Public propertyGroup
Gets the group that contains this evaluator.
Public propertyIdentifier
Gets the definition that created this StoppingConditionEvaluator. This is to be used only for identification of this StoppingConditionEvaluator and related items.
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
Public propertyName
Gets an optional name for this StoppingConditionEvaluator.
Public propertyRequireFunctionTolerance
Gets a value indicating whether the FunctionTolerance does not need to be satisfied. The search for an event will still attempt to converge to within the FunctionTolerance, but if it is known that an event is there (such as a threshold crossing), the event will be reported and this condition considered satisfied even if the search did not converge within the FunctionTolerance. This is by default.
Public propertySatisfiedCallback
Gets a delegate that is executed when this condition is satisfied. Edits to the state that gets sent in this delegate will be ignored unless the returned enumeration is that propagation should stop.
Public propertyStopOnEventNumber
Gets how many times an event should be found before stopping.
Protected propertyThreshold
Gets the threshold to stop at. This value is ignored if the TypeOfStoppingCondition is not one of the threshold types. When the StoppablePropagator that contains this condition is propagated, this ScalarEvaluator will be evaluated at that time and that value will be used as the threshold for the extent of the propagation.
Public propertyTypeOfStoppingCondition
Gets the type of the stop (local extrema, any threshold, ...)
Public propertyValueStatus
Gets which side the currently accepted value of the StoppingCondition is relative to the computed threshold. Note that this will not be updated during root finding. Other code can sample this value and make decisions based on if the threshold has been crossed or not without interfering with the root finding.
See Also