tpl_binTree.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_BINTREE_H
# define TPL_BINTREE_H
 
# include <utility>
 
# include <tpl_binTreeOps.H>
# include <ah-concepts.H>
 
using namespace Aleph;
 
namespace Aleph {
 
  template <template <typename> class NodeType, typename Key, class Compare>
    requires StrictWeakOrder<Compare, Key>
class GenBinTree
{
public:
 
  using Node = NodeType<Key>; 
 
private:
 
  Node      headNode;
  Node  *   head;
  Node *&   root;
  Compare   cmp;
 
  template <class Inserter>
  static void move_all(Node *& src, Inserter inserter) noexcept
  {
    auto rec = [&] (auto && self, Node * n) noexcept -> void
    {
      if (n == Node::NullPtr)
        return;
 
      Node * l = LLINK(n);
      Node * r = RLINK(n);
      n->reset();
      inserter(n);
      self(self, l);
      self(self, r);
    };
 
    Node * n = src;
    src = Node::NullPtr;
    rec(rec, n);
  }
 
public:
 
  GenBinTree(const GenBinTree & ) = delete;
 
  GenBinTree & operator = (const GenBinTree &) = delete;
 
  void swap(GenBinTree & tree) noexcept
  {
    std::swap(root, tree.root);
    std::swap(cmp, tree.cmp);
  }
 
  Compare & key_comp() noexcept { return cmp; }
 
  Compare & get_compare() noexcept { return key_comp(); }
 
  GenBinTree(Compare _cmp = Compare()) noexcept
    : head(&headNode), root(headNode.getR()), cmp(_cmp)
  {
    // empty
  }
 
  Node * search(const Key & key) const noexcept
  {
    return BinTree_Operation<Node, Compare>(cmp).search(root, key);
  }
 
  virtual ~GenBinTree() = default;
 
  bool verify() const { return check_bst<Node, Compare>(root, cmp); }
 
  Node *& getRoot() noexcept { return root; }
 
  Node * getRoot() const noexcept { return root; }
 
  bool verifyBin() const { return check_bst<Node, Compare>(root, cmp); } 
 
  Node * insert(Node *p) noexcept
  {
    return BinTree_Operation<Node, Compare>(cmp).insert(root, p);
  }
 
  Node * insert_dup(Node *p) noexcept
  {
    return BinTree_Operation<Node, Compare>(cmp).insert_dup(root, p);
  }
 
  Node * search_or_insert(Node *p) noexcept
  {
    return BinTree_Operation<Node, Compare>(cmp).search_or_insert(root, p);
  }
 
  bool split(const Key & key, GenBinTree & l, GenBinTree & r) noexcept
  {
    return BinTree_Operation<Node, Compare>(cmp).
      split_key_rec(root, key, l.root, r.root);
  }
 
  void split_dup(const Key & key, GenBinTree & l, GenBinTree & r) noexcept
  {
    Aleph::split_key_dup_rec<Node, Compare>(root, key, l.root, r.root, cmp);
  }
 
  Node * remove(const Key & key) noexcept
  {
    return BinTree_Operation<Node, Compare>(cmp).remove(root, key);
  }
 
  void join(GenBinTree & tree, GenBinTree & dup) noexcept
  {
    auto op = BinTree_Operation<Node, Compare>(cmp);
    move_all(tree.root, [&] (Node * n) noexcept
             {
               if (op.insert(root, n) == Node::NullPtr)
                 op.insert(dup.root, n);
             });
  }
 
  void join_dup(GenBinTree & t) noexcept
  {
    auto op = BinTree_Operation<Node, Compare>(cmp);
    move_all(t.root, [&] (Node * n) noexcept { op.insert_dup(root, n); });
  }
 
  void join_exclusive(GenBinTree & t) noexcept
  {
    root = Aleph::join_exclusive<Node>(root, t.root);
    t.root = Node::NullPtr;
  }
 
  struct Iterator : public BinNodeInfixIterator<Node>
  {
    Iterator() noexcept = default;
    Iterator(GenBinTree & tree) : BinNodeInfixIterator<Node>(tree.getRoot()) {}
    Iterator(const GenBinTree & tree)
      : BinNodeInfixIterator<Node>(tree.getRoot()) {}
  };
};
 
    template <typename Key, class Compare = Aleph::less<Key>>
    requires StrictWeakOrder<Compare, Key>
struct BinTree : public GenBinTree<BinNode, Key, Compare>
{
  using Base = GenBinTree<BinNode, Key, Compare>;
  using Base::Base;
};
 
 
    template <typename Key, class Compare = Aleph::less<Key>>
    requires StrictWeakOrder<Compare, Key>
struct BinTreeVtl : public GenBinTree<BinNodeVtl, Key, Compare>
{
  using Base = GenBinTree<BinNodeVtl, Key, Compare>;
  using Base::Base;
};
 
 
} // end namespace Aleph
# endif /* TPL_BINTREE_H */