Vector . Wrap Method

Remarks

The array referenced by source is used directly. Any changes to the elements of this DenseVector<T> will also affect the original array.

Exceptions

source is null.

Wrap<T>(Memory<T>, ArrayMutability, Boolean)

Constructs a new dense vector by wrapping a memory block without copying.

public static DenseVector<T> Wrap<T>(
	Memory<T> source,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Wrap(Of T) ( 
	source As Memory(Of T),
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Wrap(
	Memory<T> source, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

static member Wrap : 
        source : Memory<'T> * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseVector<'T>

Parameters

source Memory<T>: A memory block that contains the elements of the new DenseVector<T>.
mutability ArrayMutability (Optional): Specifies how the vector's values may be changed. The default is mutable values.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the vector should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

Wrap<T>(ArraySlice<T>, Int32, ArrayMutability, Boolean)

Constructs a new dense vector.

public static DenseVector<T> Wrap<T>(
	ArraySlice<T> source,
	int length,
	ArrayMutability mutability,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Wrap(Of T) ( 
	source As ArraySlice(Of T),
	length As Integer,
	mutability As ArrayMutability,
	Optional checkMissingValues As Boolean = false
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Wrap(
	ArraySlice<T> source, 
	int length, 
	ArrayMutability mutability, 
	bool checkMissingValues = false
)

static member Wrap : 
        source : ArraySlice<'T> * 
        length : int * 
        mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseVector<'T>

Parameters

source ArraySlice<T>: A strided structure containing the elements.
length Int32: The length of the vector.
mutability ArrayMutability: Specifies how the vector's values may be changed.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the vector should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

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

Constructs a new dense vector by wrapping a portion of an existing array without copying.

public static DenseVector<T> Wrap<T>(
	T[] source,
	int length,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Wrap(Of T) ( 
	source As T(),
	length As Integer,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Wrap(
	array<T>^ source, 
	int length, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

static member Wrap : 
        source : 'T[] * 
        length : int * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseVector<'T>

Parameters

source T[]: An array that contains the elements.
length Int32: The length of the vector.
mutability ArrayMutability (Optional): Specifies how the vector's values may be changed.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the vector should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

Exceptions

source is null.

length is less than zero.

-or-

The length of source is less than required for the specified parameters.

Wrap<T>(Memory<T>, Int32, ArrayMutability, Boolean)

Constructs a new dense vector by wrapping a portion of a memory block without copying.

public static DenseVector<T> Wrap<T>(
	Memory<T> source,
	int length,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Wrap(Of T) ( 
	source As Memory(Of T),
	length As Integer,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Wrap(
	Memory<T> source, 
	int length, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

static member Wrap : 
        source : Memory<'T> * 
        length : int * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseVector<'T>

Parameters

source Memory<T>: A memory block that contains the elements.
length Int32: The length of the vector.
mutability ArrayMutability (Optional): Specifies how the vector's values may be changed.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the vector should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

Exceptions

source is null.

length is less than zero.

-or-

The length of source is less than required for the specified parameters.

Wrap<T>(MemorySlice<T>, Int32, ArrayMutability, Boolean)

Constructs a new dense vector.

public static DenseVector<T> Wrap<T>(
	MemorySlice<T> values,
	int length,
	ArrayMutability mutability,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Wrap(Of T) ( 
	values As MemorySlice(Of T),
	length As Integer,
	mutability As ArrayMutability,
	Optional checkMissingValues As Boolean = false
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Wrap(
	MemorySlice<T> values, 
	int length, 
	ArrayMutability mutability, 
	bool checkMissingValues = false
)

static member Wrap : 
        values : MemorySlice<'T> * 
        length : int * 
        mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseVector<'T>

Parameters

values MemorySlice<T>: A strided structure containing the elements.
length Int32: The length of the vector.
mutability ArrayMutability: Specifies how the vector's values may be changed.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the vector should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

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

Constructs a new dense vector by wrapping a portion of an existing array without copying.

public static DenseVector<T> Wrap<T>(
	T[] source,
	int startIndex,
	int length,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Wrap(Of T) ( 
	source As T(),
	startIndex As Integer,
	length As Integer,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Wrap(
	array<T>^ source, 
	int startIndex, 
	int length, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

static member Wrap : 
        source : 'T[] * 
        startIndex : int * 
        length : int * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseVector<'T>

Parameters

source T[]: An array that contains the elements.
startIndex Int32: The offset of the first element of the vector in source.
length Int32: The length of the vector.
mutability ArrayMutability (Optional): Specifies how the vector's values may be changed.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the vector should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

Exceptions

source is null.

length is less than zero.

-or-

The length of source is less than required for the specified parameters.

Wrap<T>(Memory<T>, Int32, Int32, ArrayMutability, Boolean)

Constructs a new dense vector by wrapping a portion of a memory block without copying.

public static DenseVector<T> Wrap<T>(
	Memory<T> source,
	int startIndex,
	int length,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Wrap(Of T) ( 
	source As Memory(Of T),
	startIndex As Integer,
	length As Integer,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Wrap(
	Memory<T> source, 
	int startIndex, 
	int length, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

static member Wrap : 
        source : Memory<'T> * 
        startIndex : int * 
        length : int * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseVector<'T>

Parameters

source Memory<T>: A memory block that contains the elements.
startIndex Int32: The offset of the first element of the vector in source.
length Int32: The length of the vector.
mutability ArrayMutability (Optional): Specifies how the vector's values may be changed.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the vector should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

Exceptions

source is null.

length is less than zero.

-or-

The length of source is less than required for the specified parameters.

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

Constructs a new dense vector by wrapping a portion of an existing array without copying.

public static DenseVector<T> Wrap<T>(
	T[] source,
	int startIndex,
	int length,
	int stride,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Wrap(Of T) ( 
	source As T(),
	startIndex As Integer,
	length As Integer,
	stride As Integer,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Wrap(
	array<T>^ source, 
	int startIndex, 
	int length, 
	int stride, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

static member Wrap : 
        source : 'T[] * 
        startIndex : int * 
        length : int * 
        stride : int * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseVector<'T>

Parameters

source T[]: An array that contains the elements.
startIndex Int32: The offset of the first element of the vector in source.
length Int32: The length of the vector.
stride Int32: The stride between successive elements of the vector.
mutability ArrayMutability (Optional): Specifies how the vector's values may be changed.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the vector should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

Exceptions

source is null.

length is less than zero.

-or-

The length of source is less than required for the specified parameters.

Wrap<T>(Memory<T>, Int32, Int32, Int32, ArrayMutability, Boolean)

Constructs a new dense vector by wrapping a portion of a memory block without copying.

public static DenseVector<T> Wrap<T>(
	Memory<T> source,
	int startIndex,
	int length,
	int stride = 1,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Wrap(Of T) ( 
	source As Memory(Of T),
	startIndex As Integer,
	length As Integer,
	Optional stride As Integer = 1,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseVector(Of T)

C++/CLI

public:
generic<typename T>
static DenseVector<T>^ Wrap(
	Memory<T> source, 
	int startIndex, 
	int length, 
	int stride = 1, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

static member Wrap : 
        source : Memory<'T> * 
        startIndex : int * 
        length : int * 
        ?stride : int * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _stride = defaultArg stride 1
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseVector<'T>

Parameters

source Memory<T>: A memory block that contains the elements.
startIndex Int32: The offset of the first element of the vector in source.
length Int32: The length of the vector.
stride Int32 (Optional): The stride between successive elements of the vector.
mutability ArrayMutability (Optional): Specifies how the vector's values may be changed.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the vector should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

Exceptions

source is null.