public class ScalarAtEndOfSegmentInequalityConstraint extends SegmentPropagatorInequalityConstraint
constraint
will take the initial or final value from a
SegmentResults
and evaluate a Scalar
(get
/ set
) at that time with that information.Modifier | Constructor and Description |
---|---|
|
ScalarAtEndOfSegmentInequalityConstraint()
Initializes a new instance.
|
protected |
ScalarAtEndOfSegmentInequalityConstraint(ScalarAtEndOfSegmentInequalityConstraint existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
ScalarAtEndOfSegmentInequalityConstraint(Scalar scalar,
SegmentDefinition segment,
InequalityBoundType boundType,
double boundValue,
double tolerance,
TimeBasedStateParameter parameter,
EndsOfSegment endOfSegment)
Initializes a new instance.
|
|
ScalarAtEndOfSegmentInequalityConstraint(Scalar scalar,
SegmentDefinition segment,
InequalityBoundType boundType,
double boundValue,
double tolerance,
TimeBasedStateParameter parameter,
EndsOfSegment endOfSegment,
InequalityConstraintScaling scaling)
Initializes a new instance.
|
|
ScalarAtEndOfSegmentInequalityConstraint(Scalar scalar,
SegmentDefinition segment,
InequalityBoundType boundType,
double boundValue,
double tolerance,
TimeBasedStateParameter parameter,
EndsOfSegment endOfSegment,
InequalityConstraintScaling scaling,
double weight)
Initializes a new instance.
|
|
ScalarAtEndOfSegmentInequalityConstraint(SegmentDefinition segment,
InequalityBoundType boundType,
double boundValue,
double tolerance)
Initializes a new instance.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
checkForSameDefinition(ScalarAtEndOfSegmentInequalityConstraint other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(SegmentPropagatorInequalityConstraint 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()
|
SegmentPropagatorInequalityConstraintEvaluator |
getEvaluator(EvaluatorGroup group)
Creates and returns the
SegmentPropagatorInequalityConstraintEvaluator . |
TimeBasedStateParameter |
getParameter()
|
Scalar |
getScalar()
|
SegmentDefinition |
getSegment()
Gets the
SegmentDefinition whose final ephemeris point (in the StateForNextSegment (get ))
will be used to compute a value. |
void |
setEndOfSegment(EndsOfSegment value)
|
void |
setParameter(TimeBasedStateParameter value)
|
void |
setScalar(Scalar value)
|
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.
|
checkForSameDefinition, freezeAggregatedObjects, getBoundType, getBoundValue, getName, getSettings, setBoundType, setBoundValue, setName, setSettings
areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen
public ScalarAtEndOfSegmentInequalityConstraint()
Initializes a new instance.
Before ScalarAtEndOfSegmentInequalityConstraint.getEvaluator(agi.foundation.EvaluatorGroup)
can be called,
Scalar
(get
/ set
), Segment
(get
/ set
), BoundType
(get
/ set
),
and BoundValue
(get
/ set
) must be configured, and
Settings
(get
/ set
) must be configured with a valid Tolerance
(get
/ set
).
Scaling
(get
/ set
) defaults to NoScalingOnInequalityConstraint
.
public ScalarAtEndOfSegmentInequalityConstraint(Scalar scalar, SegmentDefinition segment, @Nonnull InequalityBoundType boundType, double boundValue, double tolerance, TimeBasedStateParameter parameter, @Nonnull EndsOfSegment endOfSegment, @Nonnull InequalityConstraintScaling scaling)
scalar
- The Scalar
to use to compare to the
boundValue
.boundType
- Whether the boundValue
represents a lower or an upper bound.boundValue
- The lower or upper bound value that the function
will be driven to satisfy if it is not already satisfied.tolerance
- How close the evaluated value must get to the
boundValue
to consider this inequality constraint to be active and on the constraint manifold.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.public ScalarAtEndOfSegmentInequalityConstraint(Scalar scalar, SegmentDefinition segment, @Nonnull InequalityBoundType boundType, double boundValue, double tolerance, TimeBasedStateParameter parameter, @Nonnull EndsOfSegment endOfSegment, @Nonnull InequalityConstraintScaling scaling, double weight)
scalar
- The Scalar
to use to compare to the
boundValue
.boundType
- Whether the boundValue
represents a lower or an upper bound.boundValue
- The lower or upper bound value that the function
will be driven to satisfy if it is not already satisfied.tolerance
- How close the evaluated value must get to the
boundValue
to consider this inequality constraint to be active and on the constraint manifold.segment
- The SegmentDefinition
whose final state
will
be used to compute the Scalar
(get
/ set
).parameter
- The parameter to use to when computing the boundValue
.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.public ScalarAtEndOfSegmentInequalityConstraint(SegmentDefinition segment, @Nonnull InequalityBoundType boundType, double boundValue, double tolerance)
boundType
- Whether the boundValue
represents a lower or an upper bound.boundValue
- The lower or upper bound value that the function
will be driven to satisfy if it is not already satisfied.tolerance
- How close the evaluated value must get to the
boundValue
to consider this inequality constraint to be active and on the constraint manifold.segment
- The SegmentDefinition
whose final state
will
be used to compute the Scalar
(get
/ set
).public ScalarAtEndOfSegmentInequalityConstraint(Scalar scalar, SegmentDefinition segment, @Nonnull InequalityBoundType boundType, double boundValue, double tolerance, TimeBasedStateParameter parameter, @Nonnull EndsOfSegment endOfSegment)
scalar
- The Scalar
to use to compare to the
boundValue
.boundType
- Whether the boundValue
represents a lower or an upper bound.boundValue
- The lower or upper bound value that the function
will be driven to satisfy if it is not already satisfied.tolerance
- How close the evaluated value must get to the
boundValue
to consider this inequality constraint to be active and on the constraint manifold.segment
- The SegmentDefinition
whose final state
will
be used to compute the Scalar
(get
/ set
).parameter
- The parameter to use to when computing the boundValue
.endOfSegment
- Which state in the segment should be used to evaluate the scalar
.protected ScalarAtEndOfSegmentInequalityConstraint(@Nonnull ScalarAtEndOfSegmentInequalityConstraint existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext)
for more information about how to implement this constructor
in a derived class.
existingInstance
- The existing instance to copy.context
- A CopyContext
that controls the depth of the copy.ArgumentNullException
- Thrown when existingInstance
or context
is null
.public Object clone(CopyContext 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:
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:
CopyContext.updateReference(T)
. You should still call CopyContext.updateReference(T)
on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext)
as the last line in the constructor and pass it the
same CopyContext
passed to the constructor.
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;
clone
in interface ICloneWithContext
clone
in class DefinitionalObject
context
- The context to use to perform the copy.protected final boolean checkForSameDefinition(SegmentPropagatorInequalityConstraint other)
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)
.checkForSameDefinition
in class SegmentPropagatorInequalityConstraint
other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected boolean checkForSameDefinition(ScalarAtEndOfSegmentInequalityConstraint other)
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)
.other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected int computeCurrentDefinitionHashCode()
ScalarAtEndOfSegmentInequalityConstraint.checkForSameDefinition(agi.foundation.numericalmethods.SegmentPropagatorInequalityConstraint)
method.computeCurrentDefinitionHashCode
in class SegmentPropagatorInequalityConstraint
public void enumerateDependencies(DependencyEnumerator enumerator)
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.enumerateDependencies
in interface IEnumerateDependencies
enumerateDependencies
in class SegmentPropagatorInequalityConstraint
enumerator
- The enumerator that is informed of the dependencies of this object.public final Scalar getScalar()
Scalar
to compute a value to compare to the
BoundValue
(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.public final void setScalar(Scalar value)
Scalar
to compute a value to compare to the
BoundValue
(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.public final SegmentDefinition getSegment()
SegmentDefinition
whose final ephemeris point (in the StateForNextSegment
(get
))
will be used to compute a value.public final void setSegment(SegmentDefinition value)
SegmentDefinition
whose final ephemeris point (in the StateForNextSegment
(get
))
will be used to compute a value.public final TimeBasedStateParameter getParameter()
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.public final void setParameter(TimeBasedStateParameter value)
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.@Nonnull public final EndsOfSegment getEndOfSegment()
StateForNextSegment
(get
) or if the
InitialState
(get
/ set
) should be used when evaluating
this constraint. By default this is EndsOfSegment.FINAL
.public final void setEndOfSegment(@Nonnull EndsOfSegment value)
StateForNextSegment
(get
) or if the
InitialState
(get
/ set
) should be used when evaluating
this constraint. By default this is EndsOfSegment.FINAL
.public SegmentPropagatorInequalityConstraintEvaluator getEvaluator(EvaluatorGroup group)
SegmentPropagatorInequalityConstraintEvaluator
.
Derived classes should call ScalarAtEndOfSegmentInequalityConstraint.validateProperties()
to check properties
owned by this base class, as well as validate their own properties.
getEvaluator
in class SegmentPropagatorInequalityConstraint
group
- The EvaluatorGroup
to use to create any necessary
evaluators
for this constraint.constraint evaluator
.protected void validateProperties()
ScalarAtEndOfSegmentInequalityConstraint.getEvaluator(agi.foundation.EvaluatorGroup)
, as well as validate their own properties.validateProperties
in class SegmentPropagatorInequalityConstraint
PropertyInvalidException
- Thrown when Segment
(get
/ set
), Scalar
(get
/ set
), or Parameter
(get
/ set
) is null
.PropertyInvalidException
- Thrown when Settings
(get
/ set
) or BoundValue
(get
/ set
) is null
, or
Scaling
(get
/ set
) is null
, or
Tolerance
(get
/ set
) is not greater than zero.