Atanh

Applicability

Function

Performs element-wise inverse hyperbolic tangent cosine computation using the following formula:

Prototype

• Pass the temporary space through the sharedTmpBuffer input parameter.
  • All or part of the source operand tensors are involved in computation.

    1 2	template <typename T, bool isReuseSource = false> __aicore__ inline void Atanh(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const LocalTensor<uint8_t>& sharedTmpBuffer, const uint32_t calCount)

  • All source operand tensors are involved in computation.

    1 2	template <typename T, bool isReuseSource = false> __aicore__ inline void Atanh(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const LocalTensor<uint8_t>& sharedTmpBuffer)

• Allocate the temporary space through the API framework.
  • All or part of the source operand tensors are involved in computation.

    1 2	template <typename T, bool isReuseSource = false> __aicore__ inline void Atanh(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const uint32_t calCount)

  • All source operand tensors are involved in computation.

    1 2	template <typename T, bool isReuseSource = false> __aicore__ inline void Atanh(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor)

Due to the complex mathematical computation involved in the internal implementation of this API, additional temporary space is required to store intermediate variables generated during computation. The temporary space can be passed by developers through the sharedTmpBuffer input parameter or allocated through the API framework.

• When the sharedTmpBuffer input parameter is used for passing the temporary space, the tensor serves as the temporary space. In this case, the API framework is not required for temporary space allocation. This enables developers to manage the sharedTmpBuffer space and reuse the buffer after calling the API, so that the buffer is not repeatedly allocated and deallocated, improving the flexibility and buffer utilization.
• When the API framework is used for temporary space allocation, developers do not need to allocate the space, but must reserve the required size for the space.

If sharedTmpBuffer is passed, developers must allocate space for the tensor. If the API framework is used, you must reserve the temporary space. To obtain the size of the temporary space (BufferSize) to be reserved, use the GetAtanhMaxMinTmpSize API.

Parameters

Returns

None

Restrictions

• The value range of the input source data must be (–0.99, –0.001) or (0.001, 0.99). If the input is not within the range, the output is invalid.

• The source operand address must not overlap the destination operand address.
• The address of sharedTmpBuffer must not overlap the addresses of the source operand and destination operand.
• For details about the operand address alignment requirements, see General Address Alignment Restrictions.

Example

For details about the complete calling example, see More Examples.

1
2
3
4
5
6

AscendC::TPipe pipe;
AscendC::TQue<AscendC::TPosition::VECCALC, 1> tmpQue;
pipe.InitBuffer(tmpQue, 1, bufferSize);  // bufferSize is obtained through the tiling parameter on the host.
AscendC::LocalTensor<uint8_t> sharedTmpBuffer = tmpQue.AllocTensor<uint8_t>();
// The input tensor length is 1024, the input data type of the operator is half, and the number of actually computed data elements is 512.
AscendC::Atanh(dstLocal, srcLocal, sharedTmpBuffer, 512);

1
2

Input data (srcLocal): [0.80541134 0.08385705 0 ...  -0.30962205 -0.28947052]
Output data (dstLocal): [1.11382794 0.08405444 0 ...  -0.32012733 -0.29798826]