agi.foundation.numericalmethods

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

Class MultivariableFunctionSolverStepResult<TResults,TDerivativeResults>

java.lang.Object

agi.foundation.numericalmethods.MultivariableFunctionSolverStepResult<TResults,TDerivativeResults>

Type Parameters:

TResults - The results type of the function evaluation.

TDerivativeResults - The results type of the function derivative evaluation.

public class MultivariableFunctionSolverStepResult<TResults,TDerivativeResults>
extends Object

The results evaluated in one iteration of a MultivariableFunctionSolver.

Constructor Summary

Constructors

Constructor and Description
MultivariableFunctionSolverStepResult(double[] variableDelta, TResults functionResults, TDerivativeResults derivativeResults, boolean converged, boolean aborted) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	getAborted() Gets a value indicating whether the solver has aborted.
boolean	getConverged() Gets a value indicating whether the solver converged on this iteration.
TDerivativeResults	getDerivativeResults() Gets the results of this iteration of the evaluation of the derivative of the multivariable function being solved.
boolean	getFinished() Gets a value indicating whether the solver has finished, either because the evaluation was aborted or converged.
TResults	getFunctionValue() Gets the multivariable function evaluation results.
double[]	getVariableDelta() Gets the change that should be applied to the state variables in the next iteration.
ArrayList<MultivariableFunctionSolverWarning>	getWarnings() Gets any warnings that may have been encountered during this evaluation.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultivariableFunctionSolverStepResult

public MultivariableFunctionSolverStepResult(double[] variableDelta,
                                             TResults functionResults,
                                             TDerivativeResults derivativeResults,
                                             boolean converged,
                                             boolean aborted)

Initializes a new instance.

Parameters:

variableDelta - The change that should be applied to the state variables in the next iteration.

functionResults - The multivariable function evaluation results.

derivativeResults - The results of this iteration of the evaluation of the derivatives of the multivariable function being solved.

converged - If the function solver converged on this iteration.

aborted - If the function solver was aborted during this iteration.

Method Detail

getVariableDelta

public final double[] getVariableDelta()

Gets the change that should be applied to the state variables in the next iteration.

getDerivativeResults

public final TDerivativeResults getDerivativeResults()

Gets the results of this iteration of the evaluation of the derivative of the multivariable function being solved.

getConverged

public final boolean getConverged()

Gets a value indicating whether the solver converged on this iteration.

getFinished

public final boolean getFinished()

Gets a value indicating whether the solver has finished, either because the evaluation was aborted or converged.

getAborted

public final boolean getAborted()

Gets a value indicating whether the solver has aborted.

getFunctionValue

public final TResults getFunctionValue()

Gets the multivariable function evaluation results.

getWarnings

@Nonnull
public final ArrayList<MultivariableFunctionSolverWarning> getWarnings()

Gets any warnings that may have been encountered during this evaluation.