tpl_binNode.H

Go to the documentation of this file.

 
/*
                          Aleph_w
 
  Data structures & Algorithms
  version 2.0.0b
  https://github.com/lrleon/Aleph-w
 
  This file is part of Aleph-w library
 
  Copyright (c) 2002-2026 Leandro Rabindranath Leon
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
 
 
# ifndef TPL_BINNODE_H
# define TPL_BINNODE_H
 
# include <iostream>
# include <stdexcept>
# include <type_traits>
# include <utility>
# include <ahDefs.H>
# include <ahAssert.H>
 # include <ah-errors.H>
 
namespace Aleph
{
  struct Empty_Node
  {
    Empty_Node() = default;
 
    explicit Empty_Node(SentinelCtor) noexcept
    { /* empty */
    }
 
    static void reset() noexcept
    { /* empty */
    }
 
    static Empty_Node &get_data()
    {
      ah_domain_error() << "Empty_Node has no data";
# if defined(__GNUC__) || defined(__clang__)
      __builtin_unreachable();
# elif defined(_MSC_VER)
      __assume(0);
# endif
    }
  };
 
# define INIT_CLASS_BINNODE(Name, height, Control_Data)               \
  template <typename Key>                                             \
  class Name : public Control_Data                                    \
  {                                                                   \
public:                                                               \
 static const size_t MaxHeight = height;                              \
 static Name * const NullPtr;                                         \
 typedef Key key_type;                                                \
 typedef Key Key_Type;                                                \
                                                                      \
private:                                                              \
                                                                      \
 Key    key = Key();                                                  \
 Name * lLink;                                                        \
 Name * rLink;                                                        \
                                                                      \
public:                                                               \
                                                                      \
 Key & get_key() noexcept { return key; }                             \
 const Key & get_key() const noexcept { return key; }                 \
 Name *& getL() noexcept { return lLink; }                            \
 Name *& getR() noexcept { return rLink; }                            \
 const Name * getL() const noexcept { return lLink; }                 \
 const Name * getR() const noexcept { return rLink; }                 \
 Name(const Key& k)                              \
   : key(k), lLink(NullPtr), rLink(NullPtr)                           \
 {                                                                    \
   static_assert(std::is_copy_constructible<Key>::value,              \
                 "No copy constructor for Key");                      \
 }                                                                    \
 Name(Key && k) noexcept                                              \
   : key(std::move(k)), lLink(NullPtr), rLink(NullPtr)                \
 {                                                                    \
   static_assert(std::is_move_constructible<Key>::value,              \
                 "No move constructor for Key");                      \
 }                                                                    \
 Name(const Control_Data & control_data, const Key & k)               \
   : Control_Data(control_data),                                      \
     key(k), lLink(NullPtr), rLink(NullPtr)                           \
 {                                                                    \
   /* Empty */                                                        \
 }                                                                    \
 Name(const Name & node)                          \
   : Control_Data(node),                                              \
     key(node.key), lLink(NullPtr), rLink(NullPtr)                    \
 {                                                                    \
   /* Empty */                                                        \
 }                                                                    \
 Name(Name && node)                                                   \
   : Control_Data(std::move(static_cast<Control_Data &>(node))),      \
     key(std::move(node.key)), lLink(NullPtr), rLink(NullPtr)         \
 {                                                                    \
   /* Empty */                                                        \
 }                                                                    \
 Name(const Control_Data & control_data) noexcept :                   \
   Control_Data(control_data),                                        \
   lLink(NullPtr), rLink(NullPtr)                                     \
 {                                                                    \
   /* Empty */                                                        \
 }                                                                    \
 Name()                                      \
 : lLink(NullPtr), rLink(NullPtr)                                     \
 {                                                                    \
   static_assert(std::is_default_constructible<Key>::value,           \
                 "No default constructor for Key");                   \
 }                                                                    \
 void reset() noexcept                                                \
 {                                                                    \
   Control_Data::reset();                                             \
   rLink = lLink = NullPtr;                                           \
 }                                                                    \
 static Name * key_to_node(Key & __key) noexcept                      \
 {                                                                    \
   const size_t offset = __builtin_offsetof(Name, key);               \
   char * addr = reinterpret_cast<char *>(&__key);                    \
   return reinterpret_cast<Name *>(addr - offset);                    \
 }
 
 
# define DECLARE_BINNODE(Name, height, Control_Data)                    \
  INIT_CLASS_BINNODE(Name, height, Control_Data)                        \
};                                                                      \
  template <typename Key> Name<Key> * const Name<Key>::NullPtr = nullptr; \
  INIT_CLASS_BINNODE(Name##Vtl, height, Control_Data)                   \
  virtual ~Name##Vtl() { /* empty */ }                                  \
};                                                                      \
  template <typename Key> Name##Vtl<Key> *                              \
  const Name##Vtl<Key>::NullPtr = nullptr
 
 
# define DECLARE_BINNODE_SENTINEL(Name, height, Control_Data)       \
  INIT_CLASS_BINNODE(Name, height, Control_Data)                    \
  Name(SentinelCtor) :                                              \
  Control_Data(sentinelCtor), lLink(NullPtr), rLink(NullPtr) {}     \
  static Name sentinel_node;                                        \
};                                                                  \
  template <typename Key>                                           \
  Name<Key> Name<Key>::sentinel_node(sentinelCtor);                 \
  template <typename Key>                                           \
  Name<Key> * const Name<Key>::NullPtr = &Name<Key>::sentinel_node;    \
  INIT_CLASS_BINNODE(Name##Vtl, height, Control_Data)               \
  virtual ~Name##Vtl() { /* empty */ }                              \
private:                                                            \
 Name##Vtl(SentinelCtor) :                                          \
 Control_Data(sentinelCtor), lLink(NullPtr), rLink(NullPtr) {}      \
 static Name##Vtl sentinel_node;                                    \
};                                                                  \
  template <typename Key>                                           \
  Name##Vtl<Key> Name##Vtl<Key>::sentinel_node(sentinelCtor);       \
  template <typename Key>                                           \
  Name##Vtl<Key> * const Name##Vtl<Key>::NullPtr =                  \
    &Name##Vtl<Key>::sentinel_node
 
  template <class Node>
  constexpr inline Node *&LLINK(Node *p) noexcept
  {
    return p->getL();
  }
 
  template <class Node>
  constexpr inline const Node *LLINK(const Node *p) noexcept
  {
    return p->getL();
  }
 
  template <class Node>
  constexpr inline Node *&RLINK(Node *p) noexcept
  {
    return p->getR();
  }
 
  template <class Node>
  constexpr inline const Node *RLINK(const Node *p) noexcept
  {
    return p->getR();
  }
 
  template <class Node>
  constexpr inline
  typename Node::Key_Type &KEY(Node *p) noexcept
  {
    return p->get_key();
  }
 
  template <class Node>
  constexpr inline
  const typename Node::Key_Type &KEY(const Node *p) noexcept
  {
    return p->get_key();
  }
 
  template <class Node>
  struct node_traits
  {
    using node_type = Node;
    using key_type = typename Node::Key_Type;
 
    static constexpr node_type * null() noexcept { return node_type::NullPtr; }
 
    static constexpr node_type *& left(node_type * p) noexcept { return p->getL(); }
    static constexpr node_type *& right(node_type * p) noexcept { return p->getR(); }
 
    static const node_type * left(const node_type * p) noexcept { return p->getL(); }
    static const node_type * right(const node_type * p) noexcept { return p->getR(); }
 
    static key_type & key(node_type * p) noexcept { return p->get_key(); }
    static const key_type & key(const node_type * p) noexcept { return p->get_key(); }
  };
 
  DECLARE_BINNODE(BinNode, 2048, Empty_Node);
} // end namespace Aleph
# endif