Click or drag to resize

DoubleFunctionExplorer Properties

The DoubleFunctionExplorer type exposes the following members.

Properties
  NameDescription
Public propertyCrossingVariableTolerance
Gets or sets the tolerance with which to converge on Variable when finding a precise crossing of a threshold. By default, this property has the value 0.005.
Public propertyCurrentVariable
Gets the current Variable, which is the Variable of the most recent sample.
Public propertyCurrentVariableIsValid
Gets a value indicating whether CurrentVariable is valid. CurrentVariable is invalid before the explorer is stepped for the first time.
Public propertyDebuggingLogger
Gets or sets a logger to which debugging information will be written.
Public propertyExploreExtremaToFindCrossings
Gets or sets a value indicating whether extrema should be explored if exploring those extrema could lead to additional threshold crossings being identified. Consider three sample points where the middle sampled value is higher than the other two so that the three points form two line segments with opposite slope. This configuration indicates that a local maximum exists somewhere between the three points. If all three points are below a threshold, it's possible that the local maximum, if found, will lie above the threshold. When this property is , that extremum is explored until it is found precisely, or it is determined based on ExtremaCrossingUncertaintyFactor that the extremum is unlikely to cross any threshold values. Such an extrema is explored even if FindAllExtremaPrecisely is . By default, this property has the value .
Public propertyExtremaCrossingUncertaintyFactor
Gets or sets a value determining how finely to explore an extremum with the potential to cross a threshold. At each iteration exploring the extremum this factor is multiplied against that iteration's Error to determine the tolerance to compare against the difference between the current guess of the extrema and the closest applicable threshold value. This property is only used if FindAllExtremaPrecisely is set to and ExploreExtremaToFindCrossings is set to . By default, this property has the value PositiveInfinity which effectively causes a complete search of all extrema. If you do not desire to completely search all extrema with the potential to cross a threshold, set this to a value greater than 1.0.
Public propertyExtremumVariableTolerance
Gets or sets the tolerance with which to converge on Variable when precisely finding a local extremum. By default, this property has the value 0.005.
Public propertyFindAllCrossingsPrecisely
Gets or sets a value indicating whether all crossings should be found precisely. If this property is , precise crossings will only be found if FindPreciseCrossing is called during the ThresholdCrossingIndicated event. By default, this property has the value .
Public propertyFindAllExtremaPrecisely
Gets or sets a value indicating whether all extrema should be found precisely. If this property is , precise extrema will only be found if FindPreciseExtremum is called during the ThresholdCrossingIndicated event, or if ExploreExtremaToFindCrossings is and the indicated extrema might cross the threshold. By default, this property has the value .
Public propertyFunctions
Gets the collection of functions to be explored.
Public propertyPreviousPreviousVariable
Gets the Variable of the previous, previous sample.
Public propertyPreviousPreviousVariableIsValid
Gets a value indicating whether PreviousPreviousVariable is valid. PreviousPreviousVariable is invalid before the explorer is stepped for the third time.
Public propertyPreviousVariable
Gets the Variable of the previous sample.
Public propertyPreviousVariableIsValid
Gets a value indicating whether PreviousVariable is valid. PreviousVariable is invalid before the explorer is stepped for the second time.
Public propertyReportExtremaAtEndpoints
Gets or sets a value indicating whether extrema should be reported at the start and stop times given to Explore(Double, Double) when the function is not flat at those endpoints. By default, this property has the value .
Public propertySampleSuggestionCallback
Gets or sets the callback to use to determine the times at which to sample the Functions when the Explore(Double, Double) method is called.
Top
See Also