ScalarStoppingCondition Class

Initializes a new instance. By default the Threshold is set to 0 and the TypeOfStoppingCondition is set to AnyThreshold.

Initializes a new instance as a copy of an existing instance.

Initializes a new instance.

Initializes a new instance.

Gets or sets the range a value should be cropped to if the value computed is a angle, or indicates that the value computed is not an angle. By default this is set to NotCircular.

Gets additional constraints on the stopping condition. The constraints allow you to add extra criteria to whether an event should be considered valid to stop on. See their help for more information.

Gets or sets if this StoppingCondition will be considered during propagation.

Gets or sets how close the function value must get to the threshold to be considered equal to. Note that even if there is unquestionably a threshold, if the event search can not converge to a value at or below this value, it will not satisfy the stopping condition and no event will be logged. This must be larger than machine precision of values near the threshold.

Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.

Gets or sets an optional name for this stopping condition.

Gets or sets 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 consider satisfied even if the search did not converge within the FunctionTolerance. This is by default.

Gets or sets a callback that is executed when this condition is satisfied.

Gets or sets the Scalar that will computed at every propagation step to form a function that will be sampled to determine if propagation should stop.

Gets or sets how many times the threshold must be met, or how many extrema must be found before stopping. If a StoppingConditionEvaluator finds a valid stop except for a constraint being unsatisfied, that will not count as a crossing.

Gets or sets the threshold to stop at. This value is ignored if the TypeOfStoppingCondition indicates to stop on an extrema. This ValueDefinitionT will be evaluated when the evaluator is initialized and that initial value will be used as the threshold for the actual root finding that the StoppablePropagator will search for.

Gets or sets the type of the event to stop on (extrema, threshold, ...).

Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).

Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).

Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).

Clones this object using the specified context.

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.

Creates a ValueDefinitionT of type Double. If the derived StoppingCondition defines its threshold to be of a different type than a double, it can use a ValueDefinitionT of that other type in its StoppingConditionEvaluator. However it is required that the threshold can be represented as a Double and this must return such a value. If the specified StoppingCondition threshold is just a ValueDefinitionT of type Double, that property can simply be returned here.

Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.

Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.

Gets a hash code representing the definition of this object.

Gets a StoppingConditionEvaluator for use in the NumericalPropagator.

Serves as the default hash function.

Gets the Type of the current instance.

Determines if this object has the same definition as another object.

Creates a shallow copy of the current Object.

Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.

Returns a string that represents the current object.

Validates that required properties are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing GetEvaluator(EvaluatorGroup), as well as validate their own properties.