Struct JacobianInfo

Information for filling in the Jacobian matrix and right-hand-side vector.

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SpiceSharp.Simulations

Assembly: SpiceSharp.dll

Syntax

public readonly struct JacobianInfo

Constructors

JacobianInfo(double, double)

Initializes a new instance of the JacobianInfo struct.

Declaration

public JacobianInfo(double jacobian, double rhs)

Parameters

Type	Name	Description
double	jacobian	The jacobian.
double	rhs	The right-hand-side value.

Properties

Jacobian

Gets the jacobian.

Declaration

public double Jacobian { get; }

Property Value

Type	Description
double	The jacobian.

Rhs

Gets the right-hand-side value.

Declaration

public double Rhs { get; }

Property Value

Type	Description
double	The right-hand-side value.

Methods

Equals(object)

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

Declaration

public override 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 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 ==(JacobianInfo, JacobianInfo)

Implements the operator ==.

Declaration

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

Parameters

Type	Name	Description
JacobianInfo	left	The left.
JacobianInfo	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator !=(JacobianInfo, JacobianInfo)

Implements the operator !=.

Declaration

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

Parameters

Type	Name	Description
JacobianInfo	left	The left.
JacobianInfo	right	The right.

Returns

Type	Description
bool	The result of the operator.

Extension Methods

Utility.ThrowIfNull<T>(T, string)