Atan

功能说明

按元素做三角函数反正切运算，计算公式如下，其中PAR表示矢量计算单元一个迭代能够处理的元素个数 ：

定义原型

由于该接口的内部实现中涉及复杂的数学计算，需要额外的临时空间来存储计算过程中的中间变量。临时空间支持接口框架申请和开发者通过tmpTensor入参传入两种方式。

• 接口框架申请临时空间，开发者无需申请，但是需要预留临时空间的大小。

• 通过tmpTensor入参传入，使用该tensor作为临时空间进行处理，接口框架不再申请。该方式开发者可以自行管理tmpTensor内存空间，并在接口调用完成后，复用该部分内存，内存不会反复申请释放，灵活性较高，内存利用率也较高。

接口支持开启基本块功能，基本块计算是一种分块计算的方式。当输入的数据量较大，当前环境可提供的临时空间不充足时，可以开启基本块功能，分块进行计算。请根据如下公式判断是否需要开启基本块：

开发者当前环境可提供的临时空间大于n * InputSize * sizeof（datatype）时，可以不使用基本块，否则建议使用基本块。针对half数据类型，n=8，针对float数据类型，n = 3；InputSize为输入元素个数，datatype为输入的数据类型。

接口框架申请的方式，开发者需要预留临时空间；通过tmpTensor传入的情况，开发者需要为tensor申请空间。临时空间大小BufferSize的获取方式如下：

• 开启基本块功能，通过Atan Tiling中提供的GetAtanMinTmpSize接口获取需要预留空间的大小。
• 不开启基本块功能，对于half数据类型，BufferSize = 8 * InputSize * Sizeof(half)；对于float数据类型，BufferSize = 3 * InputSize * Sizeof(float)。其中InputSize为输入元素个数。

参数说明

返回值

无

支持的型号

Atlas A2训练系列产品

约束说明

• 本指令函数由于只使用二级接口实现，运算量为目的LocalTensor的总长度。源操作数与目的操作数不允许同时使用（即地址不重叠）。
• 操作数地址偏移对齐要求请参见通用约束。

调用示例

#include "kernel_operator.h"
namespace AscendC {
template <typename srcType>
class KernelAtan {
public:
    __aicore__ inline KernelAtan()
    {}
    __aicore__ inline void Init(GM_ADDR src_gm, GM_ADDR dst_gm, uint32_t srcSize)
    {
        src_global.SetGlobalBuffer(reinterpret_cast<__gm__ srcType *>(src_gm), srcSize);
        dst_global.SetGlobalBuffer(reinterpret_cast<__gm__ srcType *>(dst_gm), srcSize);
        pipe.InitBuffer(inQueueX, 1, srcSize * sizeof(srcType));
        pipe.InitBuffer(outQueue, 1, srcSize * sizeof(srcType));
        bufferSize = srcSize;
    }
    __aicore__ inline void Process()
    {
        CopyIn();
        Compute();
        CopyOut();
    }
private:
    __aicore__ inline void CopyIn()
    {
        LocalTensor<srcType> srcLocal = inQueueX.AllocTensor<srcType>();
        DataCopy(srcLocal, src_global, bufferSize);
        inQueueX.EnQue(srcLocal);
    }
    __aicore__ inline void Compute()
    {
        LocalTensor<srcType> dstLocal = outQueue.AllocTensor<srcType>();
        LocalTensor<srcType> srcLocal = inQueueX.DeQue<srcType>();
        Atan<srcType, false, false>(dstLocal, srcLocal);
        outQueue.EnQue<srcType>(dstLocal);
        inQueueX.FreeTensor(srcLocal);
    }
    __aicore__ inline void CopyOut()
    {
        LocalTensor<srcType> dstLocal = outQueue.DeQue<srcType>();
        DataCopy(dst_global, dstLocal, bufferSize);
        outQueue.FreeTensor(dstLocal);
    }
private:
    GlobalTensor<srcType> src_global;
    GlobalTensor<srcType> dst_global;
    TPipe pipe;
    TQue<QuePosition::VECIN, 1> inQueueX;
    TQue<QuePosition::VECOUT, 1> outQueue;
    uint32_t bufferSize = 0;
};
template <typename dataType>
__aicore__ void kernel_atan_operator(GM_ADDR src_gm, GM_ADDR dst_gm, uint32_t srcSize)
{
    KernelAtan<dataType> op;
    op.Init(src_gm, dst_gm, srcSize);
    op.Process();
}
} // namespace AscendC
                                                              
extern "C" __global__ __aicore__ void kernel_atan_operator(GM_ADDR src_gm, GM_ADDR dst_gm, uint32_t srcSize) 
{                                                                                                                 
    AscendC::kernel_atan_operator<half>(src_gm, dst_gm, srcSize);  //传入类型和大小                                                       
}

输入数据(srcLocal): [0.76769257 -0.23710161 ... 2.770608 1.0303017]
输出数据(dstLocal): [0.65472853 -0.23280266 ... 1.2244163 0.80032176]