功能说明

源操作数内每个element做右移，右移的位数由输入参数scalar决定。

对数据类型uint16_t/uint32_t的源操作数做逻辑右移，对数据类型int16_t/int32_t的源操作数做算术右移。

逻辑右移为去掉最低位，最高位填充为0。

算术右移为去掉最低位，最高位复制符号位。

例：数据类型uint16_t，二进制数 1010101010101010，逻辑右移一位结果为 0101010101010101；

数据类型int16_t，二进制数 1010101010101010，算术右移一位结果为 1101010101010101；

数据类型int16_t，二进制数 1010101010101010，算术右移三位结果为 1111010101010101。

函数原型

表1 0-2级接口原型定义
接口级别	原型定义
0级接口	mask参数使用逐bit模式，该模式的具体介绍请参考下文中的mask参数说明： template <typename T> __aicore__ inline void ShiftRight(const LocalTensor<T>& dstLocal, const LocalTensor<T>& srcLocal, const T& scalarValue, uint64_t mask[2], const uint8_t repeatTimes, const UnaryRepeatParams& repeatParams，bool roundEn) mask参数使用连续模式，该模式的具体介绍请参考下文中的mask参数说明： template <typename T> __aicore__ inline void ShiftRight(const LocalTensor<T>& dstLocal, const LocalTensor<T>& srcLocal, const T& scalarValue, uint64_t mask, const uint8_t repeatTimes, const UnaryRepeatParams& repeatParams，bool roundEn)
2级接口	template <typename T> __aicore__ inline void ShiftRight(const LocalTensor<T>& dstLocal, const LocalTensor<T>& srcLocal, const T& scalarValue, const int32_t& calCount)

参数说明

表2 0级接口参数说明
参数名称	类型	说明
dstLocal	输出	目的操作数，类型为LocalTensor。LocalTensor数据结构的定义请参考LocalTensor。 Atlas A2训练系列产品，支持的数据类型为：Tensor（uint16/int16/uint32/int32）
srcLocal	输入	源操作数，类型为LocalTensor。数据类型需要与目的操作数保持一致。 Atlas A2训练系列产品，支持的数据类型为：Tensor（uint16/int16/uint32/int32）
scalarValue	输入	源操作数，数据类型需要与目的操作数Tensor中的元素数据类型保持一致当src为uint16_t/int16_t类型时，scalar取值范围：[0, 16]。当src为uint32_t/int32_t类型时，scalar取值范围：[0, 32]。 Atlas A2训练系列产品，支持的数据类型为：uint16/int16/uint32/int32
mask	输入	element操作有效指示，共128bits，每一个bit位用来表示Vector的每个元素是否参与操作，bit位的值为1表示参与计算，0表示不参与计算。连续模式：传入类型为uint64_t的数，表示前面的连续的多少个elements参与计算。逐比特模式：传入长度为2的uint64_t数组，逐bits表示vector的每个元素是否参与操作，bit位的值为1表示参与计算，0表示不参与。mask[0]对应低64个元素操作，mask[1]对应高64个元素操作。
repeatTimes	输入	重复迭代次数。矢量计算单元，每次读取连续的256 Bytes数据进行计算，为完成对输入数据的处理，必须通过多次迭代（repeat）才能完成所有数据的读取与计算。repeatTimes表示迭代的次数。关于该参数的具体描述请参考重复迭代次数-Repeat times。
repeatParams	输入	元素操作控制结构信息，具体请参考UnaryRepeatParams。
roundEn	输入	舍入功能使能开关，支持数据类型：bool，true为使能，false为不使能。仅当src为int16_t/int32_t类型时使能有效。例：使能舍入功能，src数据类型为int16_t，将src算数右移5位，如果src_ele二进制数中的第5位为1，则dst_ele值为对src_ele算术右移5后加1。 src_ele = 17 = 0b0000000000010001 第五位为1 dst_ele = arithmetic_righ_shift(src_ele, 5) + 1 = 0b0000000000000000 + 1 = 0b0000000000000001

表3 2级接口参数说明
参数名称	类型	说明
dstLocal	输出	目的操作数，类型为LocalTensor。LocalTensor数据结构的定义请参考LocalTensor。 Atlas A2训练系列产品，支持的数据类型为：Tensor（uint16/int16/uint32/int32）
srcLocal	输入	源操作数，类型为LocalTensor。数据类型需要与目的操作数保持一致。 Atlas A2训练系列产品，支持的数据类型为：Tensor（uint16/int16/uint32/int32）
scalarValue	输入	源操作数，数据类型需要与目的操作数Tensor中的元素数据类型保持一致当src为uint16_t/int16_t类型时，scalar取值范围：[0, 16]。当src为uint32_t/int32_t类型时，scalar取值范围：[0, 32]。 Atlas A2训练系列产品，支持的数据类型为：uint16/int16/uint32/int32
calCount	输入	输入数据元素个数，适用于2级接口。参数取值范围和操作数的数据类型有关，数据类型不同，能够处理的元素个数最大值不同。矢量计算单元，每个迭代读取连续256 Bytes数据进行计算，通过多次迭代完成所有数据的读取与计算。所以当操作数为16位时，calCount∈[1，128255]，255表示迭代次数的最大值，128表示每次迭代内能够处理128个16位数据；当操作数为32位时，calCount∈[1，64255]，64表示每次迭代内能够处理64个32位数据。

返回值

无

支持的型号

Atlas A2训练系列产品

注意事项

当src为uint16_t/int16_t类型时，scalar取值范围：[0, 16]。
当src为uint32_t/int32_t类型时，scalar取值范围：[0, 32]。

使用0级接口时，节省地址空间，开发者可以定义一个Tensor，供源操作数与目的操作数同时使用（即地址重叠），相关约束如下：
- 对于单次repeat（repeatTimes=1），且源操作数与目的操作数之间要求100%完全重叠，不支持部分重叠。
- 对于多次repeat（repeatTimes>1），操作数与目的操作数之间存在依赖的情况下，即第N次迭代的目的操作数是第N+1次的源操作数，不支持地址重叠的。

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

调用示例

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

0级接口样例-mask连续模式

uint64_t mask = 128;
int16_t scalar = 2;
// repeatTimes = 4, 单次迭代处理128个数，计算512个数需要迭代4次
// dstBlkStride, srcBlkStride = 1, 每个迭代内src0参与计算的数据地址间隔为1个block，表示单次迭代内数据连续读取和写入
// dstRepStride, srcRepStride = 8, 相邻迭代间的地址间隔为8个block，表示相邻迭代间数据连续读取和写入
ShiftRight(dstLocal, srcLocal, scalar, mask, 4, { 1, 1, 8, 8 }, false);

0级接口样例-mask逐bit模式

uint64_t mask[2] = { UINT64_MAX, UINT64_MAX };
int16_t scalar = 2;
// repeatTimes = 4, 单次迭代处理128个数，计算512个数需要迭代4次
// dstBlkStride, srcBlkStride = 1, 每个迭代内src0参与计算的数据地址间隔为1个block，表示单次迭代内数据连续读取和写入
// dstRepStride, srcRepStride = 8, 相邻迭代间的地址间隔为8个block，表示相邻迭代间数据连续读取和写入
ShiftRight(dstLocal, srcLocal, scalar, mask, 4, {1, 1, 8, 8}, false);

2级接口样例

int16_t scalar = 2;
ShiftRight(dstLocal, srcLocal, scalar, 512);

结果示例如下：

输入数据(src0Local): [1 2 3 ... 512]
输入数据 scalar = 2
输出数据(dstLocal): [0 0 0 1 1 1 1 ... 128]