--- title: Hypot description: "| 产品 | 是否支持 |" url: https://www.hiascend.com/document/detail/zh/canncommercial/latest/API/ascendcopapi/atlasascendc_api_07_10153.html sourcePath: /source/zh/canncommercial/900/API/ascendcopapi/atlasascendc_api_07_10153.html indexId: 4ddc8bf4ae484ad0fe33d1ddfc364063c47d300fe2b6431c866a120c868f35a477 --- # Hypot #### 产品支持情况 | 产品 | 是否支持 | | --- | --- | | Atlas 350 加速卡 | √ | | Atlas A3 训练系列产品 / Atlas A3 推理系列产品 | x | | Atlas A2 训练系列产品 / Atlas A2 推理系列产品 | x | | Atlas 200I/500 A2 推理产品 | x | | Atlas 推理系列产品 AI Core | x | | Atlas 推理系列产品 Vector Core | x | | Atlas 训练系列产品 | x | #### 功能说明 按元素计算两个浮点数平方和的平方根。计算公式如下： 举例如下： Hypot(3.0, 4.0) = 5.0 #### 函数原型 - 通过sharedTmpBuffer入参传入临时空间 - 源操作数Tensor全部/部分参与计算 1 2 template __aicore__ inline void Hypot(const LocalTensor& dstTensor, const LocalTensor& src0Tensor, const LocalTensor& src1Tensor, const LocalTensor& sharedTmpBuffer, const uint32_t calCount) - 源操作数Tensor全部参与计算 1 2 template __aicore__ inline void Hypot(const LocalTensor& dstTensor, const LocalTensor& src0Tensor, const LocalTensor& src1Tensor, const LocalTensor& sharedTmpBuffer) - 接口框架申请临时空间 - 源操作数Tensor全部/部分参与计算 1 2 template __aicore__ inline void Hypot(const LocalTensor& dstTensor, const LocalTensor& src0Tensor, const LocalTensor& src1Tensor, const uint32_t calCount) - 源操作数Tensor全部参与计算 1 2 template __aicore__ inline void Hypot(const LocalTensor& dstTensor, const LocalTensor& src0Tensor, const LocalTensor& src1Tensor) 由于该接口的内部实现中涉及精度转换。需要额外的临时空间来存储计算过程中的中间变量。临时空间支持接口框架申请和开发者通过sharedTmpBuffer入参传入两种方式。 - 通过sharedTmpBuffer入参传入，使用该tensor作为临时空间进行处理，接口框架不再申请。该方式开发者可以自行管理sharedTmpBuffer内存空间，并在接口调用完成后，复用该部分内存，内存不会反复申请释放，灵活性较高，内存利用率也较高。 - 接口框架申请临时空间，开发者无需申请，但是需要预留临时空间的大小。 接口框架申请的方式，开发者需要预留临时空间；通过sharedTmpBuffer传入的情况，开发者需要为tensor申请空间。临时空间大小BufferSize的获取方式如下：通过GetHypotMaxMinTmpSize中提供的接口获取需要预留空间的大小。 #### 参数说明 **表1 模板参数说明** | 参数名 | 描述 | | --- | --- | | T | 操作数的数据类型。 Atlas 350 加速卡，支持的数据类型为：half、bfloat16\_t、float。 | | isReuseSource | 是否允许修改源操作数。该参数预留，传入默认值false即可。 | **表2 接口参数说明** | 参数名 | 输入/输出 | 描述 | | --- | --- | --- | | dstTensor | 输出 | 目的操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 | | src0Tensor、src1Tensor | 输入 | 源操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 源操作数的数据类型需要与目的操作数保持一致。 | | sharedTmpBuffer | 输入 | 临时缓存。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 用于Hypot内部复杂计算时存储中间变量，由开发者提供。 临时空间大小BufferSize的获取方式请参考GetHypotMaxMinTmpSize。 | | calCount | 输入 | 参与计算的元素个数。 | #### 返回值说明 无 #### 约束说明 - 源操作数src0Tensor与src1Tensor的数据长度必须保持一致。 - 不支持源操作数与目的操作数地址重叠。 - 不支持sharedTmpBuffer与源操作数、目的操作数地址重叠。 - 操作数地址对齐要求请参见 通用地址对齐约束 。 - 当源操作数src0Tensor与src1Tensor的输入数据中任意一个或多个为inf，对应位置的目的操作数输出为inf。 - 当源操作数src0Tensor与src1Tensor的输入数据中任意一个或多个为nan，且该位置上的输入都不是inf，对应位置的目的操作数输出为nan。 #### 调用示例 ``` AscendC::TPipe pipe; AscendC::TQue tmpQue; pipe.InitBuffer(tmpQue, 1, bufferSize); // bufferSize 通过Host侧tiling参数获取 AscendC::LocalTensor sharedTmpBuffer = tmpQue.AllocTensor(); // 输入tensor长度为1024, 算子输入的数据类型为half, 实际计算个数为512 AscendC::Hypot(dstLocal, src0Local, src1Local, sharedTmpBuffer, 512); // sharedTmpBuffer入参传入，使用该tensor作为临时空间进行处理 ``` 结果示例如下：``` 输入数据(src0Local): [ 0.5317103 -6.37912032 5.53408647 ... 11.11059642 -11.67860335 ] 输入数据(src1Local): [ 2.12526834 3.09347812 -0.327234 ... 5.64334232 5.97345923] 输出数据(dstLocal): [ 2.1907718 7.08962502 5.5437528 ... 12.461647 13.1176214] ```