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

 #include <stddef.h>

 #ifdef __cplusplus
 extern "C" {
 #endif

 /**
  * @brief Opaque handle representing the results returned by cuEST compute routines.
  *        See \c cuestPCMResultAttributes_t for attributes that may be queried from this handle.
  * @ingroup TypeDefs
  */
 typedef void* cuestPCMResults_t;

 /**
  * @brief Provides unique identifiers for each of the opaque handles to result structures.
  * @ingroup Enums
  *
  */
 typedef enum {
     CUEST_PCM_RESULTS = 0                      ///< Alias for cuestPCMResults_t
 } cuestResultsType_t;
 
/**
 * @brief List of attributes that may be queried from a cuEST PCM result object.
 * @ingroup Enums
 *
 * For each attribute, the expected return type is given:
 *
 * - \c CUEST_PCMRESULT_PCM_DIELECTRIC_ENERGY : double
 * - \c CUEST_PCMRESULT_CONVERGED_RESIDUAL :    double
 * - \c CUEST_PCMRESULT_NUM_ITERATIONS_TAKEN :  uint64_t
 * - \c CUEST_PCMRESULT_CONVERGED :             int32_t
 */
typedef enum {
    CUEST_PCMRESULT_PCM_DIELECTRIC_ENERGY = 0, ///< PCM dielectric energy
    CUEST_PCMRESULT_CONVERGED_RESIDUAL = 1,    ///< Maximum absolute value of the residual at the last iteration
    CUEST_PCMRESULT_NUM_ITERATIONS_TAKEN = 2,  ///< Number of iterations taken to converge to the converged residual
    CUEST_PCMRESULT_CONVERGED = 3              ///< Whether the PCM charges converged
} cuestPCMResultAttributes_t;


 #ifdef __cplusplus
 }
 #endif

 #endif /* CUEST_RESULT_TYPES_H */

