Class NonLinearLeastSquareResults

Namespace

NanoQL.Numerics

Assembly

NanoQL.dll

The results of a non-linear least-squares fit, QuantLib's NonLinearLeastSquare inspectors.

public sealed record NonLinearLeastSquareResults : IEquatable<NonLinearLeastSquareResults>

Inheritance

object

NonLinearLeastSquareResults

Implements

IEquatable<NonLinearLeastSquareResults>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

NonLinearLeastSquareResults(ImmutableArray<double>, double, double, EndCriteriaType)

The results of a non-linear least-squares fit, QuantLib's NonLinearLeastSquare inspectors.

public NonLinearLeastSquareResults(ImmutableArray<double> Results, double ResidualNorm, double LastValue, EndCriteriaType ExitFlag)

Parameters

Results ImmutableArray<double>

The point found.

ResidualNorm double

The cost there, the square of the residuals' norm.

LastValue double

The cost there, QuantLib's lastValue().

ExitFlag EndCriteriaType

The end criterion the minimization met.

Properties

ExitFlag

The end criterion the minimization met.

public EndCriteriaType ExitFlag { get; init; }

Property Value

EndCriteriaType

LastValue

The cost there, QuantLib's lastValue().

public double LastValue { get; init; }

Property Value

double

ResidualNorm

The cost there, the square of the residuals' norm.

public double ResidualNorm { get; init; }

Property Value

double

Results

The point found.

public ImmutableArray<double> Results { get; init; }

Property Value

ImmutableArray<double>

Methods

Deconstruct(out ImmutableArray<double>, out double, out double, out EndCriteriaType)

public void Deconstruct(out ImmutableArray<double> Results, out double ResidualNorm, out double LastValue, out EndCriteriaType ExitFlag)

Parameters

Results ImmutableArray<double>

ResidualNorm double

LastValue double

ExitFlag EndCriteriaType

Equals(NonLinearLeastSquareResults?)

public bool Equals(NonLinearLeastSquareResults? other)

Parameters

other NonLinearLeastSquareResults

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(NonLinearLeastSquareResults?, NonLinearLeastSquareResults?)

public static bool operator ==(NonLinearLeastSquareResults? left, NonLinearLeastSquareResults? right)

Parameters

left NonLinearLeastSquareResults

right NonLinearLeastSquareResults

Returns

bool

operator !=(NonLinearLeastSquareResults?, NonLinearLeastSquareResults?)

public static bool operator !=(NonLinearLeastSquareResults? left, NonLinearLeastSquareResults? right)

Parameters

left NonLinearLeastSquareResults

right NonLinearLeastSquareResults

Returns

bool