/**
 * 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_RENORM_H_
#define OP_API_INC_RENORM_H_

#include "aclnn/aclnn_base.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief aclnnRenorm的第一段接口，根据具体的计算流程，计算workspace大小。
 * @domain aclnn_ops_infer
 *
 * 算子功能：返回一个张量，其中输入张量self沿维度dim的每个子张量都经过归一化，使得子张量的p范数低于maxNorm值。
 * @param [in] self: npu device侧的aclTensor，数据类型支持FLOAT16, FLOAT, shape不超过8维。支持非连续Tensor，
 * 支持空Tensor传入，数据格式支持ND。
 * @param [in] p: host侧的aclScalar，数据类型支持FLOAT，表示范数，要求数值大于0。
 * @param [in] dim: host侧的INT64值，表示指定求norm的维度方向，若不指定默认为-1，范围在[-self的维度数量，self的维度数量-1]。
 * @param [in] maxNorm: host侧的aclScalar，数据类型支持FLOAT，表示最大允许的归一化值，要求数值大于等于0。
 * @param [in] out: npu device侧的aclTensor，数据类型支持FLOAT、FLOAT16，数据类型、shape与self一致。
 * 支持非连续Tensor，支持空Tensor传入，数据格式支持ND。
 * @param [out] workspaceSize: 返回用户需要在npu device侧申请的workspace大小。
 * @param [out] executor: 返回op执行器，包含算子计算流程。
 * @return aclnnStatus: 返回状态码
 */
aclnnStatus aclnnRenormGetWorkspaceSize(const aclTensor *self, const aclScalar *p, int64_t dim,
                                        const aclScalar *maxNorm, aclTensor *out,
                                        uint64_t *workspaceSize, aclOpExecutor **executor);


/**
 * @brief: aclnnRenorm的第二段接口，用于执行计算
 *
 * 算子功能：返回一个张量，其中输入张量self沿维度dim的每个子张量都经过归一化，使得子张量的p范数低于maxNorm值。
 * @param [in] workspace: 在npu device侧申请的workspace内存起址。
 * @param [in] workspaceSize: 在npu device侧申请的workspace大小，由第一段接口aclnnRenormGetWorkspaceSize获取。
 * @param [in] stream: acl stream流。
 * @param [in] executor: op执行器，包含了算子计算流程。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnRenorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream);

/**
 * @brief aclnnInplaceRenorm的第一段接口，根据具体的计算流程，计算workspace大小。
 * @domain aclnn_ops_infer
 *
 * 算子功能：返回一个张量，其中输入张量selfRef沿维度dim的每个子张量都经过归一化，使得子张量的p范数低于maxNorm值。
 * @param [in] selfRef: npu device侧的aclTensor，数据类型支持FLOAT16, FLOAT, shape不超过8维。支持非连续Tensor，
 * 支持空Tensor传入，数据格式支持ND。
 * @param [in] p: host侧的aclScalar，数据类型支持FLOAT，表示范数，要求数值大于0。
 * @param [in] dim: host侧的INT64值，表示指定求norm的维度方向，若不指定默认为-1，范围在[-self的维度数量，self的维度数量-1]。
 * @param [in] maxNorm: host侧的aclScalar，数据类型支持FLOAT，表示最大允许的归一化值，要求数值大于等于0。
 * @param [out] workspaceSize: 返回用户需要在npu device侧申请的workspace大小。
 * @param [out] executor: 返回op执行器，包含算子计算流程。
 * @return aclnnStatus: 返回状态码
 */
aclnnStatus aclnnInplaceRenormGetWorkspaceSize(aclTensor *selfRef, const aclScalar *p,
                                               int64_t dim, const aclScalar *maxNorm,
                                               uint64_t *workspaceSize, aclOpExecutor **executor);


/**
 * @brief: aclnnInplaceRenorm的第二段接口，用于执行计算
 *
 * 算子功能：返回一个张量，其中输入张量selfRef沿维度dim的每个子张量都经过归一化，使得子张量的p范数低于maxNorm值。
 * @param [in] workspace: 在npu device侧申请的workspace内存起址。
 * @param [in] workspaceSize: 在npu device侧申请的workspace大小，由第一段接口aclnnInplaceRenormGetWorkspaceSize获取。
 * @param [in] stream: acl stream流。
 * @param [in] executor: op执行器，包含了算子计算流程。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnInplaceRenorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream);

#ifdef __cplusplus
}
#endif

#endif  // OP_API_INC_RENORM_H_