agi.foundation.numericalmethods

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

Class NumericallyComputedMultivariableFunctionDerivativeResults

java.lang.Object

agi.foundation.numericalmethods.SolvableMultivariableFunctionDerivativeResults

agi.foundation.numericalmethods.NumericallyComputedMultivariableFunctionDerivativeResults

All Implemented Interfaces:

ICloneWithContext

public class NumericallyComputedMultivariableFunctionDerivativeResults
extends SolvableMultivariableFunctionDerivativeResults

The results of an evaluation of the derivative of a SolvableMultivariableFunction when that evaluation was done with a numerical algorithm.

Constructor Summary

Constructors

Constructor and Description
NumericallyComputedMultivariableFunctionDerivativeResults(SolvableMultivariableFunctionResults value, double[][] jacobian, SolvableMultivariableFunctionResults[] perturbedResultsUsedToComputeDerivative, boolean validPerturbations, FiniteDifferenceMethod differenceMethod) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
FiniteDifferenceMethod	getDifferenceMethod() Gets which difference method was used to compute these results.
SolvableMultivariableFunctionResults[]	getFunctionResultsUsedToComputeDerivative() Gets the results of the function that were computed at the perturbed values of the variables.
boolean	getValidPerturbations() Gets a value indicating whether the perturbations are valid.
SolvableMultivariableFunctionResults	getValue() Gets the results of the function at the nominal values of the variables.

Methods inherited from class agi.foundation.numericalmethods.SolvableMultivariableFunctionDerivativeResults

clone, getJacobian, getVariables

Methods inherited from class java.lang.Object

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

Constructor Detail

NumericallyComputedMultivariableFunctionDerivativeResults

public NumericallyComputedMultivariableFunctionDerivativeResults(@Nonnull
                                                                 SolvableMultivariableFunctionResults value,
                                                                 @Nonnull
                                                                 double[][] jacobian,
                                                                 SolvableMultivariableFunctionResults[] perturbedResultsUsedToComputeDerivative,
                                                                 boolean validPerturbations,
                                                                 @Nonnull
                                                                 FiniteDifferenceMethod differenceMethod)

Initializes a new instance.

Parameters:

value - The value of the function at the nominal variable values. This may be null if the routine that computed these results did not compute the value of the function.

jacobian - The Jacobian of the function evaluated at the variables of the value.

perturbedResultsUsedToComputeDerivative - The evaluations of the function used to compute the jacobian.

validPerturbations - If the perturbations of the variables were are valid. This may be false if the results of the function changed by too small of a value when the perturbations were applied to the variables.

differenceMethod - What difference method was used to compute these results.

Method Detail

getValue

public final SolvableMultivariableFunctionResults getValue()

Gets the results of the function at the nominal values of the variables.

getFunctionResultsUsedToComputeDerivative

public final SolvableMultivariableFunctionResults[] getFunctionResultsUsedToComputeDerivative()

Gets the results of the function that were computed at the perturbed values of the variables.

getValidPerturbations

public final boolean getValidPerturbations()

Gets a value indicating whether the perturbations are valid. If they are not then consider halting whatever operation is evaluating these results.

getDifferenceMethod

@Nonnull
public final FiniteDifferenceMethod getDifferenceMethod()

Gets which difference method was used to compute these results.