public class NewtonRaphsonMultivariableFunctionSolver extends MultivariableFunctionDifferentialSolver
SolvableMultivariableFunctions.
This uses the Newton-Raphson method for solving a function with multiple variables.
See the Multivariable Function Solvers topic for more detail on how to use function solvers.
| Modifier | Constructor and Description |
|---|---|
|
NewtonRaphsonMultivariableFunctionSolver()
Initializes a new instance.
|
protected |
NewtonRaphsonMultivariableFunctionSolver(NewtonRaphsonMultivariableFunctionSolver existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
MultivariableFunctionSolverStepResult<SolvableMultivariableFunctionResults,SolvableMultivariableFunctionDerivativeResults> |
computeNextStep(double[] variableValues,
ITrackCalculationProgress progressTracker)
Computes the next differential step that this differential corrector should take.
|
boolean |
getIsThreadSafe()
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
|
boolean |
getMultithreaded()
Gets a value indicating whether this solver should evaluate an iteration with as many threads as the current threading
policy facet will allow, or with as many
Variables (get)
as there are in the function plus 1; whichever is less. |
void |
setMultithreaded(boolean value)
Sets a value indicating whether this solver should evaluate an iteration with as many threads as the current threading
policy facet will allow, or with as many
Variables (get)
as there are in the function plus 1; whichever is less. |
findSolution, getLineSearchSettings, setLineSearchSettingscheckConstraints, dispose, dispose, findSolution, findSolution, getConstraints, getCurrentIteration, getFunction, getLastRunsResults, getVariables, reset, setCurrentIteration, setFunction, setLastRunsResultsclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclosepublic NewtonRaphsonMultivariableFunctionSolver()
protected NewtonRaphsonMultivariableFunctionSolver(@Nonnull NewtonRaphsonMultivariableFunctionSolver 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 ICloneWithContextclone in class MultivariableFunctionSolvercontext - 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 MultivariableFunctionSolverpublic MultivariableFunctionSolverStepResult<SolvableMultivariableFunctionResults,SolvableMultivariableFunctionDerivativeResults> computeNextStep(double[] variableValues, ITrackCalculationProgress progressTracker)
computeNextStep in class MultivariableFunctionDifferentialSolvervariableValues - The current values of the variables.progressTracker - An optional progress tracker.public boolean getMultithreaded()
Variables (get)
as there are in the function plus 1; whichever is less. By default this is true.
There are some situations where the multithreaded algorithm will be slower than the single threaded. Multi-threaded may be slower if the time it takes to compute the function is fast when compared to the overhead of setting up the threads, or if the overall solver will converge to a solution in very few iterations and there are many variables relative to the number of threads.
The specific algorithm you implement may fundamentally be single threaded. In that case it is acceptable to ignore this property.
getMultithreaded in class MultivariableFunctionSolverpublic void setMultithreaded(boolean value)
Variables (get)
as there are in the function plus 1; whichever is less. By default this is true.
There are some situations where the multithreaded algorithm will be slower than the single threaded. Multi-threaded may be slower if the time it takes to compute the function is fast when compared to the overhead of setting up the threads, or if the overall solver will converge to a solution in very few iterations and there are many variables relative to the number of threads.
The specific algorithm you implement may fundamentally be single threaded. In that case it is acceptable to ignore this property.
setMultithreaded in class MultivariableFunctionSolver