Matrix.Identity<T> Method

Creates an identity matrix of the specified dimension.

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.0.0

public static Matrix<T> Identity<T>(
	int dimension,
	MatrixStructure structure = MatrixStructure.General
)

Visual Basic

Public Shared Function Identity(Of T) ( 
	dimension As Integer,
	Optional structure As MatrixStructure = MatrixStructure.General
) As Matrix(Of T)

C++/CLI

public:
generic<typename T>
static Matrix<T>^ Identity(
	int dimension, 
	MatrixStructure structure = MatrixStructure::General
)

static member Identity : 
        dimension : int * 
        ?structure : MatrixStructure 
(* Defaults:
        let _structure = defaultArg structure MatrixStructure.General
*)
-> Matrix<'T>

Parameters

dimension Int32: The number of rows and columns in the identity matrix.
structure MatrixStructure (Optional): Optional. A MatrixStructure value that specifies the structure of the matrix. The default is a full, dense matrix.

Type Parameters

T: The element type of the matrix.

Return Value

Matrix<T>
A matrix with dimension rows and columns that has ones on the main diagonal and is zero everywhere else.

Exceptions

ArgumentOutOfRangeException

dimension is less than or equal to zero.