agi.foundation.numericalmethods

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

Class MultivariableFunctionSolverResults<TIterationResults>

java.lang.Object

agi.foundation.numericalmethods.MultivariableFunctionSolverResults<TIterationResults>

Type Parameters:

TIterationResults - The results type of an iteration of a solver.

All Implemented Interfaces:

ICloneWithContext

public class MultivariableFunctionSolverResults<TIterationResults>
extends Object
implements ICloneWithContext

A type storing the overall results of a MultivariableFunctionSolver. If requested, this type will store all the iteration results from an entire run of a MultivariableFunctionSolver.

Constructor Summary

Constructors

Modifier	Constructor and Description
	MultivariableFunctionSolverResults(Iterable<? extends TIterationResults> iterationResults, boolean aborted, boolean converged, Iterable<? extends MultivariableFunctionSolverWarning> warnings) Initializes a new instance.
protected	MultivariableFunctionSolverResults(MultivariableFunctionSolverResults<TIterationResults> existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
Object	clone(CopyContext context) Clones this object using the specified context.
boolean	getAborted() Gets a value indicating whether the run aborted.
boolean	getConverged() Gets a value indicating whether the solver converged.
TIterationResults	getFinalIteration() Gets the TIterationResults of the final iteration.
ArrayList<TIterationResults>	getIterationResults() Gets the results for each iteration the solver performed.
ArrayList<MultivariableFunctionSolverWarning>	getWarnings() Gets a list of warnings that the MultivariableFunctionSolver produced.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultivariableFunctionSolverResults

public MultivariableFunctionSolverResults(@Nonnull
                                          Iterable<? extends TIterationResults> iterationResults,
                                          boolean aborted,
                                          boolean converged,
                                          @Nonnull
                                          Iterable<? extends MultivariableFunctionSolverWarning> warnings)

Initializes a new instance.

Parameters:

iterationResults - The results of each iteration. This should contain at least one TIterationResults.

aborted - Indicated if the run of the MultivariableFunctionSolver was aborted or not.

converged - Indicated if the run of the MultivariableFunctionSolver converged or not.

warnings - Any warnings that the MultivariableFunctionSolver produced.

MultivariableFunctionSolverResults

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

clone

public Object clone(CopyContext context)

Clones this object using the specified 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:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

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:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement 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;

Specified by:

clone in interface ICloneWithContext

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

getIterationResults

@Nonnull
public final ArrayList<TIterationResults> getIterationResults()

Gets the results for each iteration the solver performed.

getFinalIteration

@Nullable
public final TIterationResults getFinalIteration()

Gets the TIterationResults of the final iteration. null is returned if there are no results.

getAborted

public final boolean getAborted()

Gets a value indicating whether the run aborted. This can happen either by the user canceling the computation, or if some warning was detected that prevented the MultivariableFunctionSolver from running to completion.

getConverged

public final boolean getConverged()

Gets a value indicating whether the solver converged.

getWarnings

@Nonnull
public final ArrayList<MultivariableFunctionSolverWarning> getWarnings()

Gets a list of warnings that the MultivariableFunctionSolver produced.