agi.foundation.numericalmethods

(agi.foundation.models-2024r3.jar)

Class SegmentPropagatorVariable

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.numericalmethods.SegmentPropagatorVariable

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

DelegateBasedVariable, ParameterizedDateVariable, ParameterizedDoubleVariable, ParameterizedDurationVariable, ParameterizedScalarVariable

public abstract class SegmentPropagatorVariable
extends DefinitionalObject

The variable base type used within a MultivariableFunctionSolver in conjunction with SegmentPropagators.

See Also:

SegmentPropagatorVariableEvaluator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SegmentPropagatorVariable() Initializes a new instance.
protected	SegmentPropagatorVariable(double maximumStep, double perturbation, SegmentDefinition segment) Initializes a new instance.
protected	SegmentPropagatorVariable(double maximumStep, double perturbation, SegmentDefinition segment, SolverVariableScaling scaling) Initializes a new instance.
protected	SegmentPropagatorVariable(SegmentPropagatorVariable existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(SegmentPropagatorVariable other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
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.
protected void	freezeAggregatedObjects() Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
abstract SegmentPropagatorVariableEvaluator	getEvaluator(EvaluatorGroup group) Gets a SegmentPropagatorVariableEvaluator for this variable.
String	getName() Gets an optional name for this variable.
double	getPerturbationValue() Gets the perturbation value to use when computing a numerical derivative relative to this variable of a SolvableMultivariableFunction that uses SegmentPropagators.
SegmentDefinition	getSegment() Gets the segment that this variable will act on.
SolverVariableSettings	getSettings() Gets the settings for the MultivariableFunctionSolver associated with this variable.
void	setName(String value) Sets an optional name for this variable.
void	setPerturbationValue(double value) Sets the perturbation value to use when computing a numerical derivative relative to this variable of a SolvableMultivariableFunction that uses SegmentPropagators.
void	setSegment(SegmentDefinition value) Sets the segment that this variable will act on.
void	setSettings(SolverVariableSettings value) Sets the settings for the MultivariableFunctionSolver associated with this variable.
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.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, 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

SegmentPropagatorVariable

protected SegmentPropagatorVariable()

Initializes a new instance.

Before SegmentPropagatorVariable.getEvaluator(agi.foundation.EvaluatorGroup) can be called, PerturbationValue (get / set) and Segment (get / set) must be configured, and Settings (get / set) must be configured with a valid MaximumStep (get / set). Scaling (get / set) defaults to NoScalingOnVariable.

SegmentPropagatorVariable

protected SegmentPropagatorVariable(double maximumStep,
                                    double perturbation,
                                    SegmentDefinition segment)

Initializes a new instance.

Scaling (get / set) defaults to NoScalingOnVariable.

Parameters:

maximumStep - The maximum step that this variable should take.

perturbation - The perturbation that should be used when finding the derivative of a functions derivative with respect to this variable.

segment - The segment that this variable will operate on.

SegmentPropagatorVariable

protected SegmentPropagatorVariable(double maximumStep,
                                    double perturbation,
                                    SegmentDefinition segment,
                                    SolverVariableScaling scaling)

Initializes a new instance.

Scaling (get / set) defaults to NoScalingOnVariable.

Parameters:

maximumStep - The maximum step that this variable should take.

perturbation - The perturbation that should be used when finding the derivative of a functions derivative with respect to this variable.

segment - The segment that this variable will operate on.

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

SegmentPropagatorVariable

protected SegmentPropagatorVariable(@Nonnull
                                    SegmentPropagatorVariable 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

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject 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 DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

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

checkForSameDefinition

protected abstract boolean checkForSameDefinition(SegmentPropagatorVariable 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 SegmentPropagatorVariable.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

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 DefinitionalObject

Parameters:

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

freezeAggregatedObjects

protected void freezeAggregatedObjects()

Called by DefinitionalObject.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:

freezeAggregatedObjects in class DefinitionalObject

getPerturbationValue

public final double getPerturbationValue()

Gets the perturbation value to use when computing a numerical derivative relative to this variable of a SolvableMultivariableFunction that uses SegmentPropagators.

setPerturbationValue

public final void setPerturbationValue(double value)

Sets the perturbation value to use when computing a numerical derivative relative to this variable of a SolvableMultivariableFunction that uses SegmentPropagators.

getSegment

public final SegmentDefinition getSegment()

Gets the segment that this variable will act on.

setSegment

public final void setSegment(SegmentDefinition value)

Sets the segment that this variable will act on.

getSettings

public final SolverVariableSettings getSettings()

Gets the settings for the MultivariableFunctionSolver associated with this variable.

setSettings

public final void setSettings(SolverVariableSettings value)

Sets the settings for the MultivariableFunctionSolver associated with this variable.

getName

public final String getName()

Gets an optional name for this variable.

setName

public final void setName(String value)

Sets an optional name for this variable.

getEvaluator

@Nonnull
public abstract SegmentPropagatorVariableEvaluator getEvaluator(@Nonnull
                                                                          EvaluatorGroup group)

Gets a SegmentPropagatorVariableEvaluator for this variable.

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

Parameters:

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

Returns:

The fully configured variable 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 SegmentPropagatorVariable.getEvaluator(agi.foundation.EvaluatorGroup), as well as validate their own properties.

Throws:

PropertyInvalidException - Thrown when Settings (get / set) is null, or Segment (get / set) is null, or Scaling (get / set) is null, or MaximumStep (get / set) is not greater than zero, or VariableTolerance (get / set) is negative.