Interface ISparseSolver<T>

An ISolver<T> that uses sparse elements internally.

Inherited Members

ISolver<T>.Degeneracy

ISolver<T>.Size

ISolver<T>.IsFactored

ISolver<T>.this[int, int]

ISolver<T>.this[MatrixLocation]

ISolver<T>.this[int]

ISolver<T>.ForwardSubstitute(IVector<T>)

ISolver<T>.BackwardSubstitute(IVector<T>)

ISolver<T>.ComputeDegenerateContribution(int)

ISolver<T>.ForwardSubstituteTransposed(IVector<T>)

ISolver<T>.BackwardSubstituteTransposed(IVector<T>)

ISolver<T>.ComputeDegenerateContributionTransposed(int)

ISolver<T>.Factor()

ISolver<T>.Reset()

ISolver<T>.Clear()

IParameterSetCollection.GetParameterSet<P>()

IParameterSetCollection.TryGetParameterSet<P>(out P)

IParameterSetCollection.ParameterSets

IParameterSet.SetParameter<P>(string, P)

IParameterSet.TrySetParameter<P>(string, P)

IParameterSet.GetProperty<P>(string)

IParameterSet.TryGetProperty<P>(string, out P)

IParameterSet.CreateParameterSetter<P>(string)

IParameterSet.CreatePropertyGetter<P>(string)

Namespace: SpiceSharp.Algebra

Assembly: SpiceSharp.dll

Syntax

public interface ISparseSolver<T> : ISolver<T>, IParameterSetCollection, IParameterSet

Type Parameters

Name	Description
T	The base value type.

Methods

FindElement(MatrixLocation)

Finds the element at the specified location in the matrix.

Declaration

Element<T> FindElement(MatrixLocation location)

Parameters

Type	Name	Description
MatrixLocation	location	The location.

Returns

Type	Description
Element<T>	The element if it exists; otherwise null.

FindElement(int)

Finds the element at the specified position in the right-hand side vector.

Declaration

Element<T> FindElement(int row)

Parameters

Type	Name	Description
int	row	The row index.

Returns

Type	Description
Element<T>	The element if it exists; otherwise null.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown if row is negative.

GetElement(MatrixLocation)

Gets the element at the specified location in the matrix. A new element is created if it doesn't exist yet.

Declaration

Element<T> GetElement(MatrixLocation location)

Parameters

Type	Name	Description
MatrixLocation	location	The location.

Returns

Type	Description
Element<T>	The matrix element.

GetElement(int)

Gets the element at the specified position in the right-hand side vector. A new element is created if it doesn't exist yet.

Declaration

Element<T> GetElement(int row)

Parameters

Type	Name	Description
int	row	The row.

Returns

Type	Description
Element<T>	The vector element.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown if row is negative.

RemoveElement(MatrixLocation)

Removes a matrix element at the specified location.

Declaration

bool RemoveElement(MatrixLocation location)

Parameters

Type	Name	Description
MatrixLocation	location	The location.

Returns

Type	Description
bool	true if the element was removed; otherwise, false.

RemoveElement(int)

Removes a right-hand side vector element.

Declaration

bool RemoveElement(int row)

Parameters

Type	Name	Description
int	row	The row.

Returns

Type	Description
bool	true if the element was removed; otherwise, false.

Extension Methods

Utility.ThrowIfNull<T>(T, string)

Documentation.ParameterValues<T>(IParameterSet, bool)

Documentation.Parameters(IParameterSet)

Documentation.ParameterValues<T>(IParameterSetCollection, bool)

Documentation.Parameters(IParameterSetCollection)

See Also

ISolver<T>