cann-robotupdate vector binary and unary api docs

Abs

产品支持情况

产品	是否支持
Ascend 950PR/Ascend 950DT	√
Atlas A3 训练系列产品/Atlas A3 推理系列产品	√
Atlas A2 训练系列产品/Atlas A2 推理系列产品	√
Atlas 200I/500 A2 推理产品	√
Atlas 推理系列产品AI Core	√
Atlas 推理系列产品Vector Core	x
Atlas 训练系列产品	√
Kirin X90	√
Kirin 9030	√

功能说明

头文件路径为："basic_api/kernel_operator_vec_unary_intf.h"。

Abs属于单目矢量类计算接口，负责将输入的tensor按元素取绝对值。计算公式如下：

$dst_i = |src_i|$

函数原型

tensor前n个数据连续计算

template <typename T>
__aicore__ inline void Abs(const LocalTensor<T>& dst, const LocalTensor<T>& src, const int32_t& count)

tensor前n个复数计算

// 该函数原型，仅支持Ascend 950PR/Ascend 950DT。
template <typename T, typename U>
__aicore__ inline void Abs(const LocalTensor<T>& dst, const LocalTensor<U>& src, const int32_t& count)

tensor高维切分计算

mask逐bit模式

template <typename T, bool isSetMask = true>
__aicore__ inline void Abs(const LocalTensor<T>& dst, const LocalTensor<T>& src, uint64_t mask[], const uint8_t repeatTime, const UnaryRepeatParams& repeatParams)

mask连续模式

template <typename T, bool isSetMask = true>
__aicore__ inline void Abs(const LocalTensor<T>& dst, const LocalTensor<T>& src, uint64_t mask, const uint8_t repeatTime, const UnaryRepeatParams& repeatParams)

参数说明

表 1 模板参数说明

参数名	描述
T	操作数数据类型。
U	tensor前n个复数计算接口中的源操作数数据类型。
isSetMask	是否在接口内部设置mask。 • true，表示在接口内部设置mask。 • false，表示在接口外部设置mask，开发者需要使用SetVectorMask接口设置mask值。这种模式下，本接口入参中的mask值必须设置为占位符`MASK_PLACEHOLDER`。具体使用方式可参考掩码。

表 2 参数说明

参数名	输入/输出	描述
dst	输出	目的操作数。类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。地址对齐约束参考通用地址对齐约束。
src	输入	源操作数。类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。地址对齐约束参考通用地址对齐约束。
count	输入	参与计算的元素个数。关于该参数的具体说明请参考连续计算。
mask[]/mask	输入	mask用于控制每次迭代内参与计算的元素。详细设置参考掩码。
repeatTime	输入	重复迭代次数。矢量计算单元，每次读取连续的256Bytes数据进行计算，为完成对输入数据的处理，必须通过多次迭代（repeat）才能完成所有数据的读取与计算。repeatTime表示迭代的次数。关于该参数的具体说明请参考高维切分。
repeatParams	输入	控制操作数地址步长的参数。UnaryRepeatParams类型，包含操作数相邻迭代间相同DataBlock的地址步长，操作数同一迭代内不同DataBlock的地址步长等参数。相邻迭代间的地址步长参数说明请参考repeatStride；同一迭代内DataBlock的地址步长参数说明请参考dataBlockStride。

数据类型

针对Ascend 950PR/Ascend 950DT
- T支持的数据类型为：int8_t、int16_t、half、int32_t、float、int64_t。数据类型int8_t、int64_t仅支持tensor前n个数据计算接口。
- U支持的数据类型为：complex32、complex64；当U为complex32类型时，T必须是half类型；当U为complex64类型时，T必须是float类型。

针对Atlas A3 训练系列产品/Atlas A3 推理系列产品，T支持的数据类型为：half、float。

针对Atlas A2 训练系列产品/Atlas A2 推理系列产品，T支持的数据类型为：half、float。

针对Atlas 200I/500 A2 推理产品，T支持的数据类型为：int16_t、half、float。

针对Atlas 推理系列产品AI Core，T支持的数据类型为：half、float。

针对Atlas 训练系列产品，T支持的数据类型为：half、float。

针对Kirin X90，T支持的数据类型为：half、float。

针对Kirin 9030，T支持的数据类型为：half、float。

返回值说明

无

约束说明

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

针对如下型号，当参数count或repeatTime取值为0时，不会执行计算操作，不会对目的操作数进行写入，该接口将被视为NOP（空操作）。
- Atlas A3 训练系列产品/Atlas A3 推理系列产品
- Atlas A2 训练系列产品/Atlas A2 推理系列产品

调用示例

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

uint64_t mask = 256 / sizeof(half);
// repeatTime = 4, 128 elements one repeat, 512 elements total.
// dstBlkStride, srcBlkStride = 1, no gap between blocks in one repeat.
// dstRepStride, srcRepStride = 8, no gap between repeats.
AscendC::Abs(dstLocal, srcLocal, mask, 4, { 1, 1, 8, 8 });

结果示例如下：

输入数据srcLocal:[0.0 -1.0 2.0 -3.0 ...]
输出数据dstLocal：[0.0 1.0 2.0 3.0 ...]

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

uint64_t mask[2] = { UINT64_MAX, UINT64_MAX };
// repeatTime = 4, 128 elements one repeat, 512 elements total.
// dstBlkStride, srcBlkStride = 1, no gap between blocks in one repeat.
// dstRepStride, srcRepStride = 8, no gap between repeats.
AscendC::Abs(dstLocal, srcLocal, mask, 4, { 1, 1, 8, 8 });

结果示例如下：

输入数据srcLocal：[0.0 -1.0 2.0 -3.0 ...]
输出数据dstLocal：[0.0 1.0 2.0 3.0 ...]

tensor前n个数据计算接口样例

AscendC::Abs(dstLocal, srcLocal, 512);

结果示例如下：

输入数据srcLocal：[0.0 -1.0 2.0 -3.0 ...]
输出数据dstLocal：[0.0 1.0 2.0 3.0 ...]

针对Ascend 950PR/Ascend 950DT：

tensor前n个复数计算接口样例

LocalTensor<complex64> srcLocal = inQueue.DeQue<complex64>();
LocalTensor<float> dstLocal = outQueue.AllocTensor<float>();
AscendC::Abs(dstLocal, srcLocal, 512);

结果示例如下：

输入数据srcLocal：[1+2j  2-3j ...]
输出数据dstLocal：[2.236 3.605 ...]