Class SparseMatrix<T>.Column

A class that keeps track of a linked list of matrix elements for a column.

Inheritance

object

SparseMatrix<T>.Column

Inherited Members

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

protected class SparseMatrix<T>.Column

Properties

FirstInColumn

Gets the first element in the column.

Declaration

public SparseMatrix<T>.Element FirstInColumn { get; }

Property Value

Type	Description
SparseMatrix<T>.Element	The first element in the column.

LastInColumn

Gets the last element in the column.

Declaration

public SparseMatrix<T>.Element LastInColumn { get; }

Property Value

Type	Description
SparseMatrix<T>.Element	The last element in the column.

Methods

Clear()

Clears all matrix elements in the column.

Declaration

public void Clear()

Insert(Element)

Insert an element in the column. This method assumes an element does not exist at its indices!

Declaration

public void Insert(SparseMatrix<T>.Element newElement)

Parameters

Type	Name	Description
SparseMatrix<T>.Element	newElement	The new element to insert.

Exceptions

Type	Condition
ArgumentNullException	Thrown if newElement is null.

Remove(Element)

Remove an element from the column.

Declaration

public void Remove(SparseMatrix<T>.Element element)

Parameters

Type	Name	Description
SparseMatrix<T>.Element	element	The element to be removed.

Swap(Element, Element, int, int)

Swap two elements in the row, first and rowFirst are supposed to come first in the row. Does not update row pointers!

Declaration

public void Swap(SparseMatrix<T>.Element first, SparseMatrix<T>.Element second, int rowFirst, int rowSecond)

Parameters

Type	Name	Description
SparseMatrix<T>.Element	first	The first matrix element.
SparseMatrix<T>.Element	second	The second matrix element.
int	rowFirst	The first row.
int	rowSecond	The second row.

Exceptions

Type	Condition
ArgumentNullException	Thrown if both first and second are null.

Extension Methods

Utility.ThrowIfNull<T>(T, string)