Adds（灵活标量位置）
产品支持情况
- Ascend 950PR/Ascend 950DT：支持
- Atlas A3 训练系列产品/Atlas A3 推理系列产品：不支持
- Atlas A2 训练系列产品/Atlas A2 推理系列产品：不支持
- Atlas 200I/500 A2 推理产品：不支持
- Atlas 推理系列产品AI Core：不支持
- Atlas 推理系列产品Vector Core：不支持
- Atlas 训练系列产品：不支持
功能说明
头文件路径为："basic_api/kernel_operator_vec_binary_scalar_intf.h"。
Adds属于双目标量类计算接口，矢量内每个元素和标量间做加法，支持标量在前和标量在后两种场景。其中标量输入支持配置LocalTensor单点元素，计算公式如下：
函数原型
tensor前n个数据计算
C++template <typename T = BinaryDefaultType, bool isSetMask = true, const BinaryConfig& config = DEFAULT_BINARY_CONFIG, typename U, typename S, typename V> __aicore__ inline void Adds(const U& dst, const S& src0, const V& src1, const int32_t& count)tensor高维切分计算
mask逐bit模式
C++template <typename T = BinaryDefaultType, bool isSetMask = true, const BinaryConfig& config = DEFAULT_BINARY_CONFIG, typename U, typename S, typename V> __aicore__ inline void Adds(const U& dst, const S& src0, const V& src1, uint64_t mask[], const uint8_t repeatTime, const UnaryRepeatParams& repeatParams)mask连续模式
C++template <typename T = BinaryDefaultType, bool isSetMask = true, const BinaryConfig& config = DEFAULT_BINARY_CONFIG, typename U, typename S, typename V> __aicore__ inline void Adds(const U& dst, const S& src0, const V& src1, uint64_t mask, const uint8_t repeatTime, const UnaryRepeatParams& repeatParams)
参数说明
表1 模板参数说明
| 参数名 | 描述 |
|---|---|
| T | 操作数数据类型。 对于灵活标量位置接口，为预留参数，暂未启用，为后续的功能扩展做保留，需要指定时，传入默认值BinaryDefaultType即可。 |
| isSetMask | 是否在接口内部设置mask模式和mask值。 • true：表示在接口内部设置mask。 • false：表示在接口外部设置mask，开发者需要使用SetVectorMask接口设置mask值。这种模式下，接口入参中的mask值必须设置为占位符MASK_PLACEHOLDER。 具体使用方式可参考掩码。 |
| config | 类型为BinaryConfig，当标量为LocalTensor单点元素类型时生效，用于指定单点元素操作数位置。默认值DEFAULT_BINARY_CONFIG，表示右操作数为标量。struct BinaryConfig { |
| U | LocalTensor类型，根据输入参数dst自动推导相应的数据类型，开发者无需配置该参数，保证dst满足数据类型的约束即可。 |
| S | LocalTensor类型或标量类型，根据输入参数src0自动推导相应的数据类型，开发者无需配置该参数，保证src0满足数据类型的约束即可。 |
| V | LocalTensor类型或标量类型，根据输入参数src1自动推导相应的数据类型，开发者无需配置该参数，保证src1满足数据类型的约束即可。 |
表2 参数说明
| 参数名称 | 类型 | 说明 |
|---|---|---|
| dst | 输出 | 目的操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 地址对齐约束参考地址对齐约束。 |
| src0/src1 | 输入 | 灵活标量位置接口中源操作数。 • 类型为LocalTensor：可作矢量操作数或标量单点元素，TPosition支持VECIN/VECCALC/VECOUT。地址对齐约束参考地址对齐约束。 • 类型为标量。 |
| count | 输入 | 参与计算的元素个数。关于该参数的具体说明请参考连续计算。 |
| mask/mask[] | 输入 | mask用于控制每次迭代内参与计算的元素。详细设置参考掩码。 |
| repeatTime | 输入 | 重复迭代次数。矢量计算单元，每次读取连续的256Bytes数据进行计算，为完成对输入数据的处理，必须通过多次迭代（repeat）才能完成所有数据的读取与计算。repeatTime表示迭代的次数。 关于该参数的具体说明请参考高维切分。 |
| repeatParams | 输入 | 控制操作数地址步长的参数。UnaryRepeatParams类型，包含操作数相邻迭代间相同DataBlock的地址步长，操作数同一迭代内不同DataBlock的地址步长等参数。 相邻迭代间的地址步长参数说明请参考repeatStride；同一迭代内DataBlock的地址步长参数说明请参考dataBlockStride。 |
数据类型
针对Ascend 950PR/Ascend 950DT，支持的数据为uint8_t、int8_t、half、bfloat16_t、int16_t、float、int32_t、uint64_t、int64_t、complex32、complex64，其中int8_t、uint8_t、uint64_t、int64_t、complex32、complex64数据类型仅支持tensor前n个数据计算接口。
返回值说明
无
约束说明
- 操作数地址对齐要求请参见通用地址对齐约束。
- 操作数地址重叠约束请参考通用地址重叠约束。
- 调用灵活标量位置接口且源操作数为LocalTensor单点元素的场景，不支持源操作数和目的操作数地址重叠。
- 左操作数及右操作数中，必须有一个为矢量；当前不支持左右操作数同时为标量。
- 本接口传入LocalTensor单点数据作为标量时，idx参数需要传入编译期已知的常量，传入变量时需要声明为constexpr。
- 针对Ascend 950PR/Ascend 950DT：该接口通过VF调用Reg矢量计算API实现兼容，当参数count或repeatTime取值为0时，软仿行为不保证该接口被视为NOP（空操作）。
- 对UB空间的占用说明。针对Ascend 950PR/Ascend 950DT：
- tensor高维切分计算占用8KB Unified Buffer。
- tensor前n个数据连续计算不涉及8KB Unified Buffer的占用。
- 针对Ascend 950PR/Ascend 950DT，tensor前n个数据计算API中的isSetMask参数不生效，保持默认值即可。
调用示例
更多样例可参考LINK。
tensor高维切分计算样例-mask连续模式
C++uint64_t mask = 128; // repeatTime = 4, 单次迭代处理128个数，计算512个数需要迭代4次 // dstBlkStride, srcBlkStride = 1, 每个迭代内src0参与计算的数据地址间隔为1个datablock，表示单次迭代内数据连续读取和写入 // dstRepStride, srcRepStride = 8, 相邻迭代间的地址间隔为8个datablock，表示相邻迭代间数据连续读取和写入 // 标量在后调用示例 AscendC::Adds(dstLocal, src0Local, src1Local[0], mask, 4, { 1, 1, 8, 8 }); // 标量在前调用示例 static constexpr AscendC::BinaryConfig config = { 0 }; AscendC::Adds<BinaryDefaultType, true, config>(dstLocal, src0Local[0], src1Local, mask, 4, { 1, 1, 8, 8 });tensor高维切分计算样例-mask逐bit模式
C++uint64_t mask[2] = { UINT64_MAX, UINT64_MAX }; // repeatTime = 4, 单次迭代处理128个数，计算512个数需要迭代4次 // dstBlkStride, srcBlkStride = 1, 每个迭代内src0参与计算的数据地址间隔为1个datablock，表示单次迭代内数据连续读取和写入 // dstRepStride, srcRepStride = 8, 相邻迭代间的地址间隔为8个datablock，表示相邻迭代间数据连续读取和写入 // 标量在后调用示例 AscendC::Adds(dstLocal, src0Local, src1Local[0], mask, 4, {1, 1, 8, 8}); // 标量在前调用示例 static constexpr AscendC::BinaryConfig config = { 0 }; AscendC::Adds<BinaryDefaultType, true, config>(dstLocal, src0Local[0], src1Local, mask, 4, { 1, 1, 8, 8 });tensor前n个数据计算样例
C++// 标量在后调用示例 AscendC::Adds(dstLocal, src0Local, src1Local[0], 512); // 标量在前调用示例 static constexpr AscendC::BinaryConfig config = { 0 }; AscendC::Adds<BinaryDefaultType, true, config>(dstLocal, src0Local[0], src1Local, 512);
结果示例如下：
Bash
// src0Local[0]或src1Local[0]作为标量
输入数据src0Local：[1 2 3 ... 512]
输入数据src1Local：[1 2 3 ... 512]
输出数据dstLocal：[2 3 4 ... 513]