aclnnRemainderTensorScalar&aclnnInplaceRemainderTensorScalar

产品支持情况

产品	是否支持
[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]	√
[object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]	√
[object Object]Atlas 200I/500 A2 推理产品[object Object]	×
[object Object]Atlas 推理系列产品 [object Object]	×
[object Object]Atlas 训练系列产品[object Object]	√

功能说明

• 算子功能：将tensor self中的每个元素都转换为除以scalar other以后得到的余数。该结果与除数other同符号，并且该结果的绝对值是小于other的绝对值。

• 实际计算remainder(self, other) 等效于以下公式：

  $$out_i = self_i - floor(self_i / other) * other$$

• 示例：

  [object Object]

函数原型

• aclnnRemainderTensorScalar和aclnnInplaceRemainderTensorScalar实现相同的功能，使用区别如下，请根据自身实际场景选择合适的算子。

  • aclnnRemainderTensorScalar：需新建一个输出张量对象存储计算结果。
  • aclnnInplaceRemainderTensorScalar：无需新建输出张量对象，直接在输入张量的内存中存储计算结果。

• 每个算子分为undefined，必须先调用“aclnnRemainderTensorScalarGetWorkspaceSize”或者”aclnnInplaceRemainderTensorScalarGetWorkspaceSize“接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnRemainderTensorScalar”或者”aclnnInplaceRemainderTensorScalar“接口执行计算。

  • aclnnStatus aclnnRemainderTensorScalarGetWorkspaceSize(const aclTensor *self, const aclScalar *other, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
  • aclnnStatus aclnnRemainderTensorScalar(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)
  • aclnnStatus aclnnInplaceRemainderTensorScalarGetWorkspaceSize(aclTensor *selfRef, const aclScalar *other, uint64_t *workspaceSize, aclOpExecutor **executor)
  • aclnnStatus aclnnInplaceRemainderTensorScalar(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnRemainderTensorScalarGetWorkspaceSize

• 参数说明：

  • self(aclTensor*, 计算输入)：公式中的输入self，支持undefined，undefined支持ND，数据维度不支持8维以上。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持INT32、INT64、FLOAT16、FLOAT、DOUBLE、BFLOAT16。数据类型与other的数据类型需满足数据类型推导规则（参见undefined）。
    • [object Object]Atlas 训练系列产品[object Object]：数据类型支持INT32、INT64、FLOAT16、FLOAT、DOUBLE。数据类型与other的数据类型需满足数据类型推导规则（参见undefined）。

  • other(aclScalar*, 计算输入)：公式中的输入other。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持INT32、INT64、FLOAT16、FLOAT、DOUBLE、BFLOAT16。数据类型与self的数据类型需满足数据类型推导规则（参见undefined）。
    • [object Object]Atlas 训练系列产品[object Object]：数据类型支持INT32、INT64、FLOAT16、FLOAT、DOUBLE。数据类型与self的数据类型需满足数据类型推导规则（参见undefined）。

  • out(aclTensor*, 计算输出)：公式中的输出out，数据类型需要是self与other推导之后可转换的数据类型。shape需要与self一致。支持undefined，undefined支持ND，数据维度不支持8维以上。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持UINT8、INT8、INT16、INT32、INT64、FLOAT16、FLOAT、DOUBLE、COMPLEX64、COMPLEX128、BFLOAT16。
    • [object Object]Atlas 训练系列产品[object Object]：数据类型支持UINT8、INT8、INT16、INT32、INT64、FLOAT16、FLOAT、DOUBLE、COMPLEX64、COMPLEX128。

  • workspaceSize(uint64_t *，出参)：返回需要在Device侧申请的workspace大小。

  • executor(aclOpExecutor **，出参)：返回op执行器，包含了算子计算流程。

• 返回值：

  aclnnStatus：返回状态码，具体参见undefined。

  [object Object]

aclnnRemainderTensorScalar

• 参数说明：

  • workspace(void*，入参)：在Device侧申请的workspace内存地址。

  • workspaceSize(uint64_t，入参)：在Device侧申请的workspace大小，由第一段接口aclnnRemainderTensorScalarGetWorkspaceSize获取。

  • executor(aclOpExecutor *，入参)：op执行器，包含了算子计算流程。

  • stream(aclrtStream，入参)：指定执行任务的Stream。

• 返回值：

  aclnnStatus：返回状态码，具体参见undefined。

aclnnInplaceRemainderTensorScalarGetWorkspaceSize

• 参数说明

  • selfRef(aclTensor*, 计算输入|计算输出)：输入输出tensor。支持undefined，undefined支持ND，数据维度不支持8维以上。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持INT32、INT64、FLOAT16、FLOAT、DOUBLE、BFLOAT16。数据类型与other的数据类型需满足数据类型推导规则（参见undefined），且需要是推导之后可转换的数据类型。
    • [object Object]Atlas 训练系列产品[object Object]：数据类型支持INT32、INT64、FLOAT16、FLOAT、DOUBLE。数据类型与other的数据类型需满足数据类型推导规则（参见undefined），且需要是推导之后可转换的数据类型。
  • other(aclScalar*, 计算输入)：公式中的输入other。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持INT32、INT64、FLOAT16、FLOAT、DOUBLE、BFLOAT16。数据类型与selfRef的数据类型需满足数据类型推导规则（参见undefined）。
    • [object Object]Atlas 训练系列产品[object Object]：数据类型支持INT32、INT64、FLOAT16、FLOAT、DOUBLE。 数据类型与selfRef的数据类型需满足数据类型推导规则（参见undefined）。
  • workspaceSize(uint64_t *，出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **，出参)：返回op执行器，包含了算子计算流程。

• 返回值： aclnnStatus：返回状态码，具体参见undefined。

  [object Object]

aclnnInplaceRemainderTensorScalar

• 参数说明：

  • workspace(void*，入参)：在Device侧申请的workspace内存地址。
  • workspaceSize(uint64_t，入参)：在Device侧申请的workspace大小，由第一段接口aclnnInplaceRemainderTensorScalarGetWorkspaceSize获取。
  • executor(aclOpExecutor *，入参)：op执行器，包含了算子计算流程。
  • stream(aclrtStream，入参)：指定执行任务的Stream。

• 返回值： aclnnStatus：返回状态码，具体参见undefined。

约束说明

• 当self的数据类型为INT32时，优先保障在范围[-2^24, 2^24]内的功能和精度；
• 当other为0，且self的数据类型为整型时，out的结果为self。

调用示例

示例代码如下，仅供参考，具体编译和执行过程请参考undefined。 aclnnRemainderTensorScalar示例代码：

aclnnInplaceRemainderTensorScalar示例代码：