Click or drag to resize

SegmentPropagatorInequalityConstraint Class

The base type for inequality constraints for use with the ParameterOptimizer. This is the definition of the evaluator.
Inheritance Hierarchy

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 SegmentPropagatorInequalityConstraint : DefinitionalObject

The SegmentPropagatorInequalityConstraint type exposes the following members.

Constructors
  NameDescription
Protected methodSegmentPropagatorInequalityConstraint

Initializes a new instance. The weight defaults to 1.0.

Before GetEvaluator(EvaluatorGroup) can be called, BoundValue and BoundType must be configured, and Settings must be configured with a valid Tolerance. Scaling defaults to NoScalingOnInequalityConstraint.

Protected methodSegmentPropagatorInequalityConstraint(SegmentPropagatorInequalityConstraint, CopyContext)
Initializes a new instance as a copy of an existing instance.
Protected methodSegmentPropagatorInequalityConstraint(InequalityBoundType, ValueDefinitionDouble, Double)

Initializes a new instance. The weight defaults to 1.0.

Scaling defaults to NoScalingOnConstraint.

Protected methodSegmentPropagatorInequalityConstraint(InequalityBoundType, Double, Double)

Initializes a new instance. The weight defaults to 1.0.

Scaling defaults to NoScalingOnConstraint.

Protected methodSegmentPropagatorInequalityConstraint(InequalityBoundType, Double, Double, InequalityConstraintScaling)
Initializes a new instance. The weight defaults to 1.0.
Protected methodSegmentPropagatorInequalityConstraint(InequalityBoundType, ValueDefinitionDouble, Double, InequalityConstraintScaling, Double)
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyBoundType
Gets or sets a value indicating whether the BoundValue represents a lower or an upper bound.
Public propertyBoundValue
Gets or sets the threshold that the evaluated value will be compared to when solving for a particular trajectory. This value must not vary in time; consider using a ParameterizedValueDefinitionT if you want to change this value at propagation time.
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 propertyName
Gets or sets an optional name to identify this constraint.
Public propertySettings
Gets or sets the settings for the ParameterOptimizer associated with this constraint.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(DefinitionalObject)
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).
(Overrides DefinitionalObjectCheckForSameDefinition(DefinitionalObject).)
Protected methodCheckForSameDefinition(SegmentPropagatorInequalityConstraint)
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).
Public methodClone
Clones this object using the specified context.
(Inherited from DefinitionalObject.)
Protected methodComputeCurrentDefinitionHashCode
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.
(Overrides DefinitionalObjectComputeCurrentDefinitionHashCode.)
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.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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 methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
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.
(Overrides DefinitionalObjectFreezeAggregatedObjects.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluator
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateProperties
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.
Top
See Also