TIndependent - The type of the independent (input) variable.TDependent - The type of the dependent (output) variable.TDependentDerivative - The type of the derivatives of the dependent (output) variable.public abstract class Function3<TIndependent,TDependent,TDependentDerivative> extends Object implements IThreadAware, IDisposable
| Modifier | Constructor and Description |
|---|---|
protected |
Function3()
Initializes a new instance.
|
protected |
Function3(Function3<TIndependent,TDependent,TDependentDerivative> existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
abstract Object |
clone(CopyContext context)
Clones this object using the specified context.
|
void |
dispose()
Releases any resources associated with this instance.
|
protected abstract void |
dispose(boolean disposing)
Releases any resources associated with this instance.
|
abstract TDependent |
evaluate(TIndependent x)
Evaluates the function.
|
abstract Motion2<TDependent,TDependentDerivative> |
evaluate(TIndependent x,
int order)
Evaluates the function.
|
abstract boolean |
getIsThreadSafe()
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
|
TIndependent |
getNextSampleSuggestion(TIndependent x)
Gets a suggestion for the next independent variable value at which to sample this function.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcloseprotected Function3()
protected Function3(@Nonnull Function3<TIndependent,TDependent,TDependentDerivative> 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 abstract 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 ICloneWithContextcontext - The context to use to perform the copy.public final void dispose()
dispose in interface IDisposableprotected abstract void dispose(boolean disposing)
disposing - true to release both managed and unmanaged resources;
false to release only unmanaged resources.public abstract 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 IThreadAwarepublic abstract TDependent evaluate(TIndependent x)
For information about the specific function evaluated by this evaluator, see the documentation for the method that was used to create this function.
Once created, an evaluator will ignore changes made to the object(s) from which it was created.
In other words, this method will always return the same result for a given x
regardless of changes made to other objects in the system. You should create a new evaluator
after making changes to definitional objects in order for those changes to be reflected in the results.
x - The value with which to evaluate the function.@Nonnull public abstract Motion2<TDependent,TDependentDerivative> evaluate(TIndependent x, int order)
For information about the specific function evaluated by this evaluator, see the documentation for the method that was used to create this evaluator.
Once created, an evaluator will ignore changes made to the object(s) from which it was created.
In other words, this method will always return the same result for a given x
regardless of changes made to other objects in the system. You should create a new evaluator
after making changes to definitional objects in order for those changes to be reflected in the results.
x - The value with which to evaluate the function.order - The target order to evaluate. Passing 0 evaluates the value only.
Passing 1 evaluates the value and its derivative, etc. If necessary a
result of lower or even higher order than the target may be returned.public TIndependent getNextSampleSuggestion(TIndependent x)
x - The previous independent variable sample value.x if this function has no suggestion.