Click or drag to resize

DifferentialCorrectorStepResult Class

The results evaluated in one iteration of a MultivariableFunctionDifferentialSolver.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.NumericalMethodsDifferentialCorrectorStepResult

Namespace:  AGI.Foundation.NumericalMethods
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 20.2.404.0 (20.2.404.0)
Syntax
public class DifferentialCorrectorStepResult

The DifferentialCorrectorStepResult type exposes the following members.

Constructors
  NameDescription
Public methodDifferentialCorrectorStepResult
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyAborted
Gets a value indicating whether the differential solver has aborted.
Public propertyConverged
Gets a value indicating whether the differential solver converged on this iteration.
Public propertyDerivativeResults
Gets the results of this iteration of the evaluation of the derivative of the SolvableMultivariableFunction being solved for.
Public propertyFinished
Gets a value indicating whether the differential solver has finished, either because the evaluation was aborted or converged.
Public propertyFunctionValue
Gets the function evaluation results.
Public propertyVariableDelta
Gets the change that should be applied to the state variables in the next iteration.
Public propertyWarnings
Gets any warnings that may have been encountered during this evaluation.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also