TensorBackEnd.Atanh<T> Method

Computes the inverse hyperbolic tangent of the elements of a tensor.

DefinitionPermalink

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

public virtual Tensor<T> Atanh<T>(
	Tensor<T> value,
	Tensor<T>? result = null,
	Tensor<bool>? mask = null,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public Overridable Function Atanh(Of T) ( 
	value 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>^ Atanh(
	Tensor<T>^ value, 
	Tensor<T>^ result = nullptr, 
	Tensor<bool>^ mask = nullptr, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

abstract Atanh : 
        value : 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 Atanh : 
        value : 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>

ParametersPermalink

value Tensor<T>: A tensor.
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 ParametersPermalink

T: The type of the elements of the tensor.

Return ValuePermalink

Tensor<T>
A tensor of the same shape as value whose elements are equal to the inverse hyperbolic tangent of the corresponding elements of value.

ExceptionsPermalink

ArgumentNullException

value is null.