Struct Pivot<P>

Describes a pivot for reordering solvers.

Implements

IEquatable<Pivot<P>>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SpiceSharp.Algebra.Solve

Assembly: SpiceSharp.dll

Syntax

public struct Pivot<P> : IEquatable<Pivot<P>>

Type Parameters

Name	Description
P	The pivot output.

Constructors

Pivot(P, PivotInfo)

Initializes a new instance of the Pivot<P> struct.

Declaration

public Pivot(P element, PivotInfo info)

Parameters

Type	Name	Description
P	element	The pivot.
PivotInfo	info	The information.

Fields

Element

The pivot.

Declaration

public readonly P Element

Field Value

Type	Description
P

Empty

No pivot.

Declaration

public static Pivot<P> Empty

Field Value

Type	Description
Pivot<P>

Info

The information about the pivot.

Declaration

public readonly PivotInfo Info

Field Value

Type	Description
PivotInfo

Methods

Equals(Pivot<P>)

Equalses the specified pivot.

Declaration

public readonly bool Equals(Pivot<P> pivot)

Parameters

Type	Name	Description
Pivot<P>	pivot	The pivot.

Returns

Type	Description
bool	true if the pivots are the equal; otherwise false.

Equals(object)

Determines whether the specified object, is equal to this instance.

Declaration

public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with this instance.

Returns

Type	Description
bool	true if the specified object is equal to this instance; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns a hash code for this instance.

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

ValueType.GetHashCode()

Operators

operator ==(Pivot<P>, Pivot<P>)

Implements the operator ==.

Declaration

public static bool operator ==(Pivot<P> left, Pivot<P> right)

Parameters

Type	Name	Description
Pivot<P>	left	The left.
Pivot<P>	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator !=(Pivot<P>, Pivot<P>)

Implements the operator !=.

Declaration

public static bool operator !=(Pivot<P> left, Pivot<P> right)

Parameters

Type	Name	Description
Pivot<P>	left	The left.
Pivot<P>	right	The right.

Returns

Type	Description
bool	The result of the operator.

Implements

IEquatable<T>

Extension Methods

Utility.ThrowIfNull<T>(T, string)

See Also

IEquatable<T>