aclnnGather

支持的产品型号

每个算子分为，必须先调用“aclnnGatherGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnGather”接口执行计算。

aclnnStatus aclnnGatherGetWorkspaceSize(const aclTensor *self, const int64_t dim, const aclTensor *index, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
aclnnStatus aclnnGather(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)

算子功能：对输入tensor中指定的维度进行数据聚集。
计算公式：给定张量 $X$ ，维度 $d$ ，和一个索引张量 $index$ ，定义 $n$ 是 $X$ 的维度， $i_d$ 表示维度 $d$ 的索引， $index_{i_d}$ 表示索引张量 $index$ 在维度 $d$ 上的第 $i_d$ 个索引值。对指定维度d的gather功能可以用如下的数学公式表示：

gather(X,index,d)_{i_0,i_1,\cdots,i_{d-1},i_{d+1},\cdots,i_{n-1}} = X_{i_0,i_1,\cdots,i_{d-1},index_{i_d},i_{d+1},\cdots,i_{n-1}}

示例：假设输入张量 $x=\begin{bmatrix}1 & 2 & 3\\ 4 & 5 & 6\\ 7 & 8 & 9\end{bmatrix}$ ，索引张量 $index=\begin{bmatrix}0 & 2\\ 1 & 0\end{bmatrix}$ ，那么输出张量 $y=\begin{bmatrix}1 & 3\\ 5 & 4\end{bmatrix}$ ，具体计算过程如下： $\begin{aligned} y_{0,0}&=x_{0, index_{0,0}}=x_{0,0}=1 \\ y_{0,1}&=x_{0, index_{0,1}}=x_{0,2}=3 \\ y_{1,0}&=x_{1, index_{1,0}}=x_{1,1}=5 \\ y_{1,1}&=x_{1, index_{1,1}}=x_{1,0}=4 \end{aligned}$

参数说明：
- self(aclTensor*, 计算输入)：公式中的X，Device侧的aclTensor，数据类型支持DOUBLE、FLOAT16、BFLOAT16(仅Atlas A2训练系列产品支持)、FLOAT32、INT32、UINT32、INT64、UINT64、INT16、UINT16、INT8、UINT8、BOOL数据类型，支持，支持ND。
- dim(int64_t, 计算输入)：公式中的d，Host侧的整型，取值范围[-self.dim(), self.dim() - 1]。
- index(aclTensor*, 计算输入)：公式中的index，Device侧的aclTensor，数据类型支持INT32、INT64，支持，支持ND。
- out(aclTensor*, 计算输出)：Device侧的aclTensor，数据类型与self一致，支持，支持ND。
- workspaceSize(uint64_t*, 出参)：返回用户需要在Device侧申请的workspace大小。
- executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。
返回值：

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

[object Object]

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

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

无

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

[object Object]