aclnnTril&aclnnInplaceTril

支持的产品型号

Atlas 训练系列产品。
Atlas A2训练系列产品。

接口原型

aclnnTril和aclnnInplaceTril实现相同的功能，使用区别如下，请根据自身实际场景选择合适的算子。
- aclnnTril：需新建一个输出张量对象存储计算结果。
- aclnnInplaceTril：无需新建输出张量对象，直接在输入张量的内存中存储计算结果。
每个算子分为，必须先调用 “aclnnTrilGetWorkspaceSize” 或者 “aclnnInplaceTrilGetWorkspaceSize” 接口获取入参并根据计算流程计算所需workspace大小，再调用 “aclnnTril” 或者 “aclnnInplaceTril” 接口执行计算。
- aclStatus aclnnTrilGetWorkspaceSize(const aclTensor *self, int64_t diagonal, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
- aclStatus aclnnTril(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor， aclrtStream stream)
- aclStatus aclnnInplaceTrilGetWorkspaceSize(const aclTensor *selfRef, int64_t diagonal, uint64_t *workspaceSize, aclOpExecutor **executor)
- aclStatus aclnnInplaceTril(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor， aclrtStream stream)

功能描述

算子功能：返回输入矩阵（2-D Tensor）或多个矩阵的下三角部分，结果Tensorout的其他元素设置为0。

矩阵的下三角形部分定义为对角线下面(包含对角线)的元素。参数diagonal控制的是对角线。如果diagonal=0,则保留主对角线和下面的所有元素。正值包括主对角线上方同样多的对角线，同样的，负数排除主对角线下方同样多的对角线。主对角线是一组索引 $\{(i,i)\}$ for $i in [0,min\{d_1,d_2\}-1]$ 其中 $d_1,d_2$ 是矩阵的维度。

aclnnTrilGetWorkspaceSize

参数说明：
- self(aclTensor*, 计算输入)：Device侧的aclTensor，数据类型支持DOUBLE,FLOAT,FLOAT16,BFLOAT16(仅Atlas A2训练系列产品支持),INT16,INT32,INT64,INT8,UINT16,UINT32,UINT64,UINT8,BOOL。支持，支持ND。
- diagonal(int64_t, 计算输入)：对角线的位置，数据类型支持INT。
- out(aclTensor*, 计算输入)：Device侧的aclTensor，数据类型需要与self保持一致。
- workspaceSize(uint64_t*, 出参)：返回用户需要在Device侧申请的workspace大小。
- executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。
返回值：

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

[object Object]

aclnnTril

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

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

aclnnInplaceTrilGetWorkspaceSize

参数说明：
- selfRef(aclTensor*, 计算输入)：Device侧的aclTensor，数据类型支持DOUBLE,FLOAT,FLOAT16,INT16,INT32,INT64,INT8,UINT16,UINT32,UINT64,UINT8,BOOL。支持，支持ND。
- diagonal(int64_t, 计算输入)：对角线的位置，数据类型支持INT。
- workspaceSize(uint64_t*, 出参)：返回用户需要在Device侧申请的workspace大小。
- executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。
返回值：

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

[object Object]

aclnnInplaceTril

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

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

约束与限制

对于Atlas 训练系列产品，不支持BFLOAT16数据类型的计算。

调用示例

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

[object Object]