Tensor.Multiply Method

DefinitionPermalink

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

Overload ListPermalink

Multiply<T>(Tensor<T>, T, Tensor<T>, Tensor<Boolean>, TensorElementOrder)	Multiplies a tensor and a scalar.
Multiply<T>(Tensor<T>, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)	Multiplies two tensors.
Multiply<T>(T, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)	Multiplies a scalar and a tensor.

Multiply<T>(Tensor<T>, T, Tensor<T>, Tensor<Boolean>, TensorElementOrder)Permalink

Multiplies a tensor and a scalar.

public static Tensor<T> Multiply<T>(
	Tensor<T> left,
	T right,
	Tensor<T>? result = null,
	Tensor<bool>? mask = null,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public Shared Function Multiply(Of T) ( 
	left As Tensor(Of T),
	right As T,
	Optional result As Tensor(Of T) = Nothing,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional order As TensorElementOrder = TensorElementOrder.Automatic
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
static Tensor<T>^ Multiply(
	Tensor<T>^ left, 
	T right, 
	Tensor<T>^ result = nullptr, 
	Tensor<bool>^ mask = nullptr, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

static member Multiply : 
        left : Tensor<'T> * 
        right : 'T * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T>

Parameters

left Tensor<T>: A tensor that serves as the left operand.
right T: A scalar that serves as the right operand.
result Tensor<T> (Optional): Optional. The tensor that is to hold the result. May be null.
mask Tensor<Boolean> (Optional): Optional. A boolean tensor that specifies for which elements the operation should be performed. If null (the default), the operation is applied everywhere.
order TensorElementOrder (Optional): Optional. If result is null, the desired ordering in memory of the result.

Type Parameters

T: The type of the elements of the tensor.

Return Value

Tensor<T>
A tensor of the same shape as left whose elements are equal to the product of the corresponding elements of left and right.

ExceptionsPermalink

ArgumentNullException

left is null.

Multiply<T>(Tensor<T>, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)Permalink

Multiplies two tensors.

public static Tensor<T> Multiply<T>(
	Tensor<T> left,
	Tensor<T> right,
	Tensor<T>? result = null,
	Tensor<bool>? mask = null,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public Shared Function Multiply(Of T) ( 
	left As Tensor(Of T),
	right As Tensor(Of T),
	Optional result As Tensor(Of T) = Nothing,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional order As TensorElementOrder = TensorElementOrder.Automatic
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
static Tensor<T>^ Multiply(
	Tensor<T>^ left, 
	Tensor<T>^ right, 
	Tensor<T>^ result = nullptr, 
	Tensor<bool>^ mask = nullptr, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

static member Multiply : 
        left : Tensor<'T> * 
        right : Tensor<'T> * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T>

Parameters

left Tensor<T>: A tensor that serves as the left operand..
right Tensor<T>: A tensor that serves as the right operand..
result Tensor<T> (Optional): Optional. The tensor that is to hold the result. May be null.
mask Tensor<Boolean> (Optional): Optional. A boolean tensor that specifies for which elements should be included in the operation. If null (the default), the operation is applied everywhere.
order TensorElementOrder (Optional): Optional. If result is null, the desired ordering in memory of the result.

Type Parameters

T: The type of the elements of the tensors.

Return Value

Tensor<T>
A tensor of the same shape as left and right whose elements are equal to the product of the corresponding elements of left and right

ExceptionsPermalink

ArgumentNullException

left is null.

-or-

right is null.

Multiply<T>(T, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)Permalink

Multiplies a scalar and a tensor.

public static Tensor<T> Multiply<T>(
	T left,
	Tensor<T> right,
	Tensor<T>? result = null,
	Tensor<bool>? mask = null,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public Shared Function Multiply(Of T) ( 
	left As T,
	right As Tensor(Of T),
	Optional result As Tensor(Of T) = Nothing,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional order As TensorElementOrder = TensorElementOrder.Automatic
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
static Tensor<T>^ Multiply(
	T left, 
	Tensor<T>^ right, 
	Tensor<T>^ result = nullptr, 
	Tensor<bool>^ mask = nullptr, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

static member Multiply : 
        left : 'T * 
        right : Tensor<'T> * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T>

Parameters

left T: A scalar that serves as the left operand.
right Tensor<T>: A tensor that serves as the right operand.
result Tensor<T> (Optional): Optional. The tensor that is to hold the result. May be null.
mask Tensor<Boolean> (Optional): Optional. A boolean tensor that specifies for which elements the operation should be performed. If null (the default), the operation is applied everywhere.
order TensorElementOrder (Optional): Optional. If result is null, the desired ordering in memory of the result.

Type Parameters

T: The type of the elements of the tensor.

Return Value

Tensor<T>
A tensor of the same shape as right whose elements are equal to the product of left and the corresponding elements of right.

ExceptionsPermalink

ArgumentNullException

right is null.

Tensor.Multiply Method

DefinitionPermalink

Overload ListPermalink

Multiply<T>(Tensor<T>, T, Tensor<T>, Tensor<Boolean>, TensorElementOrder)Permalink

Parameters

Type Parameters

Return Value

ExceptionsPermalink

Multiply<T>(Tensor<T>, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)Permalink

Parameters

Type Parameters

Return Value

ExceptionsPermalink

Multiply<T>(T, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)Permalink

Parameters

Type Parameters

Return Value

ExceptionsPermalink

See AlsoPermalink

ReferencePermalink