Click or drag to resize

DoubleFunctionSampling Class

Species how sampling of a function of Double should be performed.
Inheritance Hierarchy

Namespace:  AGI.Foundation.NumericalMethods
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.1.418.0 (24.1.418.0)
public sealed class DoubleFunctionSampling : DefinitionalObject, 

The DoubleFunctionSampling type exposes the following members.

Public methodDoubleFunctionSampling
Initializes a new instance.
Public propertyDefaultStep
Gets or sets the default step that will be taken when sampling a function.
Public propertyExtremaCrossingUncertaintyFactor
Gets or sets a value determining how finely to explore an extremum with the potential to cross a threshold. This value is passed along to the property of the same name on the DoubleFunctionExplorer used to determine the satisfaction intervals of an AccessConstraint sampled by this sampler.
Public propertyIsFrozen
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.
(Inherited from DefinitionalObject.)
Public propertyMaximumStep
Gets or sets the largest step that will be taken when sampling a function.
Public propertyMinimumStep
Gets or sets the smallest step that will be taken when sampling a function.
Public propertyTolerance
Gets or sets the tolerance used for convergence in the independent variable. The default value is 0.005.
Public propertyTrendingStep
Gets or sets the size of a trending step that will be taken at the beginning and end of each interval of consideration.
Public propertyUseFunctionSamplingSuggestion
Gets or sets a value indicating whether the sampling suggestion from the constraint should be used. If , the constraint's suggestion is ignored and the DefaultStep is used.
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Public methodEnumerateDependencies
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.
(Inherited from DefinitionalObject.)
Public methodEquals(DoubleFunctionSampling)
Indicates whether another instance of this type is exactly equal to this instance.
Public methodEquals(Object)
Indicates whether another object is exactly equal to this instance.
(Overrides ObjectEquals(Object).)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetFunctionSampler
Creates a sampler that takes the DefaultStep.
Public methodGetFunctionSampler(FunctionDouble, Double)
Creates a sampler that takes a step suggested by a given function, or the DefaultStep if not step is suggested.
Public methodGetHashCode
Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides ObjectGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
See Also