/**
 * 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_THRESHOLD_H_
#define OP_API_INC_THRESHOLD_H_

#include "aclnn/aclnn_base.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief aclnnThreshold的第一段接口，根据具体的计算流程，计算workspace大小。
 * @domain aclnn_math
 *
 * 算子功能: 对输入self进行阈值操作。当self中的元素大于threshold时，返回元素本身；否则，返回value。
 * @param [in] self: npu device侧的aclTensor，支持数据类型FLOAT、FLOAT16、INT32、INT8、UINT8、INT16、INT64。
 * 支持[非连续的Tensor](),数据格式支持ND[参考](#)
 * @param [in] threshold: npu device侧的aclScalar，支持数据类型FLOAT、FLOAT16、INT32、INT8、UINT8、INT16、INT64。
 * 表示对输入self的元素进行大小判断的阈值。
 * @param [in] value: npu device侧的aclScalar，支持数据类型FLOAT、FLOAT16、INT32、INT8、UINT8、INT16、INT64。
 * 表示输入self的元素小于阈值时的返回值。
 * @param [out] out: npu device侧的aclTensor，支持数据类型FLOAT、FLOAT16、INT32、INT8、UINT8、INT16、INT64。
 * 支持非连续的Tensor。且数据类型、数据格式和shape需要与self一致。
 * @param [out] workspaceSize: 返回用户需要在npu device侧申请的workspace大小。
 * @param [out] executor: 返回op执行器，包含算子计算流程。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnThresholdGetWorkspaceSize(const aclTensor *self, const aclScalar *threshold, const aclScalar *value,
                                           aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor);
/**
 * @brief aclnnThreshold的第二段接口，用于执行计算。
 *
 * @param [in] workspace: 在npu device侧申请的workspace内存起址。
 * @param [in] workspaceSize: 在npu device侧申请的workspace大小，由第一段接口aclnnThresholdGetWorkspaceSize获取。
 * @param [in] executor: op执行器，包含了算子计算流程。
 * @param [in] stream: acl stream流。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnThreshold(void *workspace, uint64_t workspace_size, aclOpExecutor *executor, aclrtStream stream);

/**
 * @brief aclnnInplaceThreshold的第一段接口，根据具体的计算流程，计算workspace大小。
 * @domain aclnn_math
 *
 * 算子功能: 对输入self进行阈值操作。当self中的元素大于threshold时，返回元素本身；否则，返回value。
 * @param [in] selfRef: npu device侧的aclTensor，支持数据类型FLOAT、FLOAT16、INT32、INT8、UINT8、INT16、INT64。
 * 支持[非连续的Tensor](),数据格式支持ND[参考](#)
 * @param [in] threshold: npu device侧的aclScalar，支持数据类型FLOAT、FLOAT16、INT32、INT8、UINT8、INT16、INT64。
 * 表示对输入self的元素进行大小判断的阈值。
 * @param [in] value: npu device侧的aclScalar，支持数据类型FLOAT、FLOAT16、INT32、INT8、UINT8、INT16、INT64。
 * 表示输入self的元素小于阈值时的返回值。
 * @param [out] workspaceSize: 返回用户需要在npu device侧申请的workspace大小。
 * @param [out] executor: 返回op执行器，包含算子计算流程。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnInplaceThresholdGetWorkspaceSize(aclTensor *selfRef, const aclScalar *threshold,
                                                  const aclScalar *value, uint64_t *workspaceSize,
                                                  aclOpExecutor **executor);
/**
 * @brief aclnnInplaceThreshold的第二段接口，用于执行计算。
 *
 * @param [in] workspace: 在npu device侧申请的workspace内存起址。
 * @param [in] workspaceSize: 在npu device侧申请的workspace大小，由第一段接口aclnnInplaceThresholdGetWorkspaceSize获取。
 * @param [in] executor: op执行器，包含了算子计算流程。
 * @param [in] stream: acl stream流。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnInplaceThreshold(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream);

#ifdef __cplusplus
}
#endif

#endif  // OP_API_INC_THRESHOLD_H_