CANN/asc-devkit Xor接口文档

Xor

【免费下载链接】asc-devkit本项目是CANN 推出的昇腾AI处理器专用的算子程序开发语言，原生支持C和C++标准规范，主要由类库和语言扩展层构成，提供多层级API，满足多维场景算子开发诉求。项目地址: https://gitcode.com/cann/asc-devkit

产品支持情况

• Ascend 950PR/Ascend 950DT：支持

• Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持

• Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持

• Atlas 200I/500 A2 推理产品：支持

• Atlas 推理系列产品AI Core：支持
• Atlas 推理系列产品Vector Core：不支持

• Atlas 训练系列产品：不支持

功能说明

按元素执行Xor运算，Xor（异或）的概念和运算规则如下：

• 概念：参加运算的两个数据，按二进制位进行“异或”运算。
• 运算规则：0^0=0；0^1=1；1^0=1；1^1=0；即：参加运算的两个对象，如果两个相应位为“异”（值不同），则该位结果为1，否则为0【同0异1】。

计算公式如下：

例如：3^5=6，即0000 0011^0000 0101 = 0000 0110

函数原型

• 通过sharedTmpBuffer入参传入临时空间

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

    template <typename T, bool isReuseSource = false> __aicore__ inline void Xor(const LocalTensor<T>& dstTensor, const LocalTensor<T>& src0Tensor, const LocalTensor<T>& src1Tensor, const LocalTensor<uint8_t>& sharedTmpBuffer, const uint32_t calCount)

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

    template <typename T, bool isReuseSource = false> __aicore__ inline void Xor(const LocalTensor<T>& dstTensor, const LocalTensor<T>& src0Tensor, const LocalTensor<T>& src1Tensor, const LocalTensor<uint8_t>& sharedTmpBuffer)

• 接口框架申请临时空间

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

    template <typename T, bool isReuseSource = false> __aicore__ inline void Xor(const LocalTensor<T>& dstTensor, const LocalTensor<T>& src0Tensor, const LocalTensor<T>& src1Tensor, const uint32_t calCount)

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

    template <typename T, bool isReuseSource = false> __aicore__ inline void Xor(const LocalTensor<T>& dstTensor, const LocalTensor<T>& src0Tensor, const LocalTensor<T>& src1Tensor)

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

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

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

参数说明

表1模板参数说明

参数名	描述
T	操作数的数据类型。支持的数据类型为：int16_t、uint16_t。
isReuseSource	是否允许修改源操作数。该参数预留，传入默认值false即可。

表2接口参数说明

参数名	输入/输出	描述
dstTensor	输出	目的操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。
src0Tensor	输入	源操作数0。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 源操作数的数据类型需要与目的操作数保持一致。
src1Tensor	输入	源操作数1。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 源操作数的数据类型需要与目的操作数保持一致。
sharedTmpBuffer	输入	临时缓存。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 用于Xor内部复杂计算时存储中间变量，由开发者提供。 临时空间大小BufferSize的获取方式请参考GetXorMaxMinTmpSize。
calCount	输入	参与计算的元素个数。

返回值说明

无

约束说明

• 不支持源操作数与目的操作数地址重叠。
• 当前仅支持ND格式的输入，不支持其他格式。
• calCount需要保证小于或等于src0Tensor和src1Tensor和dstTensor存储的元素范围。
• 对于不带calCount参数的接口，需要保证src0Tensor和src1Tensor的shape大小相等。
• 不支持sharedTmpBuffer与源操作数和目的操作数地址重叠。
• 操作数地址对齐要求请参见通用地址对齐约束。

调用示例

完整的调用样例可参考Xor样例。

// dstLocal: 存放计算结果的Tensor // src0Local: 参与计算的输入Tensor // src1Local: 参与计算的输入Tensor AscendC::Xor(dstLocal, src0Local, src1Local);

结果示例如下：

输入数据(srcLocal): [ 2 3 5 7 11 13 17 19 ] 输入数据(srcLocal): [ 1 2 3 4 5 6 7 8 ] 输出数据(dstLocal): [ 3 1 6 3 14 10 22 27 ]

【免费下载链接】asc-devkit本项目是CANN 推出的昇腾AI处理器专用的算子程序开发语言，原生支持C和C++标准规范，主要由类库和语言扩展层构成，提供多层级API，满足多维场景算子开发诉求。项目地址: https://gitcode.com/cann/asc-devkit