public class TargetedSegmentListFunction extends SolvableMultivariableFunction
A SolvableMultivariableFunction that can be used in a
MultivariableFunctionSolver to solve for an arbitrary trajectory or other
state elements based on
variables and
constraints.
This function will be created automatically
at propagation time inside any
TargetedSegmentListOperator that requires a function.
As such, this will not dispose the items it is configured with.
This function applies and resets the variable values supplied by the MultivariableFunctionDifferentialSolver.
| Modifier | Constructor and Description |
|---|---|
|
TargetedSegmentListFunction(List<SegmentPropagatorVariableEvaluator> variableEvaluators,
List<SegmentPropagatorConstraintEvaluator> constraintEvaluators,
List<SegmentPropagator> segmentPropagators,
FiniteDifferenceMethod differenceMethod,
TargetedSegmentListResults emptyResults,
TargetedSegmentListConfiguration configuration)
Initializes a new instance.
|
protected |
TargetedSegmentListFunction(TargetedSegmentListFunction existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
void |
applyResults(SolvableMultivariableFunctionResults results)
For
SolvableMultivariableFunctions that have
state, there may be times when that state should be manually set on a function (sometimes
for performance reasons, when the function will be called multiple times and it should
start from where it left off). |
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
SolvableMultivariableFunctionResults |
evaluate(double[] variables,
ITrackCalculationProgress progressTracker)
Evaluates the function.
|
boolean |
getIsThreadSafe()
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
|
addDerivativeEvaluationEvent, addNormalFunctionEvaluationEvent, addPerturbedFunctionEvaluationEvent, callDerivativeEvaluationEvent, dispose, dispose, evaluate, evaluateDerivative, evaluateDerivative, getDifferenceMethod, getPerturbationValues, removeDerivativeEvaluationEvent, removeNormalFunctionEvaluationEvent, removePerturbedFunctionEvaluationEvent, setDifferenceMethod, setPerturbationValuesclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclosepublic TargetedSegmentListFunction(@Nonnull List<SegmentPropagatorVariableEvaluator> variableEvaluators, @Nonnull List<SegmentPropagatorConstraintEvaluator> constraintEvaluators, @Nonnull List<SegmentPropagator> segmentPropagators, @Nonnull FiniteDifferenceMethod differenceMethod, @Nonnull TargetedSegmentListResults emptyResults, @Nonnull TargetedSegmentListConfiguration configuration)
variableEvaluators - The SegmentPropagatorVariableEvaluator that this
function will vary.constraintEvaluators - The SegmentPropagatorConstraintEvaluator that will
form the results of this function.configuration - The configuration of the parent TargetedSegmentList that is running
the operator that is running this function.emptyResults - The TargetedSegmentListResults of the segment that is running this function.
This may not be null and it must have in it configurations for all of the segmentPropagators.segmentPropagators - The SegmentPropagators that will be run
to evaluate this function.differenceMethod - How this function should be sampled to determine the derivative of a variable.protected TargetedSegmentListFunction(@Nonnull TargetedSegmentListFunction 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 SolvableMultivariableFunctionResults evaluate(double[] variables, ITrackCalculationProgress progressTracker)
SolvableMultivariableFunctionResults returned must include the computed
constraints in the order that they are in the Constraints (get).
If your function computes more than just constraint values you should extend
SolvableMultivariableFunctionResults to contain those additional results.evaluate in class SolvableMultivariableFunctionvariables - The value of the variables to evaluate at.progressTracker - An optional progress tracker.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 ICloneWithContextclone in class SolvableMultivariableFunctioncontext - The context to use to perform the copy.public boolean getIsThreadSafe()
If this property is true, all methods and properties are guaranteed to be thread safe.
Conceptually, an object that returns true for this method acts as if there is a lock
protecting each method and property such that only one thread at a time can be inside any method or
property in the class. In reality, such locks are generally not used and are in fact discouraged. However,
the user must not experience any exceptions or inconsistent behavior that would not be experienced if such
locks were used.
If this property is false, the behavior when using this class from multiple threads
simultaneously is undefined and may include inconsistent results and exceptions. Clients wishing to use
multiple threads should call CopyForAnotherThread.copy(T) to get a separate instance of the
object for each thread.
getIsThreadSafe in interface IThreadAwaregetIsThreadSafe in class SolvableMultivariableFunctionpublic void applyResults(SolvableMultivariableFunctionResults results)
SolvableMultivariableFunctions that have
state, there may be times when that state should be manually set on a function (sometimes
for performance reasons, when the function will be called multiple times and it should
start from where it left off). This method will manually set that state, if needed.applyResults in class SolvableMultivariableFunctionresults - The results to apply.