Atanh

产品支持情况

功能说明

按元素做反双曲正切余弦函数计算，计算公式如下：

函数原型

• 通过sharedTmpBuffer入参传入临时空间
  • 源操作数Tensor全部/部分参与计算

    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)

  • 源操作数Tensor全部参与计算

    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)

• 接口框架申请临时空间
  • 源操作数Tensor全部/部分参与计算

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

  • 源操作数Tensor全部参与计算

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

由于该接口的内部实现中涉及复杂的数学计算，需要额外的临时空间来存储计算过程中的中间变量。临时空间支持开发者通过sharedTmpBuffer入参传入和接口框架申请两种方式。

• 通过sharedTmpBuffer入参传入，使用该tensor作为临时空间进行处理，接口框架不再申请。该方式开发者可以自行管理sharedTmpBuffer内存空间，并在接口调用完成后，复用该部分内存，内存不会反复申请释放，灵活性较高，内存利用率也较高。
• 接口框架申请临时空间，开发者无需申请，但是需要预留临时空间的大小。

通过sharedTmpBuffer传入的情况，开发者需要为tensor申请空间；接口框架申请的方式，开发者需要预留临时空间。临时空间大小BufferSize的获取方式如下：通过GetAtanhMaxMinTmpSize接口获取需要预留空间范围的大小。

参数说明

返回值说明

无

约束说明

• 输入源数据需保持值域在(-0.99，-0.001)或者(0.001， 0.99)区间内。若输入不在范围内，输出结果无效。

• 不支持源操作数与目的操作数地址重叠。
• 不支持sharedTmpBuffer与源操作数和目的操作数地址重叠。
• 操作数地址对齐要求请参见通用地址对齐约束。

调用示例

完整的调用样例请参考算子样例。

1
2
3
4
5

// dstLocal: 存放Atanh计算结果的Tensor
// srcLocal: 存放Atanh计算输入的Tensor
// sharedTmpBuffer: 存放Atanh计算过程中临时缓存的Tensor
// 算子输入的数据类型为half, 需要参与计算的元素个数为512
AscendC::Atanh(dstLocal, srcLocal, sharedTmpBuffer, 512);

1
2

输入数据(srcLocal): [0.000000 0.010000 0.020000 ...  0.990000 1.000000 1.010000 ...]
输出数据(dstLocal): [0.000000 0.010000 0.020003 ...  2.646650 inf -nan ...]