exceptionHandling.hpp

Go to the documentation of this file.

 
//
// Copyright (c) 2021-2023, University of Colorado Denver. All rights reserved.
//
// This file is part of <T>LAPACK.
// <T>LAPACK is free software: you can redistribute it and/or modify it under
// the terms of the BSD 3-Clause license. See the accompanying LICENSE file.
 
#ifndef TLAPACK_EXCEPTION_HH
#define TLAPACK_EXCEPTION_HH
 
#include <iostream>
#include <stdexcept>
#include <string>
 
#ifndef TLAPACK_DEFAULT_INFCHECK
    #define TLAPACK_DEFAULT_INFCHECK true
#endif
 
#ifndef TLAPACK_DEFAULT_NANCHECK
    #define TLAPACK_DEFAULT_NANCHECK true
#endif
 
namespace tlapack {
namespace internal {
 
    inline std::string error_msg(int info, const std::string& detailedInfo)
    {
        return std::string("[") + std::to_string(info) + "] " + detailedInfo;
    }
}  // namespace internal
 
struct ErrorCheck {
    bool inf = TLAPACK_DEFAULT_INFCHECK;  
    bool nan = TLAPACK_DEFAULT_NANCHECK;  
    bool internal = true;  
};
 
constexpr ErrorCheck NO_ERROR_CHECK = {false, false, false};
 
struct EcOpts {
    ErrorCheck ec = {};
 
    constexpr EcOpts(const ErrorCheck& ec_ = {}) : ec(ec_) {}
};
}  // namespace tlapack
 
// -----------------------------------------------------------------------------
// Macros to handle error in the input
 
#if defined(TLAPACK_CHECK_INPUT) && !defined(TLAPACK_NDEBUG)
 
    #define tlapack_check(cond)                                           \
        do {                                                              \
            if (!static_cast<bool>(cond)) throw std::domain_error(#cond); \
        } while (false)
 
    #define tlapack_check_false(cond)                                    \
        do {                                                             \
            if (static_cast<bool>(cond)) throw std::domain_error(#cond); \
        } while (false)
 
#else  // !defined(TLAPACK_CHECK_INPUT) || defined(TLAPACK_NDEBUG)
 
    // <T>LAPACK does not check input parameters
 
    #define tlapack_check_false(cond) ((void)0)
    #define tlapack_check(cond) ((void)0)
 
#endif
 
// -----------------------------------------------------------------------------
// Macros to handle internal errors and warnings
 
#ifndef TLAPACK_NDEBUG
 
    #define tlapack_error(info, detailedInfo) \
        throw std::runtime_error(             \
            tlapack::internal::error_msg(info, detailedInfo))
 
    #define tlapack_warning(info, detailedInfo)                       \
        std::cerr << tlapack::internal::error_msg(info, detailedInfo) \
                  << std::endl;
 
    #define tlapack_error_if(cond, info, detailedInfo)                      \
        do {                                                                \
            if (static_cast<bool>(cond)) tlapack_error(info, detailedInfo); \
        } while (false)
 
#else
 
    // <T>LAPACK does not throw errors or display warnings
 
    #define tlapack_error(info, detailedInfo) ((void)0)
    #define tlapack_warning(info, detailedInfo) ((void)0)
    #define tlapack_error_if(cond, info, detailedInfo) ((void)0)
 
#endif
 
#endif  // TLAPACK_EXCEPTION_HH