Class OptimizationResult<TMetric>

Namespace

SignalSharp.Optimization

Assembly

SignalSharp.dll

Represents the result of an optimization process.

public record OptimizationResult<TMetric> : IEquatable<OptimizationResult<TMetric>>

Type Parameters

TMetric

The type of the objective metric (e.g., SSE).

Inheritance

object

OptimizationResult<TMetric>

Implements

IEquatable<OptimizationResult<TMetric>>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OptimizationResult(IReadOnlyDictionary<string, double>, TMetric, bool, string?, int?, int?)

Represents the result of an optimization process.

public OptimizationResult(IReadOnlyDictionary<string, double> BestParameters, TMetric MinimizedMetric, bool Success = true, string? Message = null, int? Iterations = null, int? FunctionEvaluations = null)

Parameters

BestParameters IReadOnlyDictionary<string, double>

A dictionary of the best parameter names and their optimized values.

MinimizedMetric TMetric

The value of the objective metric at the best parameters.

Success bool

Indicates if the optimization was successful in finding a valid solution.

Message string

An optional message providing more details about the optimization outcome or errors.

Iterations int?

Optional: The number of iterations performed by the optimizer (if applicable).

FunctionEvaluations int?

Optional: The total number of times the objective function was evaluated (if applicable).

Properties

BestParameters

A dictionary of the best parameter names and their optimized values.

public IReadOnlyDictionary<string, double> BestParameters { get; init; }

Property Value

IReadOnlyDictionary<string, double>

FunctionEvaluations

Optional: The total number of times the objective function was evaluated (if applicable).

public int? FunctionEvaluations { get; init; }

Property Value

int?

Iterations

Optional: The number of iterations performed by the optimizer (if applicable).

public int? Iterations { get; init; }

Property Value

int?

Message

An optional message providing more details about the optimization outcome or errors.

public string? Message { get; init; }

Property Value

string

MinimizedMetric

The value of the objective metric at the best parameters.

public TMetric MinimizedMetric { get; init; }

Property Value

TMetric

Success

Indicates if the optimization was successful in finding a valid solution.

public bool Success { get; init; }

Property Value

bool