/**
* 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_PRELU_BACKWARD_H_
#define OP_API_INC_PRELU_BACKWARD_H_

#include "aclnn/aclnn_base.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief aclnnPreluBackward的第一段接口，根据具体的计算流程，计算workspace大小。
 * @domain aclnn_ops_train
 *
 * 算子功能：完成PRelu的反向。
 *
 * @param [in] gradOutput：反向传播的梯度值，即上一层的输出梯度。
 * npu device侧的aclTensor，数据类型支持FLOAT16、FLOAT32类型。
 * @param [in] self：PRelu的输出值。
 * npu device侧的aclTensor，数据类型支持FLOAT16、FLOAT32类型。
 * @param [in] weight：PRelu的权重。
 * npu device侧的aclTensor，数据类型支持FLOAT16、FLOAT32类型。
 * @param [out] gradInput：backward的输出，为输入的梯度值，即对输入进行求导后的结果。
 * npu device侧的aclTensor，数据类型支持FLOAT16、FLOAT32类型。
 * @param [out] gradWeight：backward的输出，为weight的梯度值，即对weight进行求导后的结果。
 * npu device侧的aclTensor，数据类型支持FLOAT16、FLOAT32类型。
 * @param [out] workspace_size: 返回用户需要在npu device侧申请的workspace大小。
 * @param [out] executor: 返回op执行器，包含算子计算流程。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnPreluBackwardGetWorkspaceSize(const aclTensor *gradOutput,
                                               const aclTensor *self,
                                               const aclTensor *weight,
                                               aclTensor *gradInput,
                                               aclTensor *gradWeight,
                                               uint64_t *workspaceSize,
                                               aclOpExecutor **executor);

/**
 * @brief aclnnPreluBackward的第二段接口，用于执行计算
 */
aclnnStatus aclnnPreluBackward(void *workspace,
                               uint64_t workspace_size,
                               aclOpExecutor *executor,
                               aclrtStream stream);
#ifdef __cplusplus
}
#endif

#endif  // OP_API_INC_PRELU_BACKWARD_H_