Show / Hide Table of Contents

Class SparseComplexSolver

Class for solving real matrices

Inheritance
object
ParameterSet
ParameterSetCollection
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>
SparseLUSolver<Complex>
SparseComplexSolver
Implements
ISparsePivotingSolver<Complex>
ISparseSolver<Complex>
IPivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>
ISolver<Complex>
IParameterSetCollection
IParameterSet
IParameterized<Markowitz<Complex>>
Inherited Members
SparseLUSolver<Complex>.Fillins
SparseLUSolver<Complex>.Parameters
SparseLUSolver<Complex>.Precondition(PreconditioningMethod<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>)
SparseLUSolver<Complex>.Factor()
SparseLUSolver<Complex>.OrderAndFactor()
SparseLUSolver<Complex>.FindDiagonalElement(int)
SparseLUSolver<Complex>.FindElement(MatrixLocation)
SparseLUSolver<Complex>.FindElement(int)
SparseLUSolver<Complex>.GetElement(MatrixLocation)
SparseLUSolver<Complex>.RemoveElement(MatrixLocation)
SparseLUSolver<Complex>.GetElement(int)
SparseLUSolver<Complex>.RemoveElement(int)
SparseLUSolver<Complex>.MovePivot(ISparseMatrixElement<Complex>, int)
SparseLUSolver<Complex>.CreateFillin(MatrixLocation)
SparseLUSolver<Complex>.Clear()
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.IsFactored
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.NeedsReordering
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.Size
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.this[int, int]
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.this[MatrixLocation]
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.this[int]
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.Row
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.Column
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.Matrix
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.Vector
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.Precondition(PreconditioningMethod<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.SwapRows(int, int)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.SwapColumns(int, int)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.Reset()
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.Clear()
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.ExternalToInternal(MatrixLocation)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.InternalToExternal(MatrixLocation)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.ToString()
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.Factor()
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.OrderAndFactor()
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.SetParameter<P>(string, P)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.ForwardSubstitute(IVector<Complex>)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.BackwardSubstitute(IVector<Complex>)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.ComputeDegenerateContribution(int)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.ForwardSubstituteTransposed(IVector<Complex>)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.BackwardSubstituteTransposed(IVector<Complex>)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.ComputeDegenerateContributionTransposed(int)
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.Degeneracy
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.PivotSearchReduction
ParameterSetCollection.GetParameterSet<P>()
ParameterSetCollection.TryGetParameterSet<P>(out P)
ParameterSetCollection.ParameterSets
ParameterSetCollection.SetParameter<P>(string, P)
ParameterSetCollection.TrySetParameter<P>(string, P)
ParameterSetCollection.GetProperty<P>(string)
ParameterSetCollection.TryGetProperty<P>(string, out P)
ParameterSetCollection.CreateParameterSetter<P>(string)
ParameterSetCollection.CreatePropertyGetter<P>(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: SpiceSharp.Algebra
Assembly: SpiceSharp.dll
Syntax
public class SparseComplexSolver : SparseLUSolver<Complex>, ISparsePivotingSolver<Complex>, ISparseSolver<Complex>, IPivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>, ISolver<Complex>, IParameterSetCollection, IParameterSet, IParameterized<Markowitz<Complex>>

Constructors

SparseComplexSolver()

Initializes a new instance of the SparseComplexSolver class.

Declaration
public SparseComplexSolver()

Methods

BackwardSubstitute(IVector<Complex>)

Applies backward substitution on a factored matrix and the intermediate vector.

Declaration
public override void BackwardSubstitute(IVector<Complex> solution)
Parameters
Type Name Description
IVector<Complex> solution

The solution vector.

Overrides
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.BackwardSubstitute(IVector<Complex>)

BackwardSubstituteTransposed(IVector<Complex>)

Applies backward substitution on the adjoint matrix and the intermediate vector.

Declaration
public override void BackwardSubstituteTransposed(IVector<Complex> solution)
Parameters
Type Name Description
IVector<Complex> solution

The solution vector.

Overrides
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.BackwardSubstituteTransposed(IVector<Complex>)

ComputeDegenerateContribution(int)

Computes a contribution for degenerate solvers (Degeneracy is larger than 0). Used when solving submatrices separately.

Declaration
public override Complex ComputeDegenerateContribution(int index)
Parameters
Type Name Description
int index

The index.

Returns
Type Description
Complex

Returns the contribution.

Overrides
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.ComputeDegenerateContribution(int)

ComputeDegenerateContributionTransposed(int)

Computes a contribution of the transposed solving for degenerate solvers (Degeneracy is larger than 0). Used when solving submatrices separately.

Declaration
public override Complex ComputeDegenerateContributionTransposed(int index)
Parameters
Type Name Description
int index

The index.

Returns
Type Description
Complex

Returns the contribution.

Overrides
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.ComputeDegenerateContributionTransposed(int)

Eliminate(ISparseMatrixElement<Complex>)

Eliminates the matrix right and below the pivot.

Declaration
protected override void Eliminate(ISparseMatrixElement<Complex> pivot)
Parameters
Type Name Description
ISparseMatrixElement<Complex> pivot

The pivot element.

Overrides
SparseLUSolver<Complex>.Eliminate(ISparseMatrixElement<Complex>)
Exceptions
Type Condition
AlgebraException

Thrown if the pivot is null or has a magnitude of zero.

ForwardSubstitute(IVector<Complex>)

Applies forward substitution on a factored matrix and right-hand side vector.

Declaration
public override void ForwardSubstitute(IVector<Complex> solution)
Parameters
Type Name Description
IVector<Complex> solution

The solution vector.

Overrides
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.ForwardSubstitute(IVector<Complex>)
Exceptions
Type Condition
ArgumentNullException

Thrown if solution is null.

AlgebraException

Thrown if the solver is not factored yet.

ArgumentException

Thrown if solution does not have Size elements.

ForwardSubstituteTransposed(IVector<Complex>)

Applies forward substitution on the adjoint matrix and right-hand side vector.

Declaration
public override void ForwardSubstituteTransposed(IVector<Complex> solution)
Parameters
Type Name Description
IVector<Complex> solution

The solution vector.

Overrides
PivotingSolver<ISparseMatrix<Complex>, ISparseVector<Complex>, Complex>.ForwardSubstituteTransposed(IVector<Complex>)
Exceptions
Type Condition
ArgumentNullException

Thrown if solution is null.

AlgebraException

Thrown if the solver is not factored yet.

ArgumentException

Thrown if solution does not have Size elements.

Implements

ISparsePivotingSolver<T>
ISparseSolver<T>
IPivotingSolver<M, V, T>
ISolver<T>
IParameterSetCollection
IParameterSet
IParameterized<P>

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

SparseLUSolver<T>
In this article
Back to top Generated by DocFX