TensorBackEnd.MultiplySum<T> Method

Adds two tensors and multiplies the result elementwise by a third.

Definition

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

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

Visual Basic

Public Overridable Function MultiplySum(Of T) ( 
	first As Tensor(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>
virtual Tensor<T>^ MultiplySum(
	Tensor<T>^ first, 
	Tensor<T>^ left, 
	Tensor<T>^ right, 
	Tensor<T>^ result = nullptr, 
	Tensor<bool>^ mask = nullptr, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

abstract MultiplySum : 
        first : Tensor<'T> * 
        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> 
override MultiplySum : 
        first : Tensor<'T> * 
        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

first Tensor<T>: A tensor that serves as the first operand..
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 result of the corresponding elements of left and right.

Exceptions

ArgumentNullException

first is null.

-or-

left is null.