Or

功能说明

每对elements按位或运算：

$\text{[math]}$

函数原型

整个tensor参与计算
1

dstLocal = src0Local | src1Local;

tensor前n个数据计算

        
             template <typename T>
__aicore__ inline void Or(const LocalTensor<T>& dstLocal, const LocalTensor<T>& src0Local, const LocalTensor<T>& src1Local, const int32_t& calCount)

tensor高维切分计算

mask逐bit模式

          
               template <typename T, bool isSetMask = true>
__aicore__ inline void Or(const LocalTensor<T>& dstLocal, const LocalTensor<T>& src0Local, const LocalTensor<T>& src1Local, uint64_t mask[], const uint8_t repeatTimes, const BinaryRepeatParams& repeatParams)

mask连续模式

          
               template <typename T, bool isSetMask = true>
__aicore__ inline void Or(const LocalTensor<T>& dstLocal, const LocalTensor<T>& src0Local, const LocalTensor<T>& src1Local, uint64_t mask, const uint8_t repeatTimes, const BinaryRepeatParams& repeatParams)

参数说明

表1 模板参数说明
参数名	描述
T	操作数数据类型。
isSetMask	是否在接口内部设置mask。 true，表示在接口内部设置mask。 false，表示在接口外部设置mask，开发者需要使用SetVectorMask接口设置mask值。这种模式下，本接口入参中的mask值必须设置为MASK_PLACEHOLDER。

表2 参数说明
参数名	输入/输出	描述
dstLocal	输出	目的操作数。类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。 Atlas 训练系列产品，支持的数据类型为：uint16_t/int16_t Atlas 推理系列产品 AI Core，支持的数据类型为：uint16_t/int16_t Atlas A2 训练系列产品/Atlas 800I A2 推理产品，支持的数据类型为：uint16_t/int16_t Atlas 200I/500 A2 推理产品，支持的数据类型为：uint16_t/int16_t
src0Local、src1Local	输入	源操作数。类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。两个源操作数的数据类型需要与目的操作数保持一致。 Atlas 训练系列产品，支持的数据类型为：uint16_t/int16_t Atlas 推理系列产品 AI Core，支持的数据类型为：uint16_t/int16_t Atlas A2 训练系列产品/Atlas 800I A2 推理产品，支持的数据类型为：uint16_t/int16_t Atlas 200I/500 A2 推理产品，支持的数据类型为：uint16_t/int16_t
calCount	输入	输入数据元素个数。
mask	输入	mask用于控制每次迭代内参与计算的元素。连续模式：表示前面连续的多少个元素参与计算。取值范围和操作数的数据类型有关，数据类型不同，每次迭代内能够处理的元素个数最大值不同。当操作数为16位时，mask∈[1, 128]；当操作数为32位时，mask∈[1, 64]；当操作数为64位时，mask∈[1, 32]。逐bit模式：可以按位控制哪些元素参与计算，bit位的值为1表示参与计算，0表示不参与。参数类型为长度为2的uint64_t类型数组。例如，mask=[8, 0]，8=0b1000，表示仅第4个元素参与计算。参数取值范围和操作数的数据类型有关，数据类型不同，每次迭代内能够处理的元素个数最大值不同。当操作数为16位时，mask[0]、mask[1]∈[0, 2⁶⁴-1]并且不同时为0；当操作数为32位时，mask[1]为0，mask[0]∈(0, 2⁶⁴-1]；当操作数为64位时，mask[1]为0，mask[0]∈(0, 2³²-1]。
repeatTimes	输入	重复迭代次数。矢量计算单元，每次读取连续的256 Bytes数据进行计算，为完成对输入数据的处理，必须通过多次迭代（repeat）才能完成所有数据的读取与计算。repeatTimes表示迭代的次数。关于该参数的具体描述请参考通用参数说明。
repeatParams	输入	控制操作数地址步长的参数。BinaryRepeatParams类型，包含操作数相邻迭代间相同datablock的地址步长，操作数同一迭代内不同datablock的地址步长等参数。相邻迭代间的地址步长参数说明请参考repeatStride（相邻迭代间相同datablock的地址步长）；同一迭代内datablock的地址步长参数说明请参考dataBlockStride（同一迭代内不同datablock的地址步长）。

返回值

无

支持的型号

Atlas 训练系列产品

Atlas 推理系列产品 AI Core

Atlas A2 训练系列产品/Atlas 800I A2 推理产品

Atlas 200I/500 A2 推理产品

注意事项

使用tensor高维切分计算接口时，节省地址空间，开发者可以定义一个Tensor，供源操作数与目的操作数同时使用（即地址重叠），相关约束如下：
- 单次迭代内，要求源操作数和目的操作数之间100%重叠，不支持部分重叠。
- 多次迭代间，第N次目的操作数是第N+1次源操作数的情况下，是不支持地址重叠的，因为第N+1次依赖第N次的结果。

使用整个tensor参与计算符号重载时，运算量为目的LocalTensor的总长度。

操作数地址偏移对齐要求请参见通用约束。
特别的，针对uint32_t/int32_t类型的Or操作，支持通过ReinterpretCast的方式来实现：使用Local Tensor的ReinterpretCast转换成uint16_t/int16_t后再调用Or进行计算。直接传入uint32_t/int32_t类型的数据，在不同版本型号上表现会有所差异，考虑到算子在各个版本中的兼容性，不建议使用这种直接传入的方式：
- 整个tensor参与计算和tensor前n个数据计算接口支持传入uint32_t/int32_t类型，但是tensor前n个数据计算的calCount需要设置为期望计算个数的2倍才能精度符合预期；tensor高维切分计算接口直接编译报错提示不支持该数据类型。上述说明适用于以下型号：
  Atlas A2 训练系列产品/Atlas 800I A2 推理产品
- 编译报错提示不支持该数据类型。上述说明适用于以下型号：
  Atlas 训练系列产品
  
  Atlas 推理系列产品 AI Core
- CPU报错提示不支持该数据类型。上述说明适用于以下型号：
  Atlas 200I/500 A2 推理产品

调用示例

本样例中只展示Compute流程中的部分代码。如果您需要运行样例代码，请将该代码段拷贝并替换双目指令样例模板更多样例中的Compute函数即可。

tensor高维切分计算样例-mask连续模式

        
             uint64_t mask = 128;
// repeatTimes = 4, 一次迭代计算128个数, 共计算512个数
// dstBlkStride, src0BlkStride, src1BlkStride = 1, 单次迭代内数据连续读取和写入
// dstRepStride, src0RepStride, src1RepStride = 8, 相邻迭代间数据连续读取和写入
AscendC::Or(dstLocal, src0Local, src1Local, mask, 4, { 1, 1, 1, 8, 8, 8 });

tensor高维切分计算样例-mask逐bit模式

        
             uint64_t mask[2] = { UINT64_MAX, UINT64_MAX };
// repeatTimes = 4, 一次迭代计算128个数, 共计算512个数
// dstBlkStride, src0BlkStride, src1BlkStride = 1, 单次迭代内数据连续读取和写入
// dstRepStride, src0RepStride, src1RepStride = 8, 相邻迭代间数据连续读取和写入
AscendC::Or(dstLocal, src0Local, src1Local, mask, 4, { 1, 1, 1, 8, 8, 8 });

tensor前n个数据计算样例

        
             AscendC::Or(dstLocal, src0Local, src1Local, 512);

结果示例如下：

输入数据(src0Local): [1 2 3 ... 512]
输入数据(src1Local): [513 512 511 ... 2]
输出数据(dstLocal): [513 514 511 ... 514]

父主题： 双目指令