产品支持情况

产品	是否支持
Ascend 950PR/Ascend 950DT	√
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

功能说明

根据mask对源操作数srcReg0、srcReg1进行按元素相减操作，将结果写入目的操作数dstReg。计算公式如下：

$\text{[math]}$

若srcReg0，srcReg1相减产生借位结果时，在MaskReg carry中对应位置每4bit的最低位写0，否则写1。

具体的示例如下：

表1 示例说明
数据类型	是否借位	示例说明
int32_t数据类型	不产生借位	a_i = 5, b_i = 2 dst_i = a_i - b_i = 3 carry中对应位置每4bit的最低位写1：carry_i = 1
int32_t数据类型	产生借位	a_i = 5, b_i = -7 dst_i = a_i - b_i = 12 carry中对应位置每4bit的最低位写0：carry_i = 0
uint32_t数据类型	不产生借位	a_i = 5, b_i = 2, dst_i = a_i - b_i = 3 carry中对应位置每4bit的最低位写1：carry_i = 1
uint32_t数据类型	产生借位	a_i = 5, b_i = 7 dst_i = a_i - b_i = -2 carry中对应位置每4bit的最低位写0：carry_i = 0

函数原型

计算结果不保留进位

template <typename T = DefaultType, MaskMergeMode mode = MaskMergeMode::ZEROING, typename U>
__simd_callee__ inline void Sub(U& dstReg, U& srcReg0, U& srcReg1, MaskReg& mask)

计算结果保留进位

template <typename T = DefaultType, typename U>
__simd_callee__ inline void Sub(MaskReg& carry, U& dstReg, U& srcReg0, U& srcReg1, MaskReg& mask)

参数说明

表2 模板参数说明
参数名	描述
T	操作数数据类型。 Ascend 950PR/Ascend 950DT，支持的数据类型为：uint8_t/int8_t/uint16_t/int16_t/uint32_t/int32_t/half/float/bfloat16_t/uint64_t/int64_t/complex32/complex64
mode	选择MERGING模式或ZEROING模式。 ZEROING, mask未筛选的元素在dstReg中置零。 MERGING, 当前不支持。
U	目的操作数的RegTensor类型，例如RegTensor<half>，由编译器自动推导，用户不需要填写。

表3 参数说明
参数名	输入/输出	描述
dstReg	输出	目的操作数。类型为RegTensor。
srcReg0	输入	源操作数。类型为RegTensor。数据类型需要与目的操作数保持一致。
srcReg1	输入	源操作数。类型为RegTensor。数据类型需要与目的操作数保持一致。
carry	输出	目的操作数。输出进位值。类型为MaskReg。
mask	输入	源操作数元素操作的有效指示，详细说明请参考MaskReg。

返回值说明

无

约束说明

无

调用示例

计算结果不保留进位

template<typename T>
__simd_vf__ inline void SubVF(__ubuf__ T* dstAddr, __ubuf__ T* src0Addr, __ubuf__ T* src1Addr, uint32_t count, uint32_t oneRepeatSize, uint16_t repeatTimes)
{
    AscendC::Reg::RegTensor<T> srcReg0;
    AscendC::Reg::RegTensor<T> srcReg1;
    AscendC::Reg::RegTensor<T> dstReg;
    AscendC::Reg::MaskReg mask;    
    for (uint16_t i = 0; i < repeatTimes; i++) {
        mask = AscendC::Reg::UpdateMask<T>(count);
        AscendC::Reg::LoadAlign(srcReg0, src0Addr + i * oneRepeatSize);
        AscendC::Reg::LoadAlign(srcReg1, src1Addr + i * oneRepeatSize);
        AscendC::Reg::Sub(dstReg, srcReg0, srcReg1, mask);
        AscendC::Reg::StoreAlign(dstAddr + i * oneRepeatSize, dstReg, mask);
    }
}

计算结果保留进位

template <typename T>
__simd_vf__ inline void SubVF(__ubuf__ T* dst0Addr, __ubuf__ T* dst1Addr, __ubuf__ T* src0Addr, __ubuf__ T* src1Addr, uint32_t count, uint32_t repeatTimes, uint16_t oneRepeatSize){
    
    AscendC::Reg::RegTensor<T> srcReg0;
    AscendC::Reg::RegTensor<T> srcReg1;
    AscendC::Reg::RegTensor<T> dstReg0;
    AscendC::Reg::MaskReg mask;   
    AscendC::Reg::MaskReg carry = AscendC::Reg::CreateMask<uint8_t>();
    for (uint16_t i = 0; i < repeatTimes; i++) {
        mask = AscendC::Reg::UpdateMask<T>(count);
        AscendC::Reg::LoadAlign(srcReg0, src0Addr + i * oneRepeatSize);
        AscendC::Reg::LoadAlign(srcReg1, src1Addr + i * oneRepeatSize);
        AscendC::Reg::Sub(carry, dstReg0, srcReg0, srcReg1, mask);
        // 8*4B=32B align
        AscendC::Reg::StoreAlign<uint32_t, AscendC::Reg::MaskDist::DIST_NORM>((__ubuf__ uint32_t*)dst1Addr + i * 8, carry);
        AscendC::Reg::StoreAlign(dst0Addr + i * oneRepeatSize, dstReg0, mask);
    }
}