/**
 * Copyright (c) Huawei Technologies Co., Ltd. 2023. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef OP_API_INC_ATAN2_H_
#define OP_API_INC_ATAN2_H_

#include "aclnn/aclnn_base.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief aclnnAtan2的第一段接口，根据具体的计算流程，计算workspace大小。
 * @domain aclnn_math
 * 功能描述：对输入张量self和other进行逐元素的反正切运算，注（self表示y坐标，other表示x坐标）。
 * 计算公式：
 * out_{i}=tan^{-1}(self_{i}/other_{i})
 * 参数描述：
 * @param [in] self:npu device侧的aclTensor，数据类型支持INT8、INT16、INT32, INT64, UINT8、BOOL、BFLOAT16、
 * FLOAT、FLOAT16、DOUBLE。支持非连续的Tensor，数据格式支持ND，维度不大于8，且shape需要与other满足broadcast关系。
 * @param [in] other:npu device侧的aclTensor，数据类型支持INT8、INT16、INT32, INT64, UINT8、BOOL、BFLOAT16、
 * FLOAT、FLOAT16、DOUBLE。支持非连续的Tensor，数据格式支持ND，维度不大于8，且shape需要与self满足broadcast关系。
 * @param [out] out:npu device侧的aclTensor，数据类型支持FLOAT、FLOAT16、DOUBLE。支持非连续Tensor，
 * 数据格式支持ND，维度不大于8，且shape是self与other broadcast之后的shape。
 * @param [out] workspaceSize:返回用户需要在npu device侧申请的workspace大小。
 * @param [out] executor:返回op执行器，包含了算子计算流程。
 * @return aclnnStatus:返回状态码
 */
aclnnStatus aclnnAtan2GetWorkspaceSize(const aclTensor* self, const aclTensor* other, aclTensor* out,
                                       uint64_t* workspaceSize, aclOpExecutor** executor);
/**
 * @brief aclnnAtan2的第二段接口，用于执行计算。
 * 功能描述：对输入张量self和other进行逐元素的反正切运算，注（self表示y坐标，other表示x坐标）。
 * 计算公式：
 * out_{i}=tan^{-1}(self_{i}/other_{i})
 * 实现说明：
 * api计算的基本路径：
```mermaid
graph LR
    A[(Self)] -->B([l0op::Contiguous])
    B --> C([l0op::Atan])
    C --> G([l0op::Cast])
    G --> E([l0op::ViewCopy])
    E --> S[(Out)]
```
 * @param [in] workspace: 在npu device侧申请的workspace内存起址。
 * @param [in] workspaceSize: 在npu device侧申请的workspace大小，由第一段接口aclnnAtan2GetWorkspaceSize获取。
 * @param [in] stream: acl stream流。
 * @param [in] executor: op执行器，包含了算子计算流程。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnAtan2(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream);

/**
 * @brief aclnnInplaceAtan2的第一段接口，根据具体的计算流程，计算workspace大小。
 * @domain aclnn_math
 * 功能描述：对输入张量self和other进行逐元素的反正切运算，注（self表示y坐标，other表示x坐标）。
 * 计算公式：
 * out_{i}=tan^{-1}(self_{i}/other_{i})
 * 参数描述：
 * @param [in] self:npu device侧的aclTensor，数据类型支持INT8、INT16、INT32, INT64, UINT8、BOOL、BFLOAT16、
 * FLOAT、FLOAT16、DOUBLE。支持非连续的Tensor，数据格式支持ND，维度不大于8，且shape需要与other满足broadcast关系。
 * @param [in] other:npu device侧的aclTensor，数据类型支持INT8、INT16、INT32, INT64, UINT8、BOOL、BFLOAT16、
 * FLOAT、FLOAT16、DOUBLE。支持非连续的Tensor，数据格式支持ND，维度不大于8，且shape需要与self满足broadcast关系。
 * @param [out]  workspaceSize   返回用户需要在npu device侧申请的workspace大小。
 * @param [out]  executor         返回op执行器，包含了算子计算流程。
 * @return       aclnnStatus      返回状态码
 */
aclnnStatus aclnnInplaceAtan2GetWorkspaceSize(aclTensor* selfRef, aclTensor* other, uint64_t* workspace_size,
                                              aclOpExecutor** executor);

/**
 * @brief: aclnnInplaceAtan2的第二段接口，用于执行计算
 *
 * 算子功能： 对输入张量self和other进行逐元素的反正切运算，注（self表示y坐标，other表示x坐标）。
 * @param [in] workspace: 在npu device侧申请的workspace内存起址。
 * @param [in] workspaceSize: 在npu device侧申请的workspace大小，由第一段接口aclnnAtan2GetWorkspaceSize获取。
 * @param [in] stream: acl stream流。
 * @param [in] executor: op执行器，包含了算子计算流程。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnInplaceAtan2(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream);
#ifdef __cplusplus
}
#endif

#endif