Struct BiCGStabResult

Namespace

NanoQL.Numerics

Assembly

NanoQL.dll

BiCGstab's solution: the number of iterations, the relative residual and the solution.

public readonly struct BiCGStabResult : IEquatable<BiCGStabResult>

Implements

IEquatable<BiCGStabResult>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

BiCGStabResult(int, double, Vector)

BiCGstab's solution: the number of iterations, the relative residual and the solution.

public BiCGStabResult(int Iterations, double Error, Vector X)

Parameters

Iterations int

The number of iterations.

Error double

The residual's norm relative to the right-hand side's.

X Vector

The solution.

Properties

Error

The residual's norm relative to the right-hand side's.

public double Error { get; init; }

Property Value

double

Iterations

The number of iterations.

public int Iterations { get; init; }

Property Value

int

X

The solution.

public Vector X { get; init; }

Property Value

Vector

Methods

Deconstruct(out int, out double, out Vector)

public void Deconstruct(out int Iterations, out double Error, out Vector X)

Parameters

Iterations int

Error double

X Vector

Equals(BiCGStabResult)

public bool Equals(BiCGStabResult other)

Parameters

other BiCGStabResult

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 ==(BiCGStabResult, BiCGStabResult)

public static bool operator ==(BiCGStabResult left, BiCGStabResult right)

Parameters

left BiCGStabResult

right BiCGStabResult

Returns

bool

operator !=(BiCGStabResult, BiCGStabResult)

public static bool operator !=(BiCGStabResult left, BiCGStabResult right)

Parameters

left BiCGStabResult

right BiCGStabResult

Returns

bool