功能说明

源操作数矢量内每个element与标量相比，如果比标量大，则取源操作数值，比标量的值小，则取标量值。

$\text{[math]}$

函数原型

tensor前n个数据计算
 template <typename T, bool isSetMask = true> __aicore__ inline void Maxs(const LocalTensor<T>& dstLocal, const LocalTensor<T>& srcLocal, const T& scalarValue, const int32_t& calCount)
tensor高维切分计算
- mask逐bit模式
   template <typename T, bool isSetMask = true> __aicore__ inline void Maxs(const LocalTensor<T>& dstLocal, const LocalTensor<T>& srcLocal, const T& scalarValue, uint64_t mask[2], const uint8_t repeatTimes, const UnaryRepeatParams& repeatParams)
- mask连续模式
   template <typename T, bool isSetMask = true> __aicore__ inline void Maxs(const LocalTensor<T>& dstLocal, const LocalTensor<T>& srcLocal, const T& scalarValue, uint64_t mask, const uint8_t repeatTimes, const UnaryRepeatParams& repeatParams)

参数说明

表1 模板参数说明
参数名	描述
T	操作数数据类型。
isSetMask	是否在接口内部设置mask。 true，表示在接口内部设置mask。 false，表示在接口外部设置mask，开发者需要使用SetVectorMask接口设置mask值。这种模式下，本接口入参中的mask值必须设置为MASK_PLACEHOLDER。

表2 参数说明
参数名称	类型	说明
dstLocal	输出	目的操作数。类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 Atlas推理系列产品AI Core，支持的数据类型为：Tensor（half/int16_t/float/int32_t） Atlas A2训练系列产品/Atlas 800I A2推理产品，支持的数据类型为：Tensor（half/int16_t/float/int32_t） Atlas 200I/500 A2推理产品，支持的数据类型为：Tensor（half/int16_t/float/int32_t）
srcLocal	输入	源操作数。类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。数据类型需要与目的操作数保持一致。 Atlas推理系列产品AI Core，支持的数据类型为：Tensor（half/int16_t/float/int32_t） Atlas A2训练系列产品/Atlas 800I A2推理产品，支持的数据类型为：Tensor（half/int16_t/float/int32_t） Atlas 200I/500 A2推理产品，支持的数据类型为：Tensor（half/int16_t/float/int32_t）
scalarValue	输入	源操作数，数据类型需要与目的操作数Tensor中元素的数据类型保持一致 Atlas推理系列产品AI Core，支持的数据类型为：half/int16_t/float/int32_t Atlas A2训练系列产品/Atlas 800I A2推理产品，支持的数据类型为：half/int16_t/float/int32_t Atlas 200I/500 A2推理产品，支持的数据类型为：half/int16_t/float/int32_t
calCount	输入	输入数据元素个数。
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表示迭代的次数。关于该参数的具体描述请参考基础API通用说明。
repeatParams	输入	元素操作控制结构信息，具体请参考UnaryRepeatParams。

返回值

无

支持的型号

Atlas推理系列产品AI Core

Atlas A2训练系列产品/Atlas 800I A2推理产品

Atlas 200I/500 A2推理产品

注意事项

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

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

调用示例

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

tensor高维切分计算样例-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，表示相邻迭代间数据连续读取和写入
Maxs(dstLocal, srcLocal, scalar, mask, 4, { 1, 1, 8, 8 });

tensor高维切分计算样例-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，表示相邻迭代间数据连续读取和写入
Maxs(dstLocal, srcLocal, scalar, mask, 4, {1, 1, 8, 8});

tensor前n个数据计算样例

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

结果示例如下：

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