Click or drag to resize

SegmentPropagatorCostFunctionEvaluator Class

The evaluator for SegmentPropagatorCostFunction used in a ParameterOptimizer. Instances of this type return some value computed from the SegmentListResults of all the results of propagation up to the end of the final segment in the SegmentListPropagator that has the ParameterOptimizer that has this cost function.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.NumericalMethodsSegmentPropagatorCostFunctionEvaluator

Namespace:  AGI.Foundation.NumericalMethods
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
public abstract class SegmentPropagatorCostFunctionEvaluator : IEvaluator, 
	IAvailability, IThreadAware, ICloneWithContext, IDisposable

The SegmentPropagatorCostFunctionEvaluator type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyGroup
Gets the group that contains this evaluator.
Public propertyIdentifier
Gets the identifier for this evaluator. It is highly discouraged to use this for anything other than identification purposes.
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
Public propertyName
Gets the optional name of this cost function evaluator.
Top
Methods
  NameDescription
Public methodClone
Clones this object using the specified context.
Public methodCreateSettings
Creates the CostFunctionSettings for use with a ParameterOptimizer.
Public methodDispose
Releases any resources associated with this instance.
Protected methodDispose(Boolean)
Releases any resources associated with this instance.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluate
Extracts or computes a value from the results for the entire propagation up through the final segment in the parent SegmentList.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAvailabilityIntervals
Gets the intervals over which data is available.
Public methodGetCachingWrapper
Gets a version of this evaluator that caches the previously computed value so that if it is evaluated twice at the same date the computation is done only once.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsAvailable
Determines if valid data is available for the given JulianDate.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodCode exampleUpdateEvaluatorReferences
Updates the evaluator references held by this object using the reference-to-reference mapping in the specified CopyContext.
Top
Remarks
Be aware that concrete types of this can pull results from any or all of the SegmentListResults passed into it; this base type does not limit you to just obtaining results from a single SegmentPropagator. If your concrete type is meant to work with SegmentResults from a single segment, your constraint evaluator should store a reference to the SegmentDefinition and call GetResultsOfSegment(SegmentDefinition).
See Also