/*! \file */
/* ************************************************************************
 * Copyright (C) 2025 Advanced Micro Devices, Inc. All rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * ************************************************************************ */
#ifndef HIPSPARSE_SPARSE2DENSE_H
#define HIPSPARSE_SPARSE2DENSE_H

#ifdef __cplusplus
extern "C" {
#endif

/*! \ingroup generic_module
*  \details
*  \p hipsparseSparseToDense_bufferSize computes the required user allocated buffer size needed when converting
*  a sparse matrix to a dense matrix. This routine currently accepts the sparse matrix descriptor \p matA in CSR,
*  CSC, or COO format. This routine is used to determine the size of the buffer needed in \ref hipsparseSparseToDense.
*
*  \p hipsparseSparseToDense_bufferSize supports different data types for the sparse and dense matrices. See
*  \ref hipsparseSparseToDense for a complete listing of all the data types available.
*
*  @param[in]
*  handle              handle to the hipsparse library context queue.
*  @param[in]
*  matA                sparse matrix descriptor.
*  @param[in]
*  matB                dense matrix descriptor.
*  @param[in]
*  alg                 algorithm for the sparse to dense computation.
*  @param[out]
*  pBufferSizeInBytes  number of bytes of the temporary storage buffer.
*
*  \retval      HIPSPARSE_STATUS_SUCCESS the operation completed successfully.
*  \retval      HIPSPARSE_STATUS_INVALID_VALUE \p handle, \p matA, \p matB, or \p pBufferSizeInBytes
*               pointer is invalid.
*/
#if(!defined(CUDART_VERSION) || CUDART_VERSION >= 12000)
HIPSPARSE_EXPORT
hipsparseStatus_t hipsparseSparseToDense_bufferSize(hipsparseHandle_t           handle,
                                                    hipsparseConstSpMatDescr_t  matA,
                                                    hipsparseDnMatDescr_t       matB,
                                                    hipsparseSparseToDenseAlg_t alg,
                                                    size_t*                     pBufferSizeInBytes);
#elif(CUDART_VERSION >= 11020)
HIPSPARSE_EXPORT
hipsparseStatus_t hipsparseSparseToDense_bufferSize(hipsparseHandle_t           handle,
                                                    hipsparseSpMatDescr_t       matA,
                                                    hipsparseDnMatDescr_t       matB,
                                                    hipsparseSparseToDenseAlg_t alg,
                                                    size_t*                     pBufferSizeInBytes);
#endif

/*! \ingroup generic_module
*  \brief Sparse matrix to dense matrix conversion
*
*  \details
*  \p hipsparseSparseToDense converts a sparse matrix to a dense matrix. This routine currently accepts
*  the sparse matrix descriptor \p matA in CSR, CSC, or COO format. This routine takes a user allocated buffer
*  whose size must first be computed by calling \ref hipsparseSparseToDense_bufferSize
*
*  The conversion of a sparse matrix into a dense one involves two steps. First, the user creates the sparse and
*  dense matrix descriptors and calls \ref hipsparseSparseToDense_bufferSize to determine the size of the required
*  temporary storage buffer. The user then allocates this buffer and passes it to \ref hipsparseSparseToDense in
*  order to complete the conversion. Once the conversion is complete, the user is free to deallocate the storage
*  buffer. See full example below for details.
*
*  \p hipsparseSparseToDense supports the following uniform precision data types for the sparse and dense matrices \f$A\f$
*  and \f$B\f$:
*
*  \par Uniform Precisions:
*  <table>
*  <caption id="sparse2dense_uniform">Uniform Precisions</caption>
*  <tr><th>A / B
*  <tr><td>HIP_R_16F
*  <tr><td>HIP_R_16BF
*  <tr><td>HIP_R_32F
*  <tr><td>HIP_R_64F
*  <tr><td>HIP_C_32F
*  <tr><td>HIP_C_64F
*  </table>
*
*  \note Currently only the sparse matrix formats CSR, CSC, and COO are supported when converting a sparse matrix to a dense matrix.
*
*  @param[in]
*  handle          handle to the hipsparse library context queue.
*  @param[in]
*  matA            sparse matrix descriptor.
*  @param[in]
*  matB            dense matrix descriptor.
*  @param[in]
*  alg             algorithm for the sparse to dense computation.
*  @param[in]
*  externalBuffer  temporary storage buffer allocated by the user.
*
*  \retval      HIPSPARSE_STATUS_SUCCESS the operation completed successfully.
*  \retval      HIPSPARSE_STATUS_INVALID_VALUE \p handle, \p matA, \p matB, or \p externalBuffer
*               pointer is invalid.
*
*  \par Example
*  \code{.c}
*    //     1 0 0 0
*    // A = 4 2 0 4
*    //     0 3 7 0
*    //     9 0 0 1
*    int m   = 4;
*    int n   = 4;
*    int nnz = 8;
*
*    std::vector<int> hcsrRowPtrA = {0, 1, 4, 6, 8};
*    std::vector<int> hcsrColIndA = {0, 0, 1, 3, 1, 2, 0, 3};
*    std::vector<float> hcsrValA = {1.0f, 4.0f, 2.0f, 4.0f, 3.0f, 7.0f, 9.0f, 1.0f};
*
*    int* dcsrRowPtrA;
*    int* dcsrColIndA;
*    float* dcsrValA;
*    hipMalloc((void**)&dcsrRowPtrA, sizeof(int) * (m + 1));
*    hipMalloc((void**)&dcsrColIndA, sizeof(int) * nnz);
*    hipMalloc((void**)&dcsrValA, sizeof(float) * nnz);
*
*    hipMemcpy(dcsrRowPtrA, hcsrRowPtrA.data(), sizeof(int) * (m + 1), hipMemcpyHostToDevice);
*    hipMemcpy(dcsrColIndA, hcsrColIndA.data(), sizeof(int) * nnz, hipMemcpyHostToDevice);
*    hipMemcpy(dcsrValA, hcsrValA.data(), sizeof(float) * nnz, hipMemcpyHostToDevice);
*
*    float* ddenseB;
*    hipMalloc((void**)&ddenseB, sizeof(float) * m * n);
*
*    hipsparseHandle_t     handle;
*    hipsparseSpMatDescr_t matA;
*    hipsparseDnMatDescr_t matB;
*
*    hipsparseCreate(&handle);
*
*    hipsparseIndexType_t rowIdxTypeA = HIPSPARSE_INDEX_32I;
*    hipsparseIndexType_t colIdxTypeA = HIPSPARSE_INDEX_32I;
*    hipDataType  dataTypeA = HIP_R_32F;
*    hipsparseIndexBase_t idxBaseA = HIPSPARSE_INDEX_BASE_ZERO;
*
*    // Create sparse matrix A
*    hipsparseCreateCsr(&matA,
*        m,
*        n,
*        nnz,
*        dcsrRowPtrA,
*        dcsrColIndA,
*        dcsrValA,
*        rowIdxTypeA,
*        colIdxTypeA,
*        idxBaseA,
*        dataTypeA);
*
*    // Create dense matrix B
*    hipsparseCreateDnMat(&matB,
*                        m,
*                        n,
*                        m,
*                        ddenseB,
*                        HIP_R_32F,
*                        HIPSPARSE_ORDER_COL);
*
*    hipsparseSparseToDenseAlg_t alg = HIPSPARSE_SPARSETODENSE_ALG_DEFAULT;
*
*    size_t bufferSize;
*    hipsparseSparseToDense_bufferSize(handle, matA, matB, alg, &bufferSize);
*
*    void* tempBuffer;
*    hipMalloc((void**)&tempBuffer, bufferSize);
*
*    // Complete the conversion
*    hipsparseSparseToDense(handle, matA, matB, alg, tempBuffer);
*
*    // Copy result back to host
*    std::vector<float> hdenseB(m * n);
*    hipMemcpy(hdenseB.data(), ddenseB, sizeof(float) * m * n, hipMemcpyDeviceToHost);
*
*    // Clear hipSPARSE
*    hipsparseDestroyMatDescr(matA);
*    hipsparseDestroyMatDescr(matB);
*    hipsparseDestroy(handle);
*
*    // Clear device memory
*    hipFree(dcsrRowPtrA);
*    hipFree(dcsrColIndA);
*    hipFree(dcsrValA);
*    hipFree(ddenseB);
*    hipFree(tempBuffer);
*  \endcode
*/
#if(!defined(CUDART_VERSION) || CUDART_VERSION >= 12000)
HIPSPARSE_EXPORT
hipsparseStatus_t hipsparseSparseToDense(hipsparseHandle_t           handle,
                                         hipsparseConstSpMatDescr_t  matA,
                                         hipsparseDnMatDescr_t       matB,
                                         hipsparseSparseToDenseAlg_t alg,
                                         void*                       externalBuffer);
#elif(CUDART_VERSION >= 11020)
HIPSPARSE_EXPORT
hipsparseStatus_t hipsparseSparseToDense(hipsparseHandle_t           handle,
                                         hipsparseSpMatDescr_t       matA,
                                         hipsparseDnMatDescr_t       matB,
                                         hipsparseSparseToDenseAlg_t alg,
                                         void*                       externalBuffer);
#endif

#ifdef __cplusplus
}
#endif

#endif /* HIPSPARSE_SPARSE2DENSE_H */
