agi.foundation.numericalmethods

(agi.foundation.segmentpropagation-2024r1.jar)

Class ScalarAtEndOfSegmentConstraint

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.numericalmethods.SegmentPropagatorConstraint

agi.foundation.numericalmethods.ScalarAtEndOfSegmentConstraint

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class ScalarAtEndOfSegmentConstraint
extends SegmentPropagatorConstraint

This constraint will take the initial or final value from a SegmentResults and evaluate a Scalar (get / set) at that time with that information.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScalarAtEndOfSegmentConstraint() Initializes a new instance.
protected	ScalarAtEndOfSegmentConstraint(ScalarAtEndOfSegmentConstraint existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	ScalarAtEndOfSegmentConstraint(Scalar scalar, SegmentDefinition segment, double desiredValue, double tolerance, TimeBasedStateParameter parameter, EndsOfSegment endOfSegment) Initializes a new instance.
	ScalarAtEndOfSegmentConstraint(Scalar scalar, SegmentDefinition segment, double desiredValue, double tolerance, TimeBasedStateParameter parameter, EndsOfSegment endOfSegment, SolverConstraintScaling scaling) Initializes a new instance.
	ScalarAtEndOfSegmentConstraint(Scalar scalar, SegmentDefinition segment, double desiredValue, double tolerance, TimeBasedStateParameter parameter, EndsOfSegment endOfSegment, SolverConstraintScaling scaling, double weight) Initializes a new instance.
	ScalarAtEndOfSegmentConstraint(SegmentDefinition segment, double desiredValue, double tolerance) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(ScalarAtEndOfSegmentConstraint other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(SegmentPropagatorConstraint other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
EndsOfSegment	getEndOfSegment() Gets if the StateForNextSegment (get) or if the InitialState (get / set) should be used when evaluating this constraint.
SegmentPropagatorConstraintEvaluator	getEvaluator(EvaluatorGroup group) Creates and returns the SegmentPropagatorConstraintEvaluator.
TimeBasedStateParameter	getParameter() Gets the parameter to use when evaluating the Scalar (get / set).
Scalar	getScalar() Gets the Scalar to compute a value to compare to the DesiredValue (get / set).
SegmentDefinition	getSegment() Gets the SegmentDefinition whose final ephemeris point (in the StateForNextSegment (get)) will be used to compute a value.
void	setEndOfSegment(EndsOfSegment value) Sets if the StateForNextSegment (get) or if the InitialState (get / set) should be used when evaluating this constraint.
void	setParameter(TimeBasedStateParameter value) Sets the parameter to use when evaluating the Scalar (get / set).
void	setScalar(Scalar value) Sets the Scalar to compute a value to compare to the DesiredValue (get / set).
void	setSegment(SegmentDefinition value) Sets the SegmentDefinition whose final ephemeris point (in the StateForNextSegment (get)) will be used to compute a value.
protected void	validateProperties() Validates that required properties are configured correctly in order to get an evaluator for this instance.

Methods inherited from class agi.foundation.numericalmethods.SegmentPropagatorConstraint

checkForSameDefinition, freezeAggregatedObjects, getDesiredValue, getName, getSettings, setDesiredValue, setName, setSettings

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScalarAtEndOfSegmentConstraint

public ScalarAtEndOfSegmentConstraint()

Initializes a new instance.

Before ScalarAtEndOfSegmentConstraint.getEvaluator(agi.foundation.EvaluatorGroup) can be called, Scalar (get / set), Segment (get / set), and DesiredValue (get / set) must be configured, and Settings (get / set) must be configured with a valid Tolerance (get / set). Scaling (get / set) defaults to NoScalingOnConstraint.

ScalarAtEndOfSegmentConstraint

public ScalarAtEndOfSegmentConstraint(Scalar scalar,
                                      SegmentDefinition segment,
                                      double desiredValue,
                                      double tolerance,
                                      TimeBasedStateParameter parameter,
                                      @Nonnull
                                      EndsOfSegment endOfSegment,
                                      @Nonnull
                                      SolverConstraintScaling scaling)

Initializes a new instance.

Parameters:

scalar - The Scalar to use to compare to the desiredValue.

desiredValue - The desired value that the function will be driven to.

tolerance - How close the evaluated value must get to the desiredValue to consider this constraint satisfied.

segment - The SegmentDefinition whose final state will be used to compute the Scalar (get / set).

parameter - The parameter to use to when computing the scalar.

endOfSegment - Which state in the segment should be used to evaluate the scalar.

scaling - The type of scaling to be used on this constraint.

ScalarAtEndOfSegmentConstraint

public ScalarAtEndOfSegmentConstraint(Scalar scalar,
                                      SegmentDefinition segment,
                                      double desiredValue,
                                      double tolerance,
                                      TimeBasedStateParameter parameter,
                                      @Nonnull
                                      EndsOfSegment endOfSegment,
                                      @Nonnull
                                      SolverConstraintScaling scaling,
                                      double weight)

Initializes a new instance.

Parameters:

scalar - The Scalar to use to compare to the desiredValue.

desiredValue - The desired value that the function will be driven to.

tolerance - How close the evaluated value must get to the desiredValue to consider this constraint satisfied.

segment - The SegmentDefinition whose final state will be used to compute the Scalar (get / set).

parameter - The parameter to use to when computing the desiredValue.

endOfSegment - Which state in the segment should be used to evaluate the scalar.

scaling - The type of scaling to be used on this constraint.

weight - The weight of this constraint compared to the cost function and other constraints.

ScalarAtEndOfSegmentConstraint

public ScalarAtEndOfSegmentConstraint(SegmentDefinition segment,
                                      double desiredValue,
                                      double tolerance)

Initializes a new instance.

Parameters:

desiredValue - The desired value that the function will be driven to.

tolerance - How close the evaluated value must get to the desiredValue to consider this constraint satisfied.

segment - The SegmentDefinition whose final state will be used to compute the Scalar (get / set).

ScalarAtEndOfSegmentConstraint

public ScalarAtEndOfSegmentConstraint(Scalar scalar,
                                      SegmentDefinition segment,
                                      double desiredValue,
                                      double tolerance,
                                      TimeBasedStateParameter parameter,
                                      @Nonnull
                                      EndsOfSegment endOfSegment)

Initializes a new instance.

Parameters:

desiredValue - The desired value that the function will be driven to.

tolerance - How close the evaluated value must get to the desiredValue to consider this constraint satisfied.

scalar - The Scalar to use to compare to the desiredValue.

segment - The SegmentDefinition whose final state will be used to compute the Scalar (get / set).

parameter - The parameter to use to when computing the desiredValue.

endOfSegment - Which state in the segment should be used to evaluate the scalar.

ScalarAtEndOfSegmentConstraint

protected ScalarAtEndOfSegmentConstraint(@Nonnull
                                         ScalarAtEndOfSegmentConstraint existingInstance,
                                         @Nonnull
                                         CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(SegmentPropagatorConstraint other)

Checks to determine if another instance has the same definition as this instance and returns true 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 false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class SegmentPropagatorConstraint

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(ScalarAtEndOfSegmentConstraint other)

Checks to determine if another instance has the same definition as this instance and returns true 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 false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

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 ScalarAtEndOfSegmentConstraint.checkForSameDefinition(agi.foundation.numericalmethods.SegmentPropagatorConstraint) method.

Overrides:

computeCurrentDefinitionHashCode in class SegmentPropagatorConstraint

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(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.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class SegmentPropagatorConstraint

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getScalar

public final Scalar getScalar()

Gets the Scalar to compute a value to compare to the DesiredValue (get / set). This Scalar must be set to evaluate at any time during the ephemeris of the Segment (get / set). The common way to do that is to create a Scalar that is built from a ParameterizedOnStateScalar, ParameterizedOnStatePoint or ParameterizedOnStateVector with this parameter as their parameter.

setScalar

public final void setScalar(Scalar value)

Sets the Scalar to compute a value to compare to the DesiredValue (get / set). This Scalar must be set to evaluate at any time during the ephemeris of the Segment (get / set). The common way to do that is to create a Scalar that is built from a ParameterizedOnStateScalar, ParameterizedOnStatePoint or ParameterizedOnStateVector with this parameter as their parameter.

getSegment

public final SegmentDefinition getSegment()

Gets the SegmentDefinition whose final ephemeris point (in the StateForNextSegment (get)) will be used to compute a value.

setSegment

public final void setSegment(SegmentDefinition value)

Sets the SegmentDefinition whose final ephemeris point (in the StateForNextSegment (get)) will be used to compute a value.

getParameter

public final TimeBasedStateParameter getParameter()

Gets the parameter to use when evaluating the Scalar (get / set). The Scalar (get / set) must be set to evaluate at any time during the ephemeris of the Segment (get / set). The common way to do that is to create a Scalar that is built from a ParameterizedOnStateScalar, ParameterizedOnStatePoint or ParameterizedOnStateVector with this parameter as their parameter. Note that this and the Scalar (get / set) Scalar are coupled and changing this property will generally require changing the Scalar (get / set) as well.

setParameter

public final void setParameter(TimeBasedStateParameter value)

Sets the parameter to use when evaluating the Scalar (get / set). The Scalar (get / set) must be set to evaluate at any time during the ephemeris of the Segment (get / set). The common way to do that is to create a Scalar that is built from a ParameterizedOnStateScalar, ParameterizedOnStatePoint or ParameterizedOnStateVector with this parameter as their parameter. Note that this and the Scalar (get / set) Scalar are coupled and changing this property will generally require changing the Scalar (get / set) as well.

getEndOfSegment

@Nonnull
public final EndsOfSegment getEndOfSegment()

Gets if the StateForNextSegment (get) or if the InitialState (get / set) should be used when evaluating this constraint. By default this is EndsOfSegment.FINAL.

setEndOfSegment

public final void setEndOfSegment(@Nonnull
                                  EndsOfSegment value)

Sets if the StateForNextSegment (get) or if the InitialState (get / set) should be used when evaluating this constraint. By default this is EndsOfSegment.FINAL.

getEvaluator

public SegmentPropagatorConstraintEvaluator getEvaluator(EvaluatorGroup group)

Creates and returns the SegmentPropagatorConstraintEvaluator.

Derived classes should call ScalarAtEndOfSegmentConstraint.validateProperties() to check properties owned by this base class, as well as validate their own properties.

Specified by:

getEvaluator in class SegmentPropagatorConstraint

Parameters:

group - The EvaluatorGroup to use to create any necessary evaluators for this constraint.

Returns:

The fully configured constraint evaluator.

validateProperties

protected void validateProperties()

Validates that required properties are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing ScalarAtEndOfSegmentConstraint.getEvaluator(agi.foundation.EvaluatorGroup), as well as validate their own properties.

Overrides:

validateProperties in class SegmentPropagatorConstraint

Throws:

PropertyInvalidException - Thrown when Segment (get / set), Scalar (get / set), or Parameter (get / set) is null.

PropertyInvalidException - Thrown when Settings (get / set) or DesiredValue (get / set) is null, or Scaling (get / set) is null, or Tolerance (get / set) is not greater than zero.