This is documentation for an old release of Numerics.NET (version 8.1). Read this page in the documentation of the latest stable release (version 9.0).

Vector.Create Method

Definition

Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

Create<T>(T[])	Constructs a new vector with the specified elements.
Create<T>(Int32)	Constructs a new vector with the specified length.
Create<T>(IList<T>, ArrayMutability)	Constructs a new vector with the specified elements.
Create<T>(T[], Boolean, ArrayMutability)	Constructs a new dense vector with the specified elements.
Create<T>(Int32, ArraySlice<T>, ArrayMutability)	Constructs a new dense vector.
Create<T>(Int32, Func<Int32, T>, ArrayMutability)	Constructs a new dense vector.
Create<T>(Int32, T[], Boolean, ArrayMutability)	Constructs a new dense vector with the specified elements.
Create<T>(Int32, T[], Int32, Int32, ArrayMutability)	Constructs a new dense vector.
Create<T, K>(IDictionary<K, T>)	Creates an indexed vector from a dictionary.
Create<T, K>(IDictionary<K, T>, IList<K>)	Creates an indexed vector from a dictionary.
Create<T, K>(Int32, Index<K>)	Creates an indexed vector of the specified length with the specified index.
Create<T, K>(IList<T>, IList<K>, ArrayMutability)	Creates an indexed vector with the specified values and corresponding keys.

Create<T>(T[])

Constructs a new vector with the specified elements.

public static DenseVector<T> Create<T>(
	params T[] values
)

Visual Basic

Public Shared Function Create(Of T) ( 
	ParamArray values As T()
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Create(
	... array<T>^ values
)

static member Create : 
        values : 'T[] -> DenseVector<'T>

Parameters

values T[]: A variable length list of T parameters specifying the elements of the vector, or an array of values.

Type Parameters

T

Return Value

DenseVector<T>
A DenseVector<T>.

Remarks

The length of the new vector is equal to the length of values.

Exceptions

ArgumentNullException

values is null

Create<T, K>(IDictionary<K, T>)

Creates an indexed vector from a dictionary.

public static Vector<T> Create<T, K>(
	IDictionary<K, T> dictionary
)

Visual Basic

Public Shared Function Create(Of T, K) ( 
	dictionary As IDictionary(Of K, T)
) As Vector(Of T)

C++/CLI

public:
generic<typename T, typename K>
static Vector<T>^ Create(
	IDictionary<K, T>^ dictionary
)

static member Create : 
        dictionary : IDictionary<'K, 'T> -> Vector<'T>

Parameters

dictionary IDictionary<K, T>: A dictionary.

Type Parameters

T: The element type of the vector.
K: The type of the keys in the dictionary.

Return Value

Vector<T>
An indexed vector with key values of type K.

Create<T>(Int32)

Constructs a new vector with the specified length.

public static DenseVector<T> Create<T>(
	int length
)

Visual Basic

Public Shared Function Create(Of T) ( 
	length As Integer
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Create(
	int length
)

static member Create : 
        length : int -> DenseVector<'T>

Parameters

length Int32: The length of the new DenseVector<T>.

Type Parameters

T

Return Value

DenseVector<T>
A DenseVector<T>.

Remarks

The elements of the vector are set to zero.

Exceptions

ArgumentOutOfRangeException

length is less than zero.

Create<T, K>(IDictionary<K, T>, IList<K>)

Creates an indexed vector from a dictionary.

public static Vector<T> Create<T, K>(
	IDictionary<K, T> dictionary,
	IList<K> index
)

Visual Basic

Public Shared Function Create(Of T, K) ( 
	dictionary As IDictionary(Of K, T),
	index As IList(Of K)
) As Vector(Of T)

C++/CLI

public:
generic<typename T, typename K>
static Vector<T>^ Create(
	IDictionary<K, T>^ dictionary, 
	IList<K>^ index
)

static member Create : 
        dictionary : IDictionary<'K, 'T> * 
        index : IList<'K> -> Vector<'T>

Parameters

dictionary IDictionary<K, T>: A dictionary.
index IList<K>: An index.

Type Parameters

T: The element type of the vector.
K: The type of the keys in the dictionary.

Return Value

Vector<T>
An indexed vector with key values of type K.

Remarks

If any of the keys in index are not found in dictionary, a missing value is inserted.

Exceptions

ArgumentNullException

dictionary is null.

Create<T>(IList<T>, ArrayMutability)

Constructs a new vector with the specified elements.

public static DenseVector<T> Create<T>(
	IList<T> values,
	ArrayMutability mutability
)

Visual Basic

Public Shared Function Create(Of T) ( 
	values As IList(Of T),
	mutability As ArrayMutability
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Create(
	IList<T>^ values, 
	ArrayMutability mutability
)

static member Create : 
        values : IList<'T> * 
        mutability : ArrayMutability -> DenseVector<'T>

Parameters

values IList<T>: An IList<T> specifying the elements of the vector.
mutability ArrayMutability: Specifies how the vector's values may be changed. The default is mutable values.

Type Parameters

T

Return Value

DenseVector<T>
A DenseVector<T>.

Remarks

The length of the new vector is equal to the length of values. The elements are copied to a new array.

Exceptions

ArgumentNullException

values is null

Create<T, K>(Int32, Index<K>)

Creates an indexed vector of the specified length with the specified index.

public static Vector<T> Create<T, K>(
	int length,
	Index<K> index
)

Visual Basic

Public Shared Function Create(Of T, K) ( 
	length As Integer,
	index As Index(Of K)
) As Vector(Of T)

C++/CLI

public:
generic<typename T, typename K>
static Vector<T>^ Create(
	int length, 
	Index<K>^ index
)

static member Create : 
        length : int * 
        index : Index<'K> -> Vector<'T>

Parameters

length Int32: The length of the new vector.
index Index<K>: An index of values of type K.

Type Parameters

T: The element type of the vector.
K: The type of the keys of the index.

Return Value

Vector<T>
A vector of the specified lenght.

Create<T>(T[], Boolean, ArrayMutability)

Constructs a new dense vector with the specified elements.

public static DenseVector<T> Create<T>(
	T[] values,
	bool reuseComponentArray,
	ArrayMutability mutability = ArrayMutability.Immutable
)

Visual Basic

Public Shared Function Create(Of T) ( 
	values As T(),
	reuseComponentArray As Boolean,
	Optional mutability As ArrayMutability = ArrayMutability.Immutable
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Create(
	array<T>^ values, 
	bool reuseComponentArray, 
	ArrayMutability mutability = ArrayMutability::Immutable
)

static member Create : 
        values : 'T[] * 
        reuseComponentArray : bool * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.Immutable
*)
-> DenseVector<'T>

Parameters

values T[]: An array that contains the elements of the new DenseVector<T>.
reuseComponentArray Boolean: If true, the array referenced by values is used directly. Any changes to the elements of this DenseVector<T> will also affect the original array.If false, the elements are copied from values to a new array.
mutability ArrayMutability (Optional): Specifies how the vector's values may be changed. The default is mutable values.

Type Parameters

T

Return Value

DenseVector<T>
A DenseVector<T>.

Remarks

The length of the new vector is equal to the length of values.

Exceptions

ArgumentNullException

values is null

Create<T, K>(IList<T>, IList<K>, ArrayMutability)

Creates an indexed vector with the specified values and corresponding keys.

public static Vector<T> Create<T, K>(
	IList<T> values,
	IList<K> keys,
	ArrayMutability mutability = ArrayMutability.Immutable
)

Visual Basic

Public Shared Function Create(Of T, K) ( 
	values As IList(Of T),
	keys As IList(Of K),
	Optional mutability As ArrayMutability = ArrayMutability.Immutable
) As Vector(Of T)

C++/CLI

public:
generic<typename T, typename K>
static Vector<T>^ Create(
	IList<T>^ values, 
	IList<K>^ keys, 
	ArrayMutability mutability = ArrayMutability::Immutable
)

static member Create : 
        values : IList<'T> * 
        keys : IList<'K> * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.Immutable
*)
-> Vector<'T>

Parameters

values IList<T>: A list of values.
keys IList<K>: A list of keys.
mutability ArrayMutability (Optional): Specifies how the vector's values may be changed. The default is immutable.

Type Parameters

T: The element type of the vector.
K: The type of the keys.

Return Value

Vector<T>
A vector with elements specified by values and an index defined by keys.

Create<T>(Int32, ArraySlice<T>, ArrayMutability)

Constructs a new dense vector.

public static DenseVector<T> Create<T>(
	int length,
	ArraySlice<T> values,
	ArrayMutability mutability
)

Visual Basic

Public Shared Function Create(Of T) ( 
	length As Integer,
	values As ArraySlice(Of T),
	mutability As ArrayMutability
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Create(
	int length, 
	ArraySlice<T> values, 
	ArrayMutability mutability
)

static member Create : 
        length : int * 
        values : ArraySlice<'T> * 
        mutability : ArrayMutability -> DenseVector<'T>

Parameters

length Int32: The length of the vector.
values ArraySlice<T>: A strided structure containing the elements.
mutability ArrayMutability: Specifies how the vector's values may be changed.

Type Parameters

T

Return Value

DenseVector<T>
A DenseVector<T>.

Create<T>(Int32, Func<Int32, T>, ArrayMutability)

Constructs a new dense vector.

public static DenseVector<T> Create<T>(
	int length,
	Func<int, T> initializer,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function Create(Of T) ( 
	length As Integer,
	initializer As Func(Of Integer, T),
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Create(
	int length, 
	Func<int, T>^ initializer, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member Create : 
        length : int * 
        initializer : Func<int, 'T> * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> DenseVector<'T>

Parameters

length Int32: The length of the vector.
initializer Func<Int32, T>: A delegate that returns the value of a element given its index.
mutability ArrayMutability (Optional): Specifies how the vector's values may be changed. The default is mutable values.

Type Parameters

T

Return Value

DenseVector<T>
A DenseVector<T> whose elements are initialized using initializer.

Exceptions

ArgumentNullException	initializer is null
ArgumentOutOfRangeException	length is less than zero.

Create<T>(Int32, T[], Boolean, ArrayMutability)

Constructs a new dense vector with the specified elements.

public static DenseVector<T> Create<T>(
	int length,
	T[] values,
	bool reuseComponentArray,
	ArrayMutability mutability
)

Visual Basic

Public Shared Function Create(Of T) ( 
	length As Integer,
	values As T(),
	reuseComponentArray As Boolean,
	mutability As ArrayMutability
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Create(
	int length, 
	array<T>^ values, 
	bool reuseComponentArray, 
	ArrayMutability mutability
)

static member Create : 
        length : int * 
        values : 'T[] * 
        reuseComponentArray : bool * 
        mutability : ArrayMutability -> DenseVector<'T>

Parameters

length Int32: The number of elements in the new vector.
values T[]: An array that contains the elements of the new DenseVector<T>.
reuseComponentArray Boolean: If true, the array referenced by values is used directly. Any changes to the elements of this DenseVector<T> will also affect the original array. If false, the elements are copied from values to a new array.
mutability ArrayMutability: Specifies how the vector's values may be changed. The default is mutable values.

Type Parameters

T

Return Value

DenseVector<T>
A DenseVector<T>.

Exceptions

ArgumentNullException

values is null

ArgumentOutOfRangeException

length is less than zero.

-or-

The length of values is less than length.

Create<T>(Int32, T[], Int32, Int32, ArrayMutability)

Constructs a new dense vector.

public static DenseVector<T> Create<T>(
	int length,
	T[] values,
	int offset,
	int stride,
	ArrayMutability mutability
)

Visual Basic

Public Shared Function Create(Of T) ( 
	length As Integer,
	values As T(),
	offset As Integer,
	stride As Integer,
	mutability As ArrayMutability
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Create(
	int length, 
	array<T>^ values, 
	int offset, 
	int stride, 
	ArrayMutability mutability
)

static member Create : 
        length : int * 
        values : 'T[] * 
        offset : int * 
        stride : int * 
        mutability : ArrayMutability -> DenseVector<'T>

Parameters

length Int32: The length of the vector.
values T[]: A Double array that contains the elements.
offset Int32: The offset of the first element of the vector in values.
stride Int32: The stride between successive elements of the vector.
mutability ArrayMutability: Specifies how the vector's values may be changed.

Type Parameters

T

Return Value

DenseVector<T>
A DenseVector<T>.

Exceptions

ArgumentNullException

values is null

ArgumentOutOfRangeException

length is less than zero.

-or-

The length of values is less than length.

Vector.Create Method

Definition

Overload List

Create<T>(T[])

Parameters

Type Parameters

Return Value

Remarks

Exceptions

Create<T, K>(IDictionary<K, T>)

Parameters

Type Parameters

Return Value

Create<T>(Int32)

Parameters

Type Parameters

Return Value

Remarks

Exceptions

Create<T, K>(IDictionary<K, T>, IList<K>)

Parameters

Type Parameters

Return Value

Remarks

Exceptions

Create<T>(IList<T>, ArrayMutability)

Parameters

Type Parameters

Return Value

Remarks

Exceptions

Create<T, K>(Int32, Index<K>)

Parameters

Type Parameters

Return Value

Create<T>(T[], Boolean, ArrayMutability)

Parameters

Type Parameters

Return Value

Remarks

Exceptions

Create<T, K>(IList<T>, IList<K>, ArrayMutability)

Parameters

Type Parameters

Return Value

Create<T>(Int32, ArraySlice<T>, ArrayMutability)

Parameters

Type Parameters

Return Value

Create<T>(Int32, Func<Int32, T>, ArrayMutability)

Parameters

Type Parameters

Return Value

Exceptions

Create<T>(Int32, T[], Boolean, ArrayMutability)

Parameters

Type Parameters

Return Value

Exceptions

Create<T>(Int32, T[], Int32, Int32, ArrayMutability)

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference