include/xbt/utility.hpp

   1 /* Copyright (c) 2016-2021. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef XBT_UTILITY_HPP
   8 #define XBT_UTILITY_HPP
   9
  10 #include <array>
  11 #include <functional>
  12 #include <tuple>
  13 #include <xbt/base.h>
  14
  15 /** @brief Helper macro to declare enum class
  16  *
  17  * Declares an enum class EnumType, and a function "const char* to_c_str(EnumType)" to retrieve a C-string description
  18  * for each value.
  19  */
  20 #define XBT_DECLARE_ENUM_CLASS(EnumType, ...)                                                                          \
  21   enum class EnumType;                                                                                                 \
  22   static constexpr char const* to_c_str(EnumType value)                                                                \
  23   {                                                                                                                    \
  24     constexpr std::array<const char*, _XBT_COUNT_ARGS(__VA_ARGS__)> names{{_XBT_STRINGIFY_ARGS(__VA_ARGS__)}};         \
  25     return names[static_cast<int>(value)];                                                                             \
  26   }                                                                                                                    \
  27   enum class EnumType { __VA_ARGS__ } /* defined here to handle trailing semicolon */
  28
  29 namespace simgrid {
  30 namespace xbt {
  31
  32 /** @brief A hash which works with more stuff
  33  *
  34  *  It can hash pairs: the standard hash currently doesn't include this.
  35  */
  36 template <class X> class hash : public std::hash<X> {
  37 };
  38
  39 template <class X, class Y> class hash<std::pair<X, Y>> {
  40 public:
  41   std::size_t operator()(std::pair<X, Y> const& x) const
  42   {
  43     hash<X> h1;
  44     hash<X> h2;
  45     return h1(x.first) ^ h2(x.second);
  46   }
  47 };
  48
  49 /** @brief Comparator class for using with std::priority_queue or boost::heap.
  50  *
  51  * Compare two std::pair by their first element (of type double), and return true when the first is greater than the
  52  * second.  Useful to have priority queues with the smallest element on top.
  53  */
  54 template <class Pair> class HeapComparator {
  55 public:
  56   bool operator()(const Pair& a, const Pair& b) const { return a.first > b.first; }
  57 };
  58
  59 /** @brief Erase an element given by reference from a boost::intrusive::list.
  60  */
  61 template <class List, class Elem> inline void intrusive_erase(List& list, Elem& elem)
  62 {
  63   list.erase(list.iterator_to(elem));
  64 }
  65
  66 }
  67 }
  68 #endif