TensorBackEnd.HypotInPlace Method

Definition

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

Overload List

HypotInPlace<T>(Tensor<T>, T, Tensor<Boolean>)	Computes the square root of the sum of the squares of the elements of a tensor and a scalar. in-place.
HypotInPlace<T>(Tensor<T>, Tensor<T>, Tensor<Boolean>)	Computes the square root of the sum of the squares of the elements of two tensors in place.

HypotInPlace<T>(Tensor<T>, T, Tensor<Boolean>)

Computes the square root of the sum of the squares of the elements of a tensor and a scalar. in-place.

public virtual Tensor<T> HypotInPlace<T>(
	Tensor<T> left,
	T right,
	Tensor<bool>? mask = null
)

Visual Basic

Public Overridable Function HypotInPlace(Of T) ( 
	left As Tensor(Of T),
	right As T,
	Optional mask As Tensor(Of Boolean) = Nothing
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
virtual Tensor<T>^ HypotInPlace(
	Tensor<T>^ left, 
	T right, 
	Tensor<bool>^ mask = nullptr
)

abstract HypotInPlace : 
        left : Tensor<'T> * 
        right : 'T * 
        ?mask : Tensor<bool> 
(* Defaults:
        let _mask = defaultArg mask null
*)
-> Tensor<'T> 
override HypotInPlace : 
        left : Tensor<'T> * 
        right : 'T * 
        ?mask : Tensor<bool> 
(* Defaults:
        let _mask = defaultArg mask null
*)
-> Tensor<'T>

Parameters

left Tensor<T>: A tensor that serves as the left operand.
right T: A scalar that serves as the right operand.
mask Tensor<Boolean> (Optional): Optional. A boolean tensor that specifies whether the operation should be performed at the location. If omitted, the operation is performed everywhere.

Type Parameters

T

Return Value

Tensor<T>
This tensor with each element replaced with the hypotenuse of the element and right.

HypotInPlace<T>(Tensor<T>, Tensor<T>, Tensor<Boolean>)

Computes the square root of the sum of the squares of the elements of two tensors in place.

public virtual Tensor<T> HypotInPlace<T>(
	Tensor<T> left,
	Tensor<T> right,
	Tensor<bool>? mask = null
)

Visual Basic

Public Overridable Function HypotInPlace(Of T) ( 
	left As Tensor(Of T),
	right As Tensor(Of T),
	Optional mask As Tensor(Of Boolean) = Nothing
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
virtual Tensor<T>^ HypotInPlace(
	Tensor<T>^ left, 
	Tensor<T>^ right, 
	Tensor<bool>^ mask = nullptr
)

abstract HypotInPlace : 
        left : Tensor<'T> * 
        right : Tensor<'T> * 
        ?mask : Tensor<bool> 
(* Defaults:
        let _mask = defaultArg mask null
*)
-> Tensor<'T> 
override HypotInPlace : 
        left : Tensor<'T> * 
        right : Tensor<'T> * 
        ?mask : Tensor<bool> 
(* Defaults:
        let _mask = defaultArg mask null
*)
-> 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..
mask Tensor<Boolean> (Optional): Optional. A boolean tensor that specifies whether the operation should be performed at the location. If omitted, the operation is performed everywhere.

Type Parameters

T: The type of the elements of the tensors.

Return Value

Tensor<T>
This tensor with the elements replaced with the hypotenuse of the element and the corresponding element of right.

Exceptions

ArgumentNullException

left is null.

-or-

right is null.

DimensionMismatchException

The dimensions of left and right are not compatible.

TensorBackEnd.HypotInPlace Method

Definition

Overload List

HypotInPlace<T>(Tensor<T>, T, Tensor<Boolean>)

Parameters

Type Parameters

Return Value

HypotInPlace<T>(Tensor<T>, Tensor<T>, Tensor<Boolean>)

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference