OptimizationSolutionReport Class

Represents the result of solving an optimization model.

Definition

Namespace: Numerics.NET.Optimization
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
C#
public class OptimizationSolutionReport : SolutionReport<Vector<double>, double>
Inheritance
Object  →  SolutionReport<Vector<Double>, Double>  →  OptimizationSolutionReport

Remarks

Use the OptimizationSolutionReport to get information about the solution of an optimization model. This class provides two properties in addition to the standard properties of a solution report. The ModelStatus property returns an OptimizationModelStatus value that provides a more detailed indication of the final status of the model. The OptimalValue property returns the value of the objective function at the final solution.

Constructors

OptimizationSolutionReportInitializes a new instance of the OptimizationSolutionReport class

Properties

ConvergenceTest Returns the ConvergenceTest<T> that caused the result.
(Inherited from SolutionReport<T, TError>)
Error Gets the estimated error in the result.
(Inherited from SolutionReport<T, TError>)
EvaluationsNeeded Gets the number of times the target or objective function was called by the algorithm.
(Inherited from SolutionReport<T, TError>)
GradientEvaluationsNeeded Gets the number of times the gradient of the objective function was evaluated.
IterationsNeeded Gets the number of iterations performed by the algorithm.
(Inherited from SolutionReport<T, TError>)
ModelStatus Gets the model-specific status of the model.
OptimalValue Gets the value of the objective function at the final solution.
Result Gets the result of the algorithm.
(Inherited from SolutionReport<T, TError>)
Status Gets the termination status of the algorithm.
(Inherited from SolutionReport<T, TError>)

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Summarize() Returns a string containing a human-readable summary of the object using default options.
(Inherited from SolutionReport<T, TError>)
Summarize(SummaryOptions) Returns a string containing a human-readable summary of the object using the specified options.
(Inherited from SolutionReport<T, TError>)
ToStringReturns a string that represents the current object.
(Inherited from SolutionReport<T, TError>)

See Also