/**
 * Copyright (c) 2024 Huawei Technologies Co., Ltd.
 * This file is a part of the CANN Open Software.
 * Licensed under CANN Open Software License Agreement Version 1.0 (the "License").
 * Please refer to the License for details. You may not use this file except in compliance with the License.
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
 * See LICENSE in the root of the software repository for the full text of the License.
 */

/*!
 * \file logsoftmax_tiling_intf.h
 * \brief
 */

#ifndef __ASCENDC_TIKCFW_TILING_LOGSOFTMAX_TILINGINTF_H__
#define __ASCENDC_TIKCFW_TILING_LOGSOFTMAX_TILINGINTF_H__
#include "graph/tensor.h"
#include "logsoftmax_tilingdata.h"
namespace AscendC {
/*
 * @ingroup GetLogSoftMaxMaxTmpSize
 * @brief get logsoftmax api calculate need max temporary local space size
 * @param [in] srcShape : input src Tensor shape
 * @param [in] dataTypeSize : input dstMax Tensor and expSum Tensor DType size
 * @param [in] isReuseSource : whether to reuse the src Tensor
 * @return min temporary local space size
 */
uint32_t GetLogSoftMaxMaxTmpSize(const ge::Shape srcShape, const uint32_t dataTypeSize, const bool isReuseSource);
/*
 * @ingroup GetLogSoftMaxMinTmpSize
 * @brief get logsoftmax api calculate need min temporary local space size
 * @param [in] srcShape : input src Tensor shape
 * @param [in] dataTypeSize : input dstMax Tensor and expSum Tensor DType size
 * @param [in] isReuseSource : whether to reuse the src Tensor
 * @return min temporary local space size
 */
uint32_t GetLogSoftMaxMinTmpSize(const ge::Shape srcShape, const uint32_t dataTypeSize, const bool isReuseSource);
/*
 * @ingroup LogSoftMaxTilingFunc
 * @brief calculate LogSoftMax api need tiling
 * @param [in] srcShape : input src Tensor shape
 * @param [in] dataTypeSize : input dstMax Tensor and expSum Tensor DType size
 * @param [in] localWorkSpaceSize : the temporary local space size for LogSoftMax api, unit is Byte
 * @param [out] logsoftmaxTiling : LogSoftMax api tiling
 */
void LogSoftMaxTilingFunc(const ge::Shape srcShape, const uint32_t dataTypeSize, const uint32_t localWorkSpaceSize,
    optiling::LogSoftMaxTiling& softmaxTiling);
}
#endif // __ASCENDC_TIKCFW_TILING_LOGSOFTMAX_TILINGINTF_H__