/*
 * Copyright 2025-2026 NVIDIA CORPORATION & AFFILIATES.  All rights reserved.
 *
 * NOTICE TO LICENSEE:
 *
 * This source code and/or documentation ("Licensed Deliverables") are
 * subject to NVIDIA intellectual property rights under U.S. and
 * international Copyright laws.
 *
 * These Licensed Deliverables contained herein is PROPRIETARY and
 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
 * conditions of a form of NVIDIA software license agreement by and
 * between NVIDIA and Licensee ("License Agreement") or electronically
 * accepted by Licensee.  Notwithstanding any terms or conditions to
 * the contrary in the License Agreement, reproduction or disclosure
 * of the Licensed Deliverables to any third party without the express
 * written consent of NVIDIA is prohibited.
 *
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE.  IT IS
 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THESE LICENSED DELIVERABLES.
 *
 * U.S. Government End Users.  These Licensed Deliverables are a
 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
 * 1995), consisting of "commercial computer software" and "commercial
 * computer software documentation" as such terms are used in 48
 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
 * only as a commercial end item.  Consistent with 48 C.F.R.12.212 and
 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
 * U.S. Government End Users acquire the Licensed Deliverables with
 * only those rights set forth herein.
 *
 * Any use of the Licensed Deliverables in individual and commercial
 * software must include, in the user documentation and internal
 * comments to the code, the above Disclaimer and U.S. Government End
 * Users Notice.
 */

#ifndef ECP_SHELL_API_H
#define ECP_SHELL_API_H

#include <stddef.h>
#include <stdint.h>

#include "../macros.h"
#include "../types/cuest_types.h"
#include "../types/cuest_parameter_types.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief Create an ECP shell object with specified parameters.
 * @ingroup ECP
 *
 * @param[in]      handle             cuEST handle. Must not be NULL.
 * @param[in]      L                  Angular momentum quantum number (s=0, p=1, d=2, etc).
 * @param[in]      numPrimitive       Number of primitives; must be greater than zero.
 * @param[in]      radialPowers       Pointer to array containing radial powers (size: \c numPrimitive) on the CPU. Elements must be non-negative integers, e.g. >= 0. Must not be NULL.
 * @param[in]      coefficients       Pointer to array containing coefficients (size: \c numPrimitive) on the CPU. Must not be NULL.
 * @param[in]      exponents          Pointer to array containing exponents (size: \c numPrimitive) on the CPU. Elements must be strictly positive and finite, e.g. > 0. Must not be NULL.
 * @param[in]      parameters         Handle to \c cuestECPShellParameters_t. Must not be NULL.
 * @param[out]     outECPShell        Pointer to output shell object; receives opaque handle on success. Must not be NULL.
 *
 * All objects on CPU.
 *
 * @return
 *   - \c CUEST_STATUS_SUCCESS on success;
 *   - \c CUEST_STATUS_INVALID_HANDLE if the cuEST handle is NULL;
 *   - \c CUEST_STATUS_NULL_POINTER if any required pointer is NULL;
 *   - \c CUEST_STATUS_INVALID_TYPE if the cuEST handle or parameters are not of the correct type;
 *   - \c CUEST_STATUS_INVALID_ARGUMENT if \c numPrimitive is zero, or if any exponent is not strictly positive and finite (> 0);
 *   - \c CUEST_STATUS_EXCEPTION for unexpected error;
 *   - \c CUEST_STATUS_UNKNOWN_ERROR for non-std exceptions.
 */
CUEST_API
cuestStatus_t cuestECPShellCreate(
    cuestHandle_t handle,
    uint64_t L,
    uint64_t numPrimitive,
    const uint64_t* radialPowers,
    const double* coefficients,
    const double* exponents,
    const cuestECPShellParameters_t parameters, 
    cuestECPShell_t* outECPShell);

/**
 * @brief Destroy/free an ECP shell object created with \c cuestECPShellCreate.
 * @ingroup ECP
 *
 * Frees all memory associated with the ECP shell. After destruction, the shell handle must not be used.
 *
 * @param[in] shell   Opaque ECP shell handle to destroy. Must not be NULL.
 *
 * @return
 *   - \c CUEST_STATUS_SUCCESS on success;
 *   - \c CUEST_STATUS_NULL_POINTER if \c shell is NULL;
 *   - \c CUEST_STATUS_INVALID_TYPE if the \c shell handle is not of the \c cuestECPShell_t type;
 *   - \c CUEST_STATUS_EXCEPTION or \c CUEST_STATUS_UNKNOWN_ERROR on error.
 */
CUEST_API
cuestStatus_t cuestECPShellDestroy(
    cuestECPShell_t shell);

#ifdef __cplusplus
}
#endif

#endif /* ECP_SHELL_API_H */
