locus.h

Go to the documentation of this file.

 
#if !defined(ULTRA_LOCUS_H)
#define      ULTRA_LOCUS_H
 
#include <iostream>
#include <limits>
 
namespace ultra
{

struct locus
{
  using index_t = std::size_t;
 
  locus() = default;
  constexpr locus(index_t i, size_t c) : index(i), category(c) {}
 
  // DO NOT CHANGE THE ORDER: the matrix class uses structured binding to
  // access this struct, associating `index` with `row` and `category` with
  // `column`.
  index_t index;
  std::size_t category;
 
  [[nodiscard]] static constexpr locus npos()
  {
    return {std::numeric_limits<index_t>::max(),
            std::numeric_limits<std::size_t>::max()};
  }
 
  [[nodiscard]] friend bool operator==(const locus &,
                                       const locus &) noexcept = default;
};

[[nodiscard]] inline bool operator<(const locus &l1, const locus &l2) noexcept
{
  return l1.index < l2.index ||
         (l1.index == l2.index && l1.category < l2.category);
}

[[nodiscard]] inline bool operator>(const locus &l1, const locus &l2) noexcept
{
  return l1.index > l2.index ||
         (l1.index == l2.index && l1.category > l2.category);
}

[[nodiscard]] inline locus operator+(const locus &l, locus::index_t i) noexcept
{
  return {l.index + i, l.category};
}

inline std::ostream &operator<<(std::ostream &s, const locus &l)
{
  return s << '[' << l.index << ',' << l.category << ']';
}
 
}  // namespace ultra
 
#endif  // include guard