---
title: Compare
description: "| 产品 | 是否支持 |"
url: https://www.hiascend.com/document/detail/zh/canncommercial/latest/API/ascendcopapi/atlasascendc_api_07_0066.html
sourcePath: /source/zh/canncommercial/900/API/ascendcopapi/atlasascendc_api_07_0066.html
indexId: 46cdc6015b040632fecb9b1f0de7596d1d987209aa038dddae6e3eee4684b3b376
---
# Compare

#### 产品支持情况

| 产品 | 是否支持 |
| --- | --- |
| Atlas 350 加速卡 | √ |
| Atlas A3 训练系列产品 / Atlas A3 推理系列产品 | √ |
| Atlas A2 训练系列产品 / Atlas A2 推理系列产品 | √ |
| Atlas 200I/500 A2 推理产品 | √ |
| Atlas 推理系列产品 AI Core | √ |
| Atlas 推理系列产品 Vector Core | x |
| Atlas 训练系列产品 | √ |


#### 功能说明

逐元素比较两个tensor大小，如果比较后的结果为真，则输出结果的对应比特位为1，否则为0。

支持多种比较模式：

- LT：小于（less than）
- GT：大于（greater than）

- GE：大于或等于（greater than or equal to）
- EQ：等于（equal to）
- NE：不等于（not equal to）
- LE：小于或等于（less than or equal to）


#### 函数原型

- 整个Tensor参与计算
  1 2 3 4 5 6 dst = src0 < src1; dst = src0 > src1; dst = src0 <= src1; dst = src0 >= src1; dst = src0 == src1; dst = src0 != src1;

  Atlas 200I/500 A2 推理产品 暂不支持整个Tensor参与计算的运算符重载。

- Tensor前n个数据计算
  1 2 template <typename T, typename U> __aicore__ inline void Compare(const LocalTensor<U>& dst, const LocalTensor<T>& src0, const LocalTensor<T>& src1, CMPMODE cmpMode, uint32_t count)

- Tensor高维切分计算

  - mask逐bit模式
    1 2 template <typename T, typename U, bool isSetMask = true> __aicore__ inline void Compare(const LocalTensor<U>& dst, const LocalTensor<T>& src0, const LocalTensor<T>& src1, CMPMODE cmpMode, const uint64_t mask[], uint8_t repeatTime, const BinaryRepeatParams& repeatParams)

  - mask连续模式
    1 2 template <typename T, typename U, bool isSetMask = true> __aicore__ inline void Compare(const LocalTensor<U>& dst, const LocalTensor<T>& src0, const LocalTensor<T>& src1, CMPMODE cmpMode, const uint64_t mask, uint8_t repeatTime, const BinaryRepeatParams& repeatParams)


#### 参数说明


**表1 模板参数说明**

| 参数名 | 描述 |
| --- | --- |
| T | 源操作数数据类型。 Atlas 350 加速卡，支持的数据类型为：int8\_t、uint8\_t、int16\_t、uint16\_t、half、bfloat16\_t、int32\_t、uint32\_t、float、int64\_t、uint64\_t、double。 Atlas A3 训练系列产品 / Atlas A3 推理系列产品 ，支持的数据类型为：half（所有CMPMODE都支持）、float（所有CMPMODE都支持）、 int32\_t（只支持CMPMODE::EQ）。 Atlas A2 训练系列产品 / Atlas A2 推理系列产品 ，支持的数据类型为：half（所有CMPMODE都支持）、float（所有CMPMODE都支持）、 int32\_t（只支持CMPMODE::EQ）。 Atlas 200I/500 A2 推理产品 ，支持的数据类型为：half、float。 Atlas 推理系列产品 AI Core，支持的数据类型为：half、float。 Atlas 训练系列产品 ，支持的数据类型为：half、float。 |
| U | 目的操作数数据类型。 Atlas 350 加速卡，支持的数据类型为：int8\_t、uint8\_t。 Atlas A3 训练系列产品 / Atlas A3 推理系列产品 ，支持的数据类型为：int8\_t、uint8\_t。 Atlas A2 训练系列产品 / Atlas A2 推理系列产品 ，支持的数据类型为：int8\_t、uint8\_t。 Atlas 200I/500 A2 推理产品 ，支持的数据类型为：int8\_t、uint8\_t。 Atlas 推理系列产品 AI Core，支持的数据类型为：int8\_t、uint8\_t。 Atlas 训练系列产品 ，支持的数据类型为：int8\_t、uint8\_t。 |
| isSetMask | 保留参数，保持默认值即可。 |


**表2 接口参数说明**

| 参数名称 | 输入/输出 | 含义 |
| --- | --- | --- |
| dst | 输出 | 目的操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。 dst用于存储比较结果，将dst中uint8\_t类型的数据按照bit位展开，由左至右依次表征对应位置的src0和src1的比较结果，如果比较后的结果为真，则对应比特位为1，否则为0。 |
| src0、src1 | 输入 | 源操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。 |
| cmpMode | 输入 | CMPMODE类型，表示比较模式，包括EQ，NE，GE，LE，GT，LT。 LT:src0小于（less than）src1 GT:src0大于（greater than）src1 GE：src0大于或等于（greater than or equal to）src1 EQ：src0等于（equal to）src1 NE：src0不等于（not equal to）src1 LE：src0小于或等于（less than or equal to）src1 |
| mask/mask[] | 输入 | mask(https://www.hiascend.comdocument/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas\_ascendc\_10\_0022.html\#ZH\-CN\_TOPIC\_0000002562282205\_\_zh\-cn\_topic\_0000002267504656\_zh\-cn\_topic\_0000001764162593\_section4252658182)用于控制每次迭代内参与计算的元素。 Atlas 350 加速卡，设置有效。 Atlas A3 训练系列产品 / Atlas A3 推理系列产品 ，保留参数，设置无效。 Atlas A2 训练系列产品 / Atlas A2 推理系列产品 ，保留参数，设置无效。 Atlas 200I/500 A2 推理产品 ，设置有效。 Atlas 推理系列产品 AI Core，保留参数，设置无效。 Atlas 训练系列产品 ，保留参数，设置无效。 连续模式：表示前面连续的多少个元素参与计算。取值范围和操作数的数据类型有关，数据类型不同，每次迭代内能够处理的元素个数最大值不同。当操作数为16位时，mask∈[1, 128]；当操作数为32位时，mask∈[1, 64]。 逐bit模式：可以按位控制哪些元素参与计算，bit位的值为1表示参与计算，0表示不参与。参数类型为长度为2或者4的uint64\_t类型数组。 例如，mask=[8, 0]，8=0b1000，表示仅第4个元素参与计算。 参数取值范围和操作数的数据类型有关，数据类型不同，每次迭代内能够处理的元素个数最大值不同。当操作数为16位时，mask[0]、mask[1]∈[0, 264\-1]并且不同时为0；当操作数为32位时，mask[1]为0，mask[0]∈(0, 264\-1]。 |
| repeatTime | 输入 | 重复迭代次数。矢量计算单元，每次读取连续的256Bytes数据进行计算，为完成对输入数据的处理，必须通过多次迭代（repeat）才能完成所有数据的读取与计算。repeatTime表示迭代的次数。 关于该参数的具体描述请参考高维切分API(https://www.hiascend.comdocument/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas\_ascendc\_10\_0022.html)。 |
| repeatParams | 输入 | 控制操作数地址步长的参数。BinaryRepeatParams类型，包含操作数相邻迭代间相同datablock的地址步长，操作数同一迭代内不同datablock的地址步长等参数。 相邻迭代间的地址步长参数说明请参考repeatStride(https://www.hiascend.comdocument/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas\_ascendc\_10\_0022.html\#ZH\-CN\_TOPIC\_0000002562282205\_\_zh\-cn\_topic\_0000002267504656\_zh\-cn\_topic\_0000001764162593\_section139459347420)；同一迭代内DataBlock的地址步长参数说明请参考dataBlockStride(https://www.hiascend.comdocument/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas\_ascendc\_10\_0022.html\#ZH\-CN\_TOPIC\_0000002562282205\_\_zh\-cn\_topic\_0000002267504656\_zh\-cn\_topic\_0000001764162593\_section2815124173416)。 |
| count | 输入 | 参与计算的元素个数。设置count时，需要保证count个元素所占空间256字节对齐。 |


#### 返回值说明

无


#### 约束说明

- 操作数地址对齐要求请参见  通用地址对齐约束
。

- dst按照小端顺序排序成二进制结果，对应src中相应位置的数据比较结果。
- 使用整个tensor参与计算的运算符重载功能，src0和src1需满足256字节对齐；使用tensor前n个数据参与计算的接口，设置count时，需要保证count个元素所占空间256字节对齐。
- 针对Atlas 350 加速卡，int8_t/uint8_t/uint64_t/int64_t/double数据类型仅支持tensor前n个数据计算接口和整个tensor参与计算的运算符重载。


#### 调用示例

本样例中，源操作数src0和src1各存储了256个float类型的数据。样例实现的功能为，逐元素对src0和src1中的数据进行比较，如果src0中的元素小于src1中的元素，dst结果中对应的比特位置1；反之，则置0。dst结果使用uint8_t类型数据存储。

- 整个tensor参与计算
  1 2 3 4 5 6 dstLocal = src0Local < src1Local; // 小于 LT dstLocal = src0Local > src1Local; // 大于 GT dstLocal = src0Local <= src1Local; // 小于等于 LE dstLocal = src0Local >= src1Local; // 大于等于 GE dstLocal = src0Local == src1Local; // 等于 EQ dstLocal = src0Local != src1Local; // 不等于 NE


- tensor前n个数据计算
  1 2 3 4 5 6 7 // srcDataSize：参与计算的元素个数 AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::LT, srcDataSize); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::GT, srcDataSize); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::LE, srcDataSize); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::GE, srcDataSize); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::EQ, srcDataSize); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::NE, srcDataSize);

  结果示例如下：

```
LT：小于
输入数据src0Local：[ 2  2  2  2  2  2  2  2  3  3  3  3  3  3  3  3  5  5  5  5  5  5  5  5  7  7  7  7  7  7  7  7
11 11 11 11 11 11 11 11 13 13 13 13 13 13 13 13 17 17 17 17 17 17 17 17 19 19 19 19 19 19 19 19 ]
输入数据src1Local：[ 2  2  2  2  2  2  2  2  4  4  4  4  4  4  4  4  6  6  6  6  6  6  6  6  8  8  8  8  8  8  8  8
10 10 10 10 10 10 10 10 12 12 12 12 12 12 12 12 14 14 14 14 14 14 14 14 16 16 16 16 16 16 16 16 ]
输出数据dstLocal： [ 0 127 127 127 0 0 0 0 ]
GT：大于
输入数据src0Local：[ 2 3 5 7 11 13 17 19 ... ]
输入数据src1Local：[ 2 4 6 8 10 12 14 16 ... ]
逐元素比较结果：   [ 0 0 0 0  1  1  1  1 ... ]
输出数据dstLocal： [ 240(0b11110000) ... ]
GE：大于或等于
输入数据src0Local：[ 2 3 5 7 11 13 17 19 ... ]
输入数据src1Local：[ 2 4 6 8 10 12 14 16 ... ]
输出数据dstLocal： [ 241(0b11110001) ... ]
LE：小于或等于
输入数据src0Local：[ 2 3 5 7 11 13 17 19 ... ]
输入数据src1Local：[ 2 4 6 8 10 12 14 16 ... ]
输出数据dstLocal： [ 15(0b00001111) ... ]
EQ：等于
输入数据src0Local：[ 2 3 5 7 11 13 17 19 ... ]
输入数据src1Local：[ 2 4 6 8 10 12 14 16 ... ]
输出数据dstLocal： [ 1(0b00000001) ... ]
NE：不等于
输入数据src0Local：[ 2 3 5 7 11 13 17 19 ... ]
输入数据src1Local：[ 2 4 6 8 10 12 14 16 ... ]
输出数据dstLocal： [ 126(0b11111110) ... ]
```


- Tensor高维切分计算，mask逐bit模式
  1 2 3 4 5 6 7 8 9 10 11 // masks数组控制每次迭代参与计算的元素，两个uint64_t的值一共128bit，每个bit可以控制一个元素，为1则参与计算，为0则不参与计算 // masks[0]可以控制前64个元素，低bit位控制索引小的元素；masks[1]同理，可以控制后64个元素 // 例如，对float类型数据，每次迭代处理256B / sizeof(float) = 64个元素，因此只需要通过masks[0]即可进行控制 uint64_t masks[2] = {858993459, 0}; // 858993459(0x33333333) // repeat: 1, dstBlkStride: 1, src0BlkStride: 1, src1BlkStride: 1, dstRepStride: 1, src0RepStride: 8, src1RepStride: 8 AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::LT, masks, 1, { 1, 1, 1, 1, 8, 8 }); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::GT, masks, 1, { 1, 1, 1, 1, 8, 8 }); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::LE, masks, 1, { 1, 1, 1, 1, 8, 8 }); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::GE, masks, 1, { 1, 1, 1, 1, 8, 8 }); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::EQ, masks, 1, { 1, 1, 1, 1, 8, 8 }); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::NE, masks, 1, { 1, 1, 1, 1, 8, 8 });

  结果示例如下：

```
LE：小于等于
输入数据src0Local：[ 2  2  2  2  2  2  2  2  3  3  3  3  3  3  3  3  5  5  5  5  5  5  5  5  7  7  7  7  7  7  7  7
11 11 11 11 11 11 11 11 13 13 13 13 13 13 13 13 17 17 17 17 17 17 17 17 19 19 19 19 19 19 19 19 ]
输入数据src1Local：[ 2  2  2  2  2  2  2  2  4  4  4  4  4  4  4  4  6  6  6  6  6  6  6  6  8  8  8  8  8  8  8  8
10 10 10 10 10 10 10 10 12 12 12 12 12 12 12 12 14 14 14 14 14 14 14 14 16 16 16 16 16 16 16 16 ]
输入数据masks：{ 858993459, 0 }
输出数据dstLocal： [ 51 51 51 51 0 0 0 0 ]
```


- Tensor高维切分计算，mask连续模式
  1 2 3 4 5 6 7 8 9 10 // mask控制每次迭代参与计算的连续元素个数 // 例如，对float类型数据，每次迭代处理256B / sizeof(float) = 64个元素，因此mask可取值1至64 uint64_t mask = 28; // repeat: 1, dstBlkStride: 1, src0BlkStride: 1, src1BlkStride: 1, dstRepStride: 1, src0RepStride: 8, src1RepStride: 8 AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::LT, mask, 1, { 1, 1, 1, 1, 8, 8 }); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::GT, mask, 1, { 1, 1, 1, 1, 8, 8 }); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::LE, mask, 1, { 1, 1, 1, 1, 8, 8 }); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::GE, mask, 1, { 1, 1, 1, 1, 8, 8 }); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::EQ, mask, 1, { 1, 1, 1, 1, 8, 8 }); AscendC::Compare(dstLocal, src0Local, src1Local, AscendC::CMPMODE::NE, mask, 1, { 1, 1, 1, 1, 8, 8 });

  结果示例如下：

```
LE：小于等于
输入数据src0Local：[ 2  2  2  2  2  2  2  2  3  3  3  3  3  3  3  3  5  5  5  5  5  5  5  5  7  7  7  7  7  7  7  7
11 11 11 11 11 11 11 11 13 13 13 13 13 13 13 13 17 17 17 17 17 17 17 17 19 19 19 19 19 19 19 19 ]
输入数据src1Local：[ 2  2  2  2  2  2  2  2  4  4  4  4  4  4  4  4  6  6  6  6  6  6  6  6  8  8  8  8  8  8  8  8
10 10 10 10 10 10 10 10 12 12 12 12 12 12 12 12 14 14 14 14 14 14 14 14 16 16 16 16 16 16 16 16 ]
输入数据mask：28
输出数据dstLocal： [ 127 127 127 16 0 0 0 0 ]
```
