Optimist.hh

Go to the documentation of this file.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\
 * Copyright (c) 2025, Davide Stocco, Mattia Piazza and Enrico Bertolazzi.                       *
 *                                                                                               *
 * The Optimist project is distributed under the BSD 2-Clause License.                           *
 *                                                                                               *
 * Davide Stocco                          Mattia Piazza                        Enrico Bertolazzi *
 * University of Trento               University of Trento                  University of Trento *
 * davide.stocco@unitn.it            mattia.piazza@unitn.it           enrico.bertolazzi@unitn.it *
\* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
#pragma once
 
#ifndef INCLUDE_OPTIMIST_HH
#define INCLUDE_OPTIMIST_HH
 
// C++ standard libraries
#include <iostream>
#include <ios>
#include <iomanip>
#include <string>
#include <cmath>
#include <vector>
#include <map>
#include <memory>
#include <numeric>
#include <algorithm>
 
// Eigen library
#include <Eigen/Dense>
 
// Print Optimist errors
#ifndef OPTIMIST_ERROR
#define OPTIMIST_ERROR(MSG)             \
  {                                     \
    std::ostringstream os;              \
    os << MSG;                          \
    throw std::runtime_error(os.str()); \
  }
#endif
 
// Assert for Optimist
#ifndef OPTIMIST_ASSERT
#define OPTIMIST_ASSERT(COND, MSG) \
  if (!(COND))                     \
  {                                \
    OPTIMIST_ERROR(MSG);           \
  }
#endif
 
// Warning for Optimist
#ifndef OPTIMIST_WARNING
#define OPTIMIST_WARNING(MSG)       \
  {                                 \
    std::cout << MSG << std::endl;  \
  }
#endif
 
// Warning assert for Optimist
#ifndef OPTIMIST_ASSERT_WARNING
#define OPTIMIST_ASSERT_WARNING(COND, MSG) \
  if (!(COND))                             \
  {                                        \
    OPTIMIST_WARNING(MSG);                 \
  }
#endif
 
 
// Define the basic constants for Optimist
#ifndef OPTIMIST_BASIC_CONSTANTS
#define OPTIMIST_BASIC_CONSTANTS(Real) \
  static constexpr Real EPSILON{std::numeric_limits<Real>::epsilon()};      \
  static constexpr Real EPSILON_HIGH{1.0e-12};                              \
  static constexpr Real EPSILON_MEDIUM{1.0e-10};                            \
  static constexpr Real EPSILON_LOW{1.0e-08};                               \
  static constexpr Real INFTY{std::numeric_limits<Real>::infinity()};       \
  static constexpr Real QUIET_NAN{std::numeric_limits<Real>::quiet_NaN()}; 
#endif
 
#ifndef OPTIMIST_DEFAULT_INTEGER_TYPE
#define OPTIMIST_DEFAULT_INTEGER_TYPE int
#endif

namespace Optimist
{

  using Integer = OPTIMIST_DEFAULT_INTEGER_TYPE;

  static inline std::string table_top_left_corner() {return "┌";}

  static inline std::string table_top_right_corner() {return "┐";}

  static inline std::string table_bottom_left_corner() {return "└";}

  static inline std::string table_bottom_right_corner() {return "┘";}

  static inline std::string table_left_junction() {return "├";}

  static inline std::string table_right_junction() {return "┤";}

  static inline std::string table_top_junction() {return "┬";}

  static inline std::string table_bottom_junction() {return "┴";}

  static inline std::string table_center_cross() {return "┼";}

  static inline std::string table_horizontal_line() {return "─";}

  template <Integer N>
  static inline std::string table_horizontal_line() {
    std::string line;
    for (Integer i{0}; i < N; ++i) {line += table_horizontal_line();}
    return line;
  }

  static inline std::string table_vertical_line() {return "│";}
 
} // namespace Optimist
 
#endif // INCLUDE_OPTIMIST_HH