DoubleFunctionSampling Class

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

Inheritance Hierarchy

SystemObject
AGI.Foundation.InfrastructureDefinitionalObject
AGI.Foundation.NumericalMethodsDoubleFunctionSampling

Namespace: AGI.Foundation.NumericalMethods
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public sealed class DoubleFunctionSampling : DefinitionalObject, 
	IEquatable<DoubleFunctionSampling>

Public NotInheritable Class DoubleFunctionSampling
	Inherits DefinitionalObject
	Implements IEquatable(Of DoubleFunctionSampling)

public ref class DoubleFunctionSampling sealed : public DefinitionalObject, 
	IEquatable<DoubleFunctionSampling^>

[<SealedAttribute>]
type DoubleFunctionSampling =  
    class
        inherit DefinitionalObject
        interface IEquatable<DoubleFunctionSampling>
    end

The DoubleFunctionSampling type exposes the following members.

Constructors

	Name	Description
	DoubleFunctionSampling	Initializes a new instance.

Top

Properties

	Name	Description
	DefaultStep	Gets or sets the default step that will be taken when sampling a function.
	ExtremaCrossingUncertaintyFactor	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.
	IsFrozen	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.)
	MaximumStep	Gets or sets the largest step that will be taken when sampling a function.
	MinimumStep	Gets or sets the smallest step that will be taken when sampling a function.
	Tolerance	Gets or sets the tolerance used for convergence in the independent variable. The default value is 0.005.
	TrendingStep	Gets or sets the size of a trending step that will be taken at the beginning and end of each interval of consideration.
	UseFunctionSamplingSuggestion	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.

Top

Methods

	Name	Description
	Clone	Clones this object using the specified context. (Overrides DefinitionalObjectClone(CopyContext).)
	EnumerateDependencies	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.)
	Equals(DoubleFunctionSampling)	Indicates whether another instance of this type is exactly equal to this instance.
	Equals(Object)	Indicates whether another object is exactly equal to this instance. (Overrides ObjectEquals(Object).)
	Freeze	Freezes this object. Further attempts to modify it will result in an ObjectFrozenException. (Inherited from DefinitionalObject.)
	GetDefinitionHashCode	Gets a hash code representing the definition of this object. (Inherited from DefinitionalObject.)
	GetFunctionSampler	Creates a sampler that takes the DefaultStep.
	GetFunctionSampler(FunctionDouble, Double)	Creates a sampler that takes a step suggested by a given function, or the DefaultStep if not step is suggested.
	GetHashCode	Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsSameDefinition	Determines if this object has the same definition as another object. (Inherited from DefinitionalObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

AGI.Foundation.NumericalMethods Namespace