Class ObjectiveEvaluation<TMetric>

Namespace

SignalSharp.Optimization

Assembly

SignalSharp.dll

Represents the output of evaluating the objective function at a given set of trial parameters.

public record ObjectiveEvaluation<TMetric> : IEquatable<ObjectiveEvaluation<TMetric>>

Type Parameters

TMetric

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

Inheritance

object

ObjectiveEvaluation<TMetric>

Implements

IEquatable<ObjectiveEvaluation<TMetric>>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ObjectiveEvaluation(TMetric, IReadOnlyDictionary<string, double>?)

Represents the output of evaluating the objective function at a given set of trial parameters.

public ObjectiveEvaluation(TMetric MetricValue, IReadOnlyDictionary<string, double>? Gradient = null)

Parameters

MetricValue TMetric

The calculated value of the objective metric.

Gradient IReadOnlyDictionary<string, double>

An optional dictionary mapping parameter names to their corresponding gradient components with respect to the objective metric. Null if gradients are not provided or not applicable.

Properties

Gradient

An optional dictionary mapping parameter names to their corresponding gradient components with respect to the objective metric. Null if gradients are not provided or not applicable.

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

Property Value

IReadOnlyDictionary<string, double>

MetricValue

The calculated value of the objective metric.

public TMetric MetricValue { get; init; }

Property Value

TMetric