Matrix.Create Method

Definition

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

Constructs a new matrix.

Overload List

Create<T>(T[,], ArrayMutability)	Constructs a new matrix from a two-dimensional array. Obsolete
Create<T>(Int32, Int32)	Constructs a new matrix with the specified number of rows and columns Obsolete
Create<T>(IEnumerable<T[]>, MatrixElementOrder, ArrayMutability, Boolean)	Constructs a new matrix from a jagged array. Obsolete
Create<T>(Int32, Int32, MatrixElementOrder, Boolean)	Constructs a new matrix with the specified number of rows and columns Obsolete
Create<T>(Int32, Int32, Func<Int32, Int32, T>, ArrayMutability, Boolean)	Creates a new matrix initialized using a function. Obsolete
Create<T>(Int32, Int32, Array2D<T>, MatrixElementOrder, ArrayMutability, Boolean)	Constructs a new matrix.
Create<T>(Int32, Int32, Memory2D<T>, MatrixElementOrder, ArrayMutability, Boolean)	Constructs a new matrix.
Create<T>(Int32, Int32, T[], MatrixElementOrder, Boolean, ArrayMutability, Boolean)	Constructs a new matrix of the specified dimensions using the specified values array. Obsolete
Create<T>(Int32, Int32, T[], Int32, Int32, MatrixElementOrder, ArrayMutability, Boolean)	Constructs a new matrix.

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

Note: This API is now obsolete.

Constructs a new matrix from a two-dimensional array.

[ObsoleteAttribute("Use Matrix.CopyFrom(source, mutability) instead.")]
public static DenseMatrix<T> Create<T>(
	T[,] values,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

<ObsoleteAttribute("Use Matrix.CopyFrom(source, mutability) instead.")>
Public Shared Function Create(Of T) ( 
	values As T(,),
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As DenseMatrix(Of T)

C++/CLI

public:
[ObsoleteAttribute(L"Use Matrix.CopyFrom(source, mutability) instead.")]
generic<typename T>
static DenseMatrix<T>^ Create(
	array<T,2>^ values, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

[<ObsoleteAttribute("Use Matrix.CopyFrom(source, mutability) instead.")>]
static member Create : 
        values : 'T[,] * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> DenseMatrix<'T>

Parameters

values T[2]: A two-dimensional array of values. The first dimension enumerates the rows. The second dimension enumerates the columns.
mutability ArrayMutability (Optional): Specifies how the matrix's values may be changed. The default is mutable values.

Type Parameters

T

Return Value

DenseMatrix<T>
A DenseMatrix<T>.

Remarks

The values of the matrix are stored in row-major order.

Exceptions

ArgumentNullException

values is null.

Create<T>(Int32, Int32)

Note: This API is now obsolete.

Constructs a new matrix with the specified number of rows and columns

[ObsoleteAttribute("Use Matrix.Zeros<T>(rowCount, columnCount) instead.")]
public static DenseMatrix<T> Create<T>(
	int rowCount,
	int columnCount
)

Visual Basic

<ObsoleteAttribute("Use Matrix.Zeros<T>(rowCount, columnCount) instead.")>
Public Shared Function Create(Of T) ( 
	rowCount As Integer,
	columnCount As Integer
) As DenseMatrix(Of T)

C++/CLI

public:
[ObsoleteAttribute(L"Use Matrix.Zeros<T>(rowCount, columnCount) instead.")]
generic<typename T>
static DenseMatrix<T>^ Create(
	int rowCount, 
	int columnCount
)

[<ObsoleteAttribute("Use Matrix.Zeros<T>(rowCount, columnCount) instead.")>]
static member Create : 
        rowCount : int * 
        columnCount : int -> DenseMatrix<'T>

Parameters

rowCount Int32: The number of rows in the new matrix.
columnCount Int32: The number of columns in the new matrix.

Type Parameters

T

Return Value

DenseMatrix<T>
A DenseMatrix<T>.

Exceptions

ArgumentOutOfRangeException

rowCount is less than zero.

-or-

columnCount is less than zero.

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

Note: This API is now obsolete.

Constructs a new matrix from a jagged array.

[ObsoleteAttribute("Use Matrix.FromRows(values, ...) or Matrix.FromColumns(values, ...) instead depending on the order parameter.")]
public static DenseMatrix<T> Create<T>(
	IEnumerable<T[]> values,
	MatrixElementOrder order = MatrixElementOrder.RowMajor,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

<ObsoleteAttribute("Use Matrix.FromRows(values, ...) or Matrix.FromColumns(values, ...) instead depending on the order parameter.")>
Public Shared Function Create(Of T) ( 
	values As IEnumerable(Of T()),
	Optional order As MatrixElementOrder = MatrixElementOrder.RowMajor,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseMatrix(Of T)

C++/CLI

public:
[ObsoleteAttribute(L"Use Matrix.FromRows(values, ...) or Matrix.FromColumns(values, ...) instead depending on the order parameter.")]
generic<typename T>
static DenseMatrix<T>^ Create(
	IEnumerable<array<T>^>^ values, 
	MatrixElementOrder order = MatrixElementOrder::RowMajor, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

[<ObsoleteAttribute("Use Matrix.FromRows(values, ...) or Matrix.FromColumns(values, ...) instead depending on the order parameter.")>]
static member Create : 
        values : IEnumerable<'T[]> * 
        ?order : MatrixElementOrder * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _order = defaultArg order MatrixElementOrder.RowMajor
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseMatrix<'T>

Parameters

values IEnumerable<T[]>: A jagged array or enumerable list of arrays of values.
order MatrixElementOrder (Optional): Specifies whether values contains the rows or columns of the matrix.
mutability ArrayMutability (Optional): Specifies how the matrix's values may be changed. The default is mutable values.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the matrix should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

DenseMatrix<T>
A DenseMatrix<T>.

Remarks

The values of the matrix are stored in row-major order.

Exceptions

ArgumentNullException

values is null.

Create<T>(Int32, Int32, MatrixElementOrder, Boolean)

Note: This API is now obsolete.

Constructs a new matrix with the specified number of rows and columns

[ObsoleteAttribute("Use Matrix.Zeros<T>(rowCount, columnCount, elementOrder, checkMissingValues) instead.")]
public static DenseMatrix<T> Create<T>(
	int rowCount,
	int columnCount,
	MatrixElementOrder elementOrder,
	bool checkMissingValues = false
)

Visual Basic

<ObsoleteAttribute("Use Matrix.Zeros<T>(rowCount, columnCount, elementOrder, checkMissingValues) instead.")>
Public Shared Function Create(Of T) ( 
	rowCount As Integer,
	columnCount As Integer,
	elementOrder As MatrixElementOrder,
	Optional checkMissingValues As Boolean = false
) As DenseMatrix(Of T)

C++/CLI

public:
[ObsoleteAttribute(L"Use Matrix.Zeros<T>(rowCount, columnCount, elementOrder, checkMissingValues) instead.")]
generic<typename T>
static DenseMatrix<T>^ Create(
	int rowCount, 
	int columnCount, 
	MatrixElementOrder elementOrder, 
	bool checkMissingValues = false
)

[<ObsoleteAttribute("Use Matrix.Zeros<T>(rowCount, columnCount, elementOrder, checkMissingValues) instead.")>]
static member Create : 
        rowCount : int * 
        columnCount : int * 
        elementOrder : MatrixElementOrder * 
        ?checkMissingValues : bool 
(* Defaults:
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseMatrix<'T>

Parameters

rowCount Int32: The number of rows in the new matrix.
columnCount Int32: The number of columns in the new matrix.
elementOrder MatrixElementOrder: A MatrixElementOrder value that specifies the order in which the matrix components are stored in the storage array.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the matrix should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

DenseMatrix<T>
A DenseMatrix<T>.

Exceptions

ArgumentOutOfRangeException

rowCount is less than zero.

-or-

columnCount is less than zero.

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

Note: This API is now obsolete.

Creates a new matrix initialized using a function.

[ObsoleteAttribute("Use Matrix.FromFunction<T>(rowCount, columnCount, initializer, mutability, checkMissingValues) instead.")]
public static DenseMatrix<T> Create<T>(
	int rowCount,
	int columnCount,
	Func<int, int, T> initializer,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

<ObsoleteAttribute("Use Matrix.FromFunction<T>(rowCount, columnCount, initializer, mutability, checkMissingValues) instead.")>
Public Shared Function Create(Of T) ( 
	rowCount As Integer,
	columnCount As Integer,
	initializer As Func(Of Integer, Integer, T),
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseMatrix(Of T)

C++/CLI

public:
[ObsoleteAttribute(L"Use Matrix.FromFunction<T>(rowCount, columnCount, initializer, mutability, checkMissingValues) instead.")]
generic<typename T>
static DenseMatrix<T>^ Create(
	int rowCount, 
	int columnCount, 
	Func<int, int, T>^ initializer, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

[<ObsoleteAttribute("Use Matrix.FromFunction<T>(rowCount, columnCount, initializer, mutability, checkMissingValues) instead.")>]
static member Create : 
        rowCount : int * 
        columnCount : int * 
        initializer : Func<int, int, 'T> * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseMatrix<'T>

Parameters

rowCount Int32: The number of rows in the new matrix.
columnCount Int32: The number of columns in the new matrix.
initializer Func<Int32, Int32, T>: A delegate that takes a row and column index and returns the value of the corresponding element.
mutability ArrayMutability (Optional): Specifies how the matrix's values may be changed. The default is mutable values.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the matrix should check for the presence of missing values. The default is false.

Type Parameters

T: The element type of the matrix.

Return Value

DenseMatrix<T>
A new DenseMatrix<T> initialized using the specified function.

Exceptions

ArgumentOutOfRangeException	rowCount or columnCount is less than zero.
ArgumentNullException	initializer is null.

Create<T>(Int32, Int32, Array2D<T>, MatrixElementOrder, ArrayMutability, Boolean)

Constructs a new matrix.

public static DenseMatrix<T> Create<T>(
	int rowCount,
	int columnCount,
	Array2D<T> values,
	MatrixElementOrder elementOrder,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Create(Of T) ( 
	rowCount As Integer,
	columnCount As Integer,
	values As Array2D(Of T),
	elementOrder As MatrixElementOrder,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseMatrix(Of T)

C++/CLI

public:
generic<typename T>
static DenseMatrix<T>^ Create(
	int rowCount, 
	int columnCount, 
	Array2D<T> values, 
	MatrixElementOrder elementOrder, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

static member Create : 
        rowCount : int * 
        columnCount : int * 
        values : Array2D<'T> * 
        elementOrder : MatrixElementOrder * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseMatrix<'T>

Parameters

rowCount Int32: The number of rows in the matrix.
columnCount Int32: The number of columns in the matrix.
values Array2D<T>: A strided array that contains the values of the matrix.
elementOrder MatrixElementOrder: A MatrixElementOrder value that indicates whether rows or columns are stored contiguously.
mutability ArrayMutability (Optional): Specifies how the matrix's values may be changed. The default is mutable values.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the matrix should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

DenseMatrix<T>
A DenseMatrix<T>.

Create<T>(Int32, Int32, Memory2D<T>, MatrixElementOrder, ArrayMutability, Boolean)

Constructs a new matrix.

public static DenseMatrix<T> Create<T>(
	int rowCount,
	int columnCount,
	Memory2D<T> values,
	MatrixElementOrder elementOrder,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Create(Of T) ( 
	rowCount As Integer,
	columnCount As Integer,
	values As Memory2D(Of T),
	elementOrder As MatrixElementOrder,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseMatrix(Of T)

C++/CLI

public:
generic<typename T>
static DenseMatrix<T>^ Create(
	int rowCount, 
	int columnCount, 
	Memory2D<T> values, 
	MatrixElementOrder elementOrder, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

static member Create : 
        rowCount : int * 
        columnCount : int * 
        values : Memory2D<'T> * 
        elementOrder : MatrixElementOrder * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseMatrix<'T>

Parameters

rowCount Int32: The number of rows in the matrix.
columnCount Int32: The number of columns in the matrix.
values Memory2D<T>: A 2D memory block that contains the values of the matrix.
elementOrder MatrixElementOrder: A MatrixElementOrder value that indicates whether rows or columns are stored contiguously.
mutability ArrayMutability (Optional): Specifies how the matrix's values may be changed. The default is mutable values.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the matrix should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

DenseMatrix<T>
A DenseMatrix<T>.

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

Note: This API is now obsolete.

Constructs a new matrix of the specified dimensions using the specified values array.

[ObsoleteAttribute("Use the CreateFromArray method instead.")]
public static DenseMatrix<T> Create<T>(
	int rowCount,
	int columnCount,
	T[] values,
	MatrixElementOrder elementOrder,
	bool createView = false,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

<ObsoleteAttribute("Use the CreateFromArray method instead.")>
Public Shared Function Create(Of T) ( 
	rowCount As Integer,
	columnCount As Integer,
	values As T(),
	elementOrder As MatrixElementOrder,
	Optional createView As Boolean = false,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseMatrix(Of T)

C++/CLI

public:
[ObsoleteAttribute(L"Use the CreateFromArray method instead.")]
generic<typename T>
static DenseMatrix<T>^ Create(
	int rowCount, 
	int columnCount, 
	array<T>^ values, 
	MatrixElementOrder elementOrder, 
	bool createView = false, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

[<ObsoleteAttribute("Use the CreateFromArray method instead.")>]
static member Create : 
        rowCount : int * 
        columnCount : int * 
        values : 'T[] * 
        elementOrder : MatrixElementOrder * 
        ?createView : bool * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _createView = defaultArg createView false
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseMatrix<'T>

Parameters

rowCount Int32: The number of rows.
columnCount Int32: The number of columns.
values T[]: An array of values that contain the elements of the matrix in column-major order.
elementOrder MatrixElementOrder: A MatrixElementOrder value that specifies the order in which the matrix elements are stored in the storage array values.
createView Boolean (Optional): If true, the array referenced by values is used directly for element storage without being copied. Any changes to the elements of this matrix will also affect the original array, and vice versa. If false, the elements are copied from values to a new array.
mutability ArrayMutability (Optional): Specifies how the matrix's values may be changed. The default is mutable values.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the matrix should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

DenseMatrix<T>
A DenseMatrix<T>.

Exceptions

ArgumentNullException

values is null.

ArgumentOutOfRangeException

rowCount is less than zero.

-or-

columnCount is less than zero.

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

Constructs a new matrix.

public static DenseMatrix<T> Create<T>(
	int rowCount,
	int columnCount,
	T[] values,
	int offset,
	int leadingDimension,
	MatrixElementOrder elementOrder,
	ArrayMutability mutability = ArrayMutability.MutableValues,
	bool checkMissingValues = false
)

Visual Basic

Public Shared Function Create(Of T) ( 
	rowCount As Integer,
	columnCount As Integer,
	values As T(),
	offset As Integer,
	leadingDimension As Integer,
	elementOrder As MatrixElementOrder,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues,
	Optional checkMissingValues As Boolean = false
) As DenseMatrix(Of T)

C++/CLI

public:
generic<typename T>
static DenseMatrix<T>^ Create(
	int rowCount, 
	int columnCount, 
	array<T>^ values, 
	int offset, 
	int leadingDimension, 
	MatrixElementOrder elementOrder, 
	ArrayMutability mutability = ArrayMutability::MutableValues, 
	bool checkMissingValues = false
)

static member Create : 
        rowCount : int * 
        columnCount : int * 
        values : 'T[] * 
        offset : int * 
        leadingDimension : int * 
        elementOrder : MatrixElementOrder * 
        ?mutability : ArrayMutability * 
        ?checkMissingValues : bool 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
        let _checkMissingValues = defaultArg checkMissingValues false
*)
-> DenseMatrix<'T>

Parameters

rowCount Int32: The number of rows in the matrix.
columnCount Int32: The number of columns in the matrix.
values T[]: An array that contains the values of the matrix.
offset Int32: Offset of the first element of the matrix in values.
leadingDimension Int32: Distance between the first element of each row or column.
elementOrder MatrixElementOrder: A MatrixElementOrder value that indicates whether rows or columns are stored contiguously.
mutability ArrayMutability (Optional): Specifies how the matrix's values may be changed. The default is mutable values.
checkMissingValues Boolean (Optional): Optional. Specifies whether operations involving the matrix should check for the presence of missing values. The default is false.

Type Parameters

T

Return Value

DenseMatrix<T>
A DenseMatrix<T>.

Matrix.Create Method

Definition

Overload List

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

Parameters

Type Parameters

Return Value

Remarks

Exceptions

Create<T>(Int32, Int32)

Parameters

Type Parameters

Return Value

Exceptions

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

Parameters

Type Parameters

Return Value

Remarks

Exceptions

Create<T>(Int32, Int32, MatrixElementOrder, Boolean)

Parameters

Type Parameters

Return Value

Exceptions

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

Parameters

Type Parameters

Return Value

Exceptions

Create<T>(Int32, Int32, Array2D<T>, MatrixElementOrder, ArrayMutability, Boolean)

Parameters

Type Parameters

Return Value

Create<T>(Int32, Int32, Memory2D<T>, MatrixElementOrder, ArrayMutability, Boolean)

Parameters

Type Parameters

Return Value

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

Parameters

Type Parameters

Return Value

Exceptions

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

Parameters

Type Parameters

Return Value

See Also

Reference