Vector.CreateSparseUnitVector<T> Method

Constructs a new sparse vector of the specified length.

Definition

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

public static SparseVector<T> CreateSparseUnitVector<T>(
	int length,
	int position,
	ArrayMutability mutability = ArrayMutability.Immutable
)

Visual Basic

Public Shared Function CreateSparseUnitVector(Of T) ( 
	length As Integer,
	position As Integer,
	Optional mutability As ArrayMutability = ArrayMutability.Immutable
) As SparseVector(Of T)

C++/CLI

public:
generic<typename T>
static SparseVector<T>^ CreateSparseUnitVector(
	int length, 
	int position, 
	ArrayMutability mutability = ArrayMutability::Immutable
)

static member CreateSparseUnitVector : 
        length : int * 
        position : int * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.Immutable
*)
-> SparseVector<'T>

Parameters

length Int32: The length of the SparseVector<T>.
position Int32: The position of the non-zero element of the unit vector.
mutability ArrayMutability (Optional): Specifies how the vector's values may be changed. The default is mutable values.

Type Parameters

T

Return Value

SparseVector<T>
A SparseVector<T>.

Exceptions

ArgumentOutOfRangeException

length is less than zero.

-or-

position is less than zero or greater than or equal to length.