modes.h

/** @file
 * Compile-time checks that all expected
 * preprocessor macros are defined and valid 
 * 
 * @author Tyson Jones
 * 
 * @defgroup modes Modes
 * @ingroup api
 * @brief Macros for controlling QuEST compilation.
 * @{
 */
 
#ifndef MODES_H
#define MODES_H
 
 
 
// ensure all mode flags are defined
 
#ifndef COMPILE_MPI
    #error "Compiler must define COMPILE_MPI"
#endif
 
#ifndef COMPILE_OPENMP
    #error "Compiler must define COMPILE_OPENMP"
#endif
 
#ifndef COMPILE_CUDA
    #error "Compiler must define COMPILE_CUDA"
#endif
 
#ifndef COMPILE_CUQUANTUM
    #error "Compiler must define COMPILE_CUQUANTUM"
#endif
 
 
 
// ensure all mode flags are valid values
 
#if ! (COMPILE_MPI == 0 || COMPILE_MPI == 1)
    #error "Macro COMPILE_MPI must have value 0 or 1"
#endif
 
#if ! (COMPILE_OPENMP == 0 || COMPILE_OPENMP == 1)
    #error "Macro COMPILE_OPENMP must have value 0 or 1"
#endif
 
#if ! (COMPILE_CUDA == 0 || COMPILE_CUDA == 1)
    #error "Macro COMPILE_CUDA must have value 0 or 1"
#endif
 
#if ! (COMPILE_CUQUANTUM == 0 || COMPILE_CUQUANTUM == 1)
    #error "Macro COMPILE_CUQUANTUM must have value 0 or 1"
#endif
 
 
 
// ensure mode flags are compatible
 
#if COMPILE_CUQUANTUM && ! COMPILE_CUDA
    #error "Cannot enable cuQuantum without simultaneously enabling GPU-acceleration"
#endif
 
 
 
// ensure C++ macro is valid (API headers use #ifdef, not #if)
 
#ifdef __cplusplus
#if !__cplusplus
#error "Preprocessor __cplusplus was 0 and should instead be undefined"
#endif
#endif
 
 
 
// define optional-macro defaults (mostly to list them)
 
#ifndef PERMIT_NODES_TO_SHARE_GPU
#define PERMIT_NODES_TO_SHARE_GPU 0
#endif
 
#ifndef INCLUDE_DEPRECATED_FUNCTIONS
#define INCLUDE_DEPRECATED_FUNCTIONS 0
#endif
 
#ifndef DISABLE_DEPRECATION_WARNINGS
#define DISABLE_DEPRECATION_WARNINGS 0
#endif
 
// further macros are defined in precision.h
 
// spoofing above macro as consts to doc
#if 0
 
 
    /// @notdoced
    /// @macrodoc
    const int PERMIT_NODES_TO_SHARE_GPU = 0;
 
 
    /// @notdoced
    /// @macrodoc
    const int INCLUDE_DEPRECATED_FUNCTIONS = 0;
 
 
    /// @notdoced
    /// @macrodoc
    const int DISABLE_DEPRECATION_WARNINGS = 0;
 
 
#endif
 
 
 
// user flags for choosing automatic deployment; only accessible by C++ 
// backend and C++ users; C users must hardcode -1 
 
#ifdef __cplusplus
 
namespace modeflag { 
 
    extern int USE_AUTO;
}
 
#endif // __cplusplus
 
 
 
#endif // MODES_H
 
/** @} */ // (end file-wide doxygen defgroup)