Class DenseMatrix<T>

A square matrix using a dense representation.

Inheritance
object
DenseMatrix<T>
Implements
Inherited Members
Namespace: SpiceSharp.Algebra
Assembly: SpiceSharp.dll
Syntax
public class DenseMatrix<T> : IMatrix<T>
Type Parameters
Name Description
T

The base value type.

Constructors

DenseMatrix()

Initializes a new instance of the DenseMatrix<T> class.

Declaration
public DenseMatrix()

DenseMatrix(int)

Initializes a new instance of the DenseMatrix<T> class.

Declaration
public DenseMatrix(int size)
Parameters
Type Name Description
int size

The matrix size.
Exceptions
Type Condition
ArgumentOutOfRangeException

Thrown if size is negative.

Properties

this[MatrixLocation]

Gets or sets the value at the specified location.

Declaration
public T this[MatrixLocation location] { get; set; }
Parameters
Type Name Description
MatrixLocation location

The location.
Property Value
Type Description
T

The value.

this[int, int]

Gets or sets the value at the specified row and column.

Declaration
public T this[int row, int column] { get; set; }
Parameters
Type Name Description
int row

The row index.
int column

The column index.
Property Value
Type Description
T

The value.
Exceptions
Type Condition
ArgumentOutOfRangeException

Thrown if row or column is not positive.

Size

Gets the size of the matrix.

Declaration
public int Size { get; }
Property Value
Type Description
int

The matrix size.

Methods

Clear()

Clears the matrix of any elements. The size of the matrix becomes 0.

Declaration
public void Clear()

Reset()

Resets all elements in the matrix to their default value.

Declaration
public void Reset()

SwapColumns(int, int)

Swaps two columns in the matrix.

Declaration
public void SwapColumns(int column1, int column2)
Parameters
Type Name Description
int column1

The first column index.
int column2

The second column index.
Exceptions
Type Condition
ArgumentOutOfRangeException

Thrown if column1 or column2 is not greater than 0.

SwapRows(int, int)

Swaps two rows in the matrix.

Declaration
public void SwapRows(int row1, int row2)
Parameters
Type Name Description
int row1

The first row index.
int row2

The second row index.
Exceptions
Type Condition
ArgumentOutOfRangeException

Thrown if row1 or row2 is not greater than 0.

ToString()

Returns a string that represents this instance.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents this instance.
Overrides

Implements

Extension Methods

See Also