Tensor.CreateFromFunction Method

Definition

Namespace: Numerics.NET.Tensors
Assembly: Numerics.NET.Tensors (in Numerics.NET.Tensors.dll) Version: 9.0.1

Creates a tensor with values from a function.

Overload List

CreateFromFunction<T>(Int32, Func<Int32, T>, ArrayMutability)	Creates a new 1-dimensional tensor and initializes the elements using the specified function.
CreateFromFunction<T>(TensorShape, Func<Int32, T>, ArrayMutability)	Creates a new 1-dimensional tensor and initializes the elements using the specified function."/>
CreateFromFunction<T>(TensorShape, Func<Int32, Int32, T>, TensorElementOrder, ArrayMutability)	Creates a new 2-dimensional tensor and initializes the elements using the specified function.
CreateFromFunction<T>(TensorShape, Func<Int32, Int32, Int32, T>, TensorElementOrder, ArrayMutability)	Creates a new 3-dimensional tensor and initializes the elements using the specified function.
CreateFromFunction<T>(TensorShape, Func<Int32, Int32, Int32, Int32, T>, TensorElementOrder, ArrayMutability)	Creates a new 4-dimensional tensor and initializes the elements using the specified function.

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

Creates a new 1-dimensional tensor and initializes the elements using the specified function.

public static Tensor<T> CreateFromFunction<T>(
	int length,
	Func<int, T> function,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function CreateFromFunction(Of T) ( 
	length As Integer,
	function As Func(Of Integer, T),
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
static Tensor<T>^ CreateFromFunction(
	int length, 
	Func<int, T>^ function, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

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

Parameters

length Int32: The number of elements in the tensor.
function Func<Int32, T>: A function that computes the value of the tensor element for the specified index.
mutability ArrayMutability (Optional): Optional. Specifies how the tensor's values may be changed. The default is mutable values.

Type Parameters

T: The type of the elements of the tensor.

Return Value

Tensor<T>
A 1D tensor of length length initialized using function.

Exceptions

ArgumentNullException	function is null.
ArgumentOutOfRangeException	length is less than zero.

CreateFromFunction<T>(TensorShape, Func<Int32, T>, ArrayMutability)

Creates a new 1-dimensional tensor and initializes the elements using the specified function."/>

public static Tensor<T> CreateFromFunction<T>(
	TensorShape shape,
	Func<int, T> function,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function CreateFromFunction(Of T) ( 
	shape As TensorShape,
	function As Func(Of Integer, T),
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
static Tensor<T>^ CreateFromFunction(
	TensorShape shape, 
	Func<int, T>^ function, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member CreateFromFunction : 
        shape : TensorShape * 
        function : Func<int, 'T> * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> Tensor<'T>

Parameters

shape TensorShape: The dimensions of the new tensor.
function Func<Int32, T>: A function that computes the value of the tensor element for the specified index.
mutability ArrayMutability (Optional): Optional. Specifies how the tensor's values may be changed. The default is mutable values.

Type Parameters

T: The type of the elements of the tensor.

Return Value

Tensor<T>
A 1D tensor with shape shape initialized using function.

Exceptions

ArgumentNullException	function is null.
DimensionMismatchException	The rank of shape is not equal to one.
ArgumentOutOfRangeException	One of the dimensions in shape is less than zero.

CreateFromFunction<T>(TensorShape, Func<Int32, Int32, T>, TensorElementOrder, ArrayMutability)

Creates a new 2-dimensional tensor and initializes the elements using the specified function.

public static Tensor<T> CreateFromFunction<T>(
	TensorShape shape,
	Func<int, int, T> function,
	TensorElementOrder order = TensorElementOrder.CStyle,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function CreateFromFunction(Of T) ( 
	shape As TensorShape,
	function As Func(Of Integer, Integer, T),
	Optional order As TensorElementOrder = TensorElementOrder.CStyle,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
static Tensor<T>^ CreateFromFunction(
	TensorShape shape, 
	Func<int, int, T>^ function, 
	TensorElementOrder order = TensorElementOrder::CStyle, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member CreateFromFunction : 
        shape : TensorShape * 
        function : Func<int, int, 'T> * 
        ?order : TensorElementOrder * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _order = defaultArg order TensorElementOrder.CStyle
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> Tensor<'T>

Parameters

shape TensorShape: The dimensions of the new tensor.
function Func<Int32, Int32, T>: A function that computes the value of the tensor element for the specified index.
order TensorElementOrder (Optional): Optional. Specifies the element order of the result. By default, elements are stored in C-style (row-major) order.
mutability ArrayMutability (Optional): Optional. Specifies how the tensor's values may be changed. The default is mutable values.

Type Parameters

T: The type of the elements of the tensor.

Return Value

Tensor<T>
A 2D tensor with shape shape initialized using function.

Exceptions

ArgumentNullException	function is null.
DimensionMismatchException	The rank of shape is not equal to 2.
ArgumentOutOfRangeException	One of the dimensions in shape is less than zero.

CreateFromFunction<T>(TensorShape, Func<Int32, Int32, Int32, T>, TensorElementOrder, ArrayMutability)

Creates a new 3-dimensional tensor and initializes the elements using the specified function.

public static Tensor<T> CreateFromFunction<T>(
	TensorShape shape,
	Func<int, int, int, T> function,
	TensorElementOrder order = TensorElementOrder.CStyle,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function CreateFromFunction(Of T) ( 
	shape As TensorShape,
	function As Func(Of Integer, Integer, Integer, T),
	Optional order As TensorElementOrder = TensorElementOrder.CStyle,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
static Tensor<T>^ CreateFromFunction(
	TensorShape shape, 
	Func<int, int, int, T>^ function, 
	TensorElementOrder order = TensorElementOrder::CStyle, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member CreateFromFunction : 
        shape : TensorShape * 
        function : Func<int, int, int, 'T> * 
        ?order : TensorElementOrder * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _order = defaultArg order TensorElementOrder.CStyle
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> Tensor<'T>

Parameters

shape TensorShape: The dimensions of the new tensor.
function Func<Int32, Int32, Int32, T>: A function that computes the value of the tensor element for the specified index.
order TensorElementOrder (Optional): Optional. Specifies the element order of the result. By default, elements are stored in C-style (row-major) order.
mutability ArrayMutability (Optional): Optional. Specifies how the tensor's values may be changed. The default is mutable values.

Type Parameters

T: The type of the elements of the tensor.

Return Value

Tensor<T>
A 3D tensor with shape shape initialized using function.

Exceptions

ArgumentNullException	function is null.
DimensionMismatchException	The rank of shape is not equal to 3.
ArgumentOutOfRangeException	One of the dimensions in shape is less than zero.

CreateFromFunction<T>(TensorShape, Func<Int32, Int32, Int32, Int32, T>, TensorElementOrder, ArrayMutability)

Creates a new 4-dimensional tensor and initializes the elements using the specified function.

public static Tensor<T> CreateFromFunction<T>(
	TensorShape shape,
	Func<int, int, int, int, T> function,
	TensorElementOrder order = TensorElementOrder.CStyle,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function CreateFromFunction(Of T) ( 
	shape As TensorShape,
	function As Func(Of Integer, Integer, Integer, Integer, T),
	Optional order As TensorElementOrder = TensorElementOrder.CStyle,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
static Tensor<T>^ CreateFromFunction(
	TensorShape shape, 
	Func<int, int, int, int, T>^ function, 
	TensorElementOrder order = TensorElementOrder::CStyle, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member CreateFromFunction : 
        shape : TensorShape * 
        function : Func<int, int, int, int, 'T> * 
        ?order : TensorElementOrder * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _order = defaultArg order TensorElementOrder.CStyle
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> Tensor<'T>

Parameters

shape TensorShape: The dimensions of the new tensor.
function Func<Int32, Int32, Int32, Int32, T>: A function that computes the value of the tensor element for the specified index.
order TensorElementOrder (Optional): Optional. Specifies the element order of the result. By default, elements are stored in C-style (row-major) order.
mutability ArrayMutability (Optional): Optional. Specifies how the tensor's values may be changed. The default is mutable values.

Type Parameters

T: The type of the elements of the tensor.

Return Value

Tensor<T>
A 4D tensor with shape shape initialized using function.

Exceptions

ArgumentNullException	function is null.
DimensionMismatchException	The rank of shape is not equal to 4.
ArgumentOutOfRangeException	One of the dimensions in shape is less than zero.

Tensor.CreateFromFunction Method

Definition

Overload List

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

Parameters

Type Parameters

Return Value

Exceptions

CreateFromFunction<T>(TensorShape, Func<Int32, T>, ArrayMutability)

Parameters

Type Parameters

Return Value

Exceptions

CreateFromFunction<T>(TensorShape, Func<Int32, Int32, T>, TensorElementOrder, ArrayMutability)

Parameters

Type Parameters

Return Value

Exceptions

CreateFromFunction<T>(TensorShape, Func<Int32, Int32, Int32, T>, TensorElementOrder, ArrayMutability)

Parameters

Type Parameters

Return Value

Exceptions

CreateFromFunction<T>(TensorShape, Func<Int32, Int32, Int32, Int32, T>, TensorElementOrder, ArrayMutability)

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference