MRMesh/MRId.h

Go to the documentation of this file.

#pragma once
 
#include "MRMeshFwd.h"
#include "MRMacros.h"
#include <cassert>
#include <cstddef>
#include <type_traits>
#include <utility>
 
namespace MR
{
 
// stores index of some element, it is made as template class to avoid mixing faces, edges and vertices
template <typename T>
class Id
{
public:
    using ValueType = int; //the type used for internal representation of Id
 
    constexpr Id() noexcept : id_( -1 ) { }
    explicit Id( NoInit ) noexcept { }
 
    // Allow constructing from `int` and other integral types.
    // This constructor is written like this instead of a plain `Id(int)`, because we also wish to disable construction
    //   from other unrelated `Id<U>` specializations, which themselves have implicit conversions to `int`.
    // We could also achieve that using `template <typename U> Id(Id<U>) = delete;`, but it turns out that that causes issues
    //   for the `EdgeId::operator UndirectedEdgeId` below. There, while `UndirectedEdgeId x = EdgeId{};` compiles with this approach,
    //   but `UndirectedEdgeId x(EdgeId{});` doesn't. So to allow both forms, this constructor must be written this way, as a template.
    // The `= int` is there only to make the bindings emit this constructor, I don't think it affects anything else.
    template <typename U = int
    // The condition is there for the binding generator. Firstly, removing the second template argument produces better function names in C,
    //   and secondly `--buggy-substitute-default-template-args` seems to duplicate this constructor when `enable_if_t` is present.
    #if MR_HAS_REQUIRES
    > requires std::is_integral_v<U>
    #else
    , std::enable_if_t<std::is_integral_v<U>, std::nullptr_t> = nullptr>
    #endif
    explicit constexpr Id( U i ) noexcept : id_( ValueType( i ) ) { }
 
    constexpr operator ValueType() const { return id_; }
    constexpr bool valid() const { return id_ >= 0; }
    explicit constexpr operator bool() const { return id_ >= 0; }
    constexpr ValueType & get() noexcept { return id_; }
 
    constexpr bool operator == (Id b) const { return id_ == b.id_; }
    constexpr bool operator != (Id b) const { return id_ != b.id_; }
    constexpr bool operator <  (Id b) const { return id_ <  b.id_; }
 
    template <typename U>
    bool operator == (Id<U> b) const = delete;
    template <typename U>
    bool operator != (Id<U> b) const = delete;
    template <typename U>
    bool operator < (Id<U> b) const = delete;
 
    constexpr Id & operator --() { --id_; return * this; }
    constexpr Id & operator ++() { ++id_; return * this; }
 
    constexpr Id operator --( int ) { auto res = *this; --id_; return res; }
    constexpr Id operator ++( int ) { auto res = *this; ++id_; return res; }
 
    constexpr Id & operator -=( ValueType a ) { id_ -= a; return * this; }
    constexpr Id & operator +=( ValueType a ) { id_ += a; return * this; }
 
// Allocating IDs on the heap in C is insufferable, so instead we bind them as single-member structs (via `--expose-as-struct`).
// But since our parser only tracks public members, we have to make it public for C.
#if !MR_PARSING_FOR_C_BINDINGS && !MR_COMPILING_C_BINDINGS
private:
#endif
 
    ValueType id_;
};
 
// Variant of Id<T> with omitted initialization by default. Useful for containers.
template <typename T>
class NoInitId : public Id<T>
{
public:
    NoInitId() : Id<T>( noInit ) {}
    NoInitId( Id<T> id ) : Id<T>( id ) {}
};
 
template <>
class Id<EdgeTag>
{
public:
    using ValueType = int; //the type used for internal representation of Id
 
    constexpr Id() noexcept : id_( -1 ) { }
    explicit Id( NoInit ) noexcept { }
    constexpr Id( UndirectedEdgeId u ) noexcept : id_( (ValueType)u << 1 ) { assert( u.valid() ); }
    explicit constexpr Id( ValueType i ) noexcept : id_( i ) { }
    explicit constexpr Id( unsigned int i ) noexcept : id_( i ) { }
    explicit constexpr Id( size_t i ) noexcept : id_( ValueType( i ) ) { }
    constexpr operator ValueType() const { return id_; }
    constexpr bool valid() const { return id_ >= 0; }
    explicit constexpr operator bool() const { return id_ >= 0; }
    constexpr ValueType & get() noexcept { return id_; }
 
    // returns identifier of the edge with same ends but opposite orientation
    constexpr Id sym() const { assert( valid() ); return Id(id_ ^ 1); }
    // among each pair of sym-edges: one is always even and the other is odd
    constexpr bool even() const { assert( valid() ); return (id_ & 1) == 0; }
    constexpr bool odd() const { assert( valid() ); return (id_ & 1) == 1; }
    // returns unique identifier of the edge ignoring its direction
    constexpr UndirectedEdgeId undirected() const { assert( valid() ); return UndirectedEdgeId( id_ >> 1 ); }
    constexpr operator UndirectedEdgeId() const { return undirected(); }
 
    constexpr bool operator == (Id b) const { return id_ == b.id_; }
    constexpr bool operator != (Id b) const { return id_ != b.id_; }
    constexpr bool operator <  (Id b) const { return id_ <  b.id_; }
 
    template <typename U>
    bool operator == (Id<U> b) const = delete;
    template <typename U>
    bool operator != (Id<U> b) const = delete;
    template <typename U>
    bool operator < (Id<U> b) const = delete;
 
    constexpr Id & operator --() { --id_; return * this; }
    constexpr Id & operator ++() { ++id_; return * this; }
 
    constexpr Id operator --( int ) { auto res = *this; --id_; return res; }
    constexpr Id operator ++( int ) { auto res = *this; ++id_; return res; }
 
    constexpr Id & operator -=( ValueType a ) { id_ -= a; return * this; }
    constexpr Id & operator +=( ValueType a ) { id_ += a; return * this; }
 
// See the primary template for explanation.
#if !MR_PARSING_FOR_C_BINDINGS && !MR_COMPILING_C_BINDINGS
private:
#endif
 
    ValueType id_;
};
 
template <>
class Id<VoxelTag>
{
public:
    using ValueType = size_t; //the type used for internal representation of Id
 
    constexpr Id() noexcept : id_( ~ValueType( 0 ) ) { }
    explicit Id( NoInit ) noexcept { }
    explicit constexpr Id( ValueType i ) noexcept : id_( i ) { }
    explicit constexpr Id( int ) noexcept = delete;
    constexpr operator ValueType() const { return id_; }
    constexpr bool valid() const { return id_ != ~ValueType( 0 ); }
    explicit constexpr operator bool() const { return id_ != ~ValueType( 0 ); }
    constexpr ValueType& get() noexcept { return id_; }
 
    constexpr bool operator == (Id b) const { return id_ == b.id_; }
    constexpr bool operator != (Id b) const { return id_ != b.id_; }
    constexpr bool operator <  (Id b) const { return id_ <  b.id_; }
 
    template <typename U>
    bool operator == (Id<U> b) const = delete;
    template <typename U>
    bool operator != (Id<U> b) const = delete;
    template <typename U>
    bool operator < (Id<U> b) const = delete;
 
    constexpr Id & operator --() { --id_; return * this; }
    constexpr Id & operator ++() { ++id_; return * this; }
 
    constexpr Id operator --( int ) { auto res = *this; --id_; return res; }
    constexpr Id operator ++( int ) { auto res = *this; ++id_; return res; }
 
    constexpr Id & operator -=( ValueType a ) { id_ -= a; return * this; }
    constexpr Id & operator +=( ValueType a ) { id_ += a; return * this; }
 
// See the primary template for explanation.
#if !MR_PARSING_FOR_C_BINDINGS && !MR_COMPILING_C_BINDINGS
private:
#endif
 
    ValueType id_;
};
 
template <typename T>
inline constexpr Id<T> operator + ( Id<T> id, int a )          { return Id<T>{ id.get() + a }; }
template <typename T>
inline constexpr Id<T> operator + ( Id<T> id, unsigned int a ) { return Id<T>{ id.get() + a }; }
template <typename T>
inline constexpr Id<T> operator + ( Id<T> id, size_t a )       { return Id<T>{ id.get() + a }; }
 
template <typename T>
inline constexpr Id<T> operator - ( Id<T> id, int a )          { return Id<T>{ id.get() - a }; }
template <typename T>
inline constexpr Id<T> operator - ( Id<T> id, unsigned int a ) { return Id<T>{ id.get() - a }; }
template <typename T>
inline constexpr Id<T> operator - ( Id<T> id, size_t a )       { return Id<T>{ id.get() - a }; }
 
inline constexpr FaceId operator ""_f( unsigned long long i ) noexcept { return FaceId{ (int)i }; }
inline constexpr VertId operator ""_v( unsigned long long i ) noexcept { return VertId{ (int)i }; }
inline constexpr EdgeId operator ""_e( unsigned long long i ) noexcept { return EdgeId{ (int)i }; }
inline constexpr UndirectedEdgeId operator ""_ue( unsigned long long i ) noexcept { return UndirectedEdgeId{ (int)i }; }
inline constexpr VoxelId operator ""_vox( unsigned long long i ) noexcept { return VoxelId{ size_t( i ) }; }
 
} //namespace MR
 
template <typename T>
struct std::hash<MR::Id<T>>
{
    size_t operator() ( MR::Id<T> const& p ) const noexcept
    {
        return (int)p;
    }
};