--- title: Atanh description: "| 产品 | 是否支持 |" url: https://www.hiascend.com/document/detail/zh/canncommercial/latest/API/ascendcopapi/atlasascendc_api_07_0556.html sourcePath: /source/zh/canncommercial/900/API/ascendcopapi/atlasascendc_api_07_0556.html indexId: 4e0a287e0f4b7cb7c624832881d457b4fbe339fd306515925bad2e8be2e34f4776 --- # Atanh #### 产品支持情况 | 产品 | 是否支持 | | --- | --- | | Atlas 350 加速卡 | √ | | Atlas A3 训练系列产品 / Atlas A3 推理系列产品 | √ | | Atlas A2 训练系列产品 / Atlas A2 推理系列产品 | √ | | Atlas 200I/500 A2 推理产品 | x | | Atlas 推理系列产品 AI Core | √ | | Atlas 推理系列产品 Vector Core | x | | Atlas 训练系列产品 | x | #### 功能说明 按元素做反双曲正切余弦函数计算，计算公式如下： #### 函数原型 - 通过sharedTmpBuffer入参传入临时空间 - 源操作数Tensor全部/部分参与计算 1 2 template __aicore__ inline void Atanh(const LocalTensor& dstTensor, const LocalTensor& srcTensor, const LocalTensor& sharedTmpBuffer, const uint32_t calCount) - 源操作数Tensor全部参与计算 1 2 template __aicore__ inline void Atanh(const LocalTensor& dstTensor, const LocalTensor& srcTensor, const LocalTensor& sharedTmpBuffer) - 接口框架申请临时空间 - 源操作数Tensor全部/部分参与计算 1 2 template __aicore__ inline void Atanh(const LocalTensor& dstTensor, const LocalTensor& srcTensor, const uint32_t calCount) - 源操作数Tensor全部参与计算 1 2 template __aicore__ inline void Atanh(const LocalTensor& dstTensor, const LocalTensor& srcTensor) 由于该接口的内部实现中涉及复杂的数学计算，需要额外的临时空间来存储计算过程中的中间变量。临时空间支持开发者通过sharedTmpBuffer入参传入和接口框架申请两种方式。 - 通过sharedTmpBuffer入参传入，使用该tensor作为临时空间进行处理，接口框架不再申请。该方式开发者可以自行管理sharedTmpBuffer内存空间，并在接口调用完成后，复用该部分内存，内存不会反复申请释放，灵活性较高，内存利用率也较高。 - 接口框架申请临时空间，开发者无需申请，但是需要预留临时空间的大小。 通过sharedTmpBuffer传入的情况，开发者需要为tensor申请空间；接口框架申请的方式，开发者需要预留临时空间。临时空间大小BufferSize的获取方式如下：通过GetAtanhMaxMinTmpSize接口获取需要预留空间范围的大小。 #### 参数说明 **表1 模板参数说明** | 参数名 | 描述 | | --- | --- | | T | 操作数的数据类型。 Atlas 350 加速卡，支持的数据类型为：half、float。 Atlas A3 训练系列产品 / Atlas A3 推理系列产品 ，支持的数据类型为：half、float。 Atlas A2 训练系列产品 / Atlas A2 推理系列产品 ，支持的数据类型为：half、float。 Atlas 推理系列产品 AI Core，支持的数据类型为：half、float。 | | isReuseSource | 是否允许修改源操作数。该参数预留，传入默认值false即可。 | **表2 接口参数说明** | 参数名 | 输入/输出 | 描述 | | --- | --- | --- | | dstTensor | 输出 | 目的操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 | | srcTensor | 输入 | 源操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 源操作数的数据类型需要与目的操作数保持一致。 | | sharedTmpBuffer | 输入 | 临时缓存。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 用于Atanh内部复杂计算时存储中间变量，由开发者提供。 临时空间大小BufferSize的获取方式请参考GetAtanhMaxMinTmpSize。 | | calCount | 输入 | 参与计算的元素个数。 | #### 返回值说明 无 #### 约束说明 - 输入源数据需保持值域在(-0.99，-0.001)或者(0.001， 0.99)区间内。若输入不在范围内，输出结果无效。 - 不支持源操作数与目的操作数地址重叠。 - 不支持sharedTmpBuffer与源操作数和目的操作数地址重叠。 - 操作数地址对齐要求请参见 通用地址对齐约束 。 #### 调用示例 完整的调用样例请参考atanh算子样例(https://gitcode.com/cann/asc-devkit/tree/9.0.0/examples/01_simd_cpp_api/03_libraries/12_math/atanh)。 ``` // dstLocal: 存放Atanh计算结果的Tensor // srcLocal: 存放Atanh计算输入的Tensor // sharedTmpBuffer: 存放Atanh计算过程中临时缓存的Tensor // 算子输入的数据类型为half, 需要参与计算的元素个数为512 AscendC::Atanh(dstLocal, srcLocal, sharedTmpBuffer, 512); ``` 结果示例如下：``` 输入数据(srcLocal): [0.000000 0.010000 0.020000 ... 0.990000 1.000000 1.010000 ...] 输出数据(dstLocal): [0.000000 0.010000 0.020003 ... 2.646650 inf -nan ...] ```