/*
 * 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 ATOM_GRID_API_H
#define ATOM_GRID_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 atom grid object with specified parameters.
 * @ingroup Grid
 *
 * @note The \c radialWeights positivity and \c numAngularPoints Lebedev-number requirements are not
 *       validated by this function; they are enforced when this atom grid is used to construct a
 *       \c cuestMolecularGrid_t, where a violation is reported as \c CUEST_STATUS_EXCEPTION.
 *
 * @param[in]  handle            cuEST handle. Must not be NULL.
 * @param[in]  numRadialPoints   Number of radial points. Must be greater than zero.
 * @param[in]  radialNodes       Location of radial nodes from the atom center (size: \c numRadialPoints) on the CPU. Must not be NULL.
 * @param[in]  radialWeights     Pointer to array containing quadrature weights of a radial point (size: \c numRadialPoints) on the CPU. Elements must be positive semidefinite. Must not be NULL.
 * @param[in]  numAngularPoints  Pointer to array containing number of angular points associated with a radial point (size: \c numRadialPoints) on the CPU. Values must be Lebedev numbers. Must not be NULL.
 * @param[in]  parameters        Handle to \c cuestAtomGridParameters_t. Must not be NULL.
 * @param[out] outAtomGrid       Pointer to output atom grid object; receives opaque handle on success. Must not be NULL.
 *
 * @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 numRadialPoints is zero;
 *   - \c CUEST_STATUS_EXCEPTION for unexpected error;
 *   - \c CUEST_STATUS_UNKNOWN_ERROR for non-std exceptions.
 */
CUEST_API
cuestStatus_t cuestAtomGridCreate(
    cuestHandle_t handle,
    uint64_t numRadialPoints,
    const double* radialNodes,
    const double* radialWeights,
    const uint64_t* numAngularPoints,
    const cuestAtomGridParameters_t parameters, 
    cuestAtomGrid_t* outAtomGrid);

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

#ifdef __cplusplus
}
#endif

#endif /* ATOM_GRID_API_H */
