storage: switch index data structure from skiplist to std::set

test performance of skiplist and std::set

Change-Id: I0aa7f34e57f17a83b96fed3885d6cc6f59ad52dd
diff --git a/src/storage/index.cpp b/src/storage/index.cpp
index b141b51..2bf17ac 100644
--- a/src/storage/index.cpp
+++ b/src/storage/index.cpp
@@ -18,7 +18,6 @@
  */
 
 #include "index.hpp"
-#include "skiplist.hpp"
 
 #include <ndn-cxx/util/crypto.hpp>
 #include "ndn-cxx/security/signature-sha256-with-rsa.hpp"
@@ -70,7 +69,7 @@
   if (isFull())
     throw Error("The Index is Full. Cannot Insert Any Data!");
   Entry entry(data, id);
-  bool isInserted = m_skipList.insert(entry).second;
+  bool isInserted = m_indexContainer.insert(entry).second;
   if (isInserted)
     ++m_size;
   return isInserted;
@@ -83,7 +82,7 @@
   if (isFull())
     throw Error("The Index is Full. Cannot Insert Any Data!");
   Entry entry(fullName, keyLocatorHash, id);
-  bool isInserted = m_skipList.insert(entry).second;
+  bool isInserted = m_indexContainer.insert(entry).second;
   if (isInserted)
     ++m_size;
   return isInserted;
@@ -93,8 +92,8 @@
 Index::find(const Interest& interest) const
 {
   Name name = interest.getName();
-  IndexSkipList::const_iterator result = m_skipList.lower_bound(name);
-  if (result != m_skipList.end())
+  IndexContainer::const_iterator result = m_indexContainer.lower_bound(name);
+  if (result != m_indexContainer.end())
     {
       return selectChild(interest, result);
     }
@@ -107,8 +106,8 @@
 std::pair<int64_t,Name>
 Index::find(const Name& name) const
 {
-  IndexSkipList::const_iterator result = m_skipList.lower_bound(name);
-  if (result != m_skipList.end())
+  IndexContainer::const_iterator result = m_indexContainer.lower_bound(name);
+  if (result != m_indexContainer.end())
     {
       return findFirstEntry(name, result);
     }
@@ -122,16 +121,16 @@
 Index::hasData(const Data& data) const
 {
   Index::Entry entry(data, -1); // the id number is useless
-  IndexSkipList::const_iterator result = m_skipList.find(entry);
-  return result != m_skipList.end();
+  IndexContainer::const_iterator result = m_indexContainer.find(entry);
+  return result != m_indexContainer.end();
 
 }
 
 std::pair<int64_t,Name>
 Index::findFirstEntry(const Name& prefix,
-                      IndexSkipList::const_iterator startingPoint) const
+                      IndexContainer::const_iterator startingPoint) const
 {
-  BOOST_ASSERT(startingPoint != m_skipList.end());
+  BOOST_ASSERT(startingPoint != m_indexContainer.end());
   if (prefix.isPrefixOf(startingPoint->getName()))
     {
       return std::make_pair(startingPoint->getId(), startingPoint->getName());
@@ -146,10 +145,10 @@
 Index::erase(const Name& fullName)
 {
   Entry entry(fullName);
-  IndexSkipList::const_iterator findIterator = m_skipList.find(entry);
-  if (findIterator != m_skipList.end())
+  IndexContainer::const_iterator findIterator = m_indexContainer.find(entry);
+  if (findIterator != m_indexContainer.end())
     {
-      m_skipList.erase(findIterator);
+      m_indexContainer.erase(findIterator);
       m_size--;
       return true;
     }
@@ -167,9 +166,9 @@
 
 std::pair<int64_t,Name>
 Index::selectChild(const Interest& interest,
-                   IndexSkipList::const_iterator startingPoint) const
+                   IndexContainer::const_iterator startingPoint) const
 {
-  BOOST_ASSERT(startingPoint != m_skipList.end());
+  BOOST_ASSERT(startingPoint != m_indexContainer.end());
   bool isLeftmost = (interest.getChildSelector() <= 0);
   ndn::ConstBufferPtr hash;
   if (!interest.getPublisherPublicKeyLocator().empty())
@@ -181,8 +180,8 @@
 
   if (isLeftmost)
     {
-      for (IndexSkipList::const_iterator it = startingPoint;
-           it != m_skipList.end(); ++it)
+      for (IndexContainer::const_iterator it = startingPoint;
+           it != m_indexContainer.end(); ++it)
         {
           if (!interest.getName().isPrefixOf(it->getName()))
             return std::make_pair(0, Name());
@@ -192,15 +191,15 @@
     }
   else
     {
-      IndexSkipList::const_iterator boundary = m_skipList.lower_bound(interest.getName());
-      if (boundary == m_skipList.end() || !interest.getName().isPrefixOf(boundary->getName()))
+      IndexContainer::const_iterator boundary = m_indexContainer.lower_bound(interest.getName());
+      if (boundary == m_indexContainer.end() || !interest.getName().isPrefixOf(boundary->getName()))
         return std::make_pair(0, Name());
       Name successor = interest.getName().getSuccessor();
-      IndexSkipList::const_iterator last = interest.getName().size() == 0 ?
-                    m_skipList.end() : m_skipList.lower_bound(interest.getName().getSuccessor());
+      IndexContainer::const_iterator last = interest.getName().size() == 0 ?
+                    m_indexContainer.end() : m_indexContainer.lower_bound(interest.getName().getSuccessor());
       while (true)
         {
-          IndexSkipList::const_iterator prev = last;
+          IndexContainer::const_iterator prev = last;
           --prev;
           if (prev == boundary)
             {
@@ -212,9 +211,9 @@
               else
                 return std::make_pair(0, Name());
             }
-          IndexSkipList::const_iterator first =
-            m_skipList.lower_bound(prev->getName().getPrefix(interest.getName().size() + 1));
-          IndexSkipList::const_iterator match =
+          IndexContainer::const_iterator first =
+            m_indexContainer.lower_bound(prev->getName().getPrefix(interest.getName().size() + 1));
+          IndexContainer::const_iterator match =
                      std::find_if(first, last, bind(&matchesSimpleSelectors, interest, hash, _1));
           if (match != last)
             {
diff --git a/src/storage/index.hpp b/src/storage/index.hpp
index 90f7436..ee8eca4 100644
--- a/src/storage/index.hpp
+++ b/src/storage/index.hpp
@@ -21,8 +21,7 @@
 #define REPO_STORAGE_INDEX_HPP
 
 #include "common.hpp"
-#include "skiplist.hpp"
-#include <queue>
+#include <set>
 
 namespace repo {
 
@@ -55,7 +54,7 @@
   public:
 
     /**
-     * @brief used by skiplist to construct node
+     * @brief used by set to construct node
      */
     Entry()
     {
@@ -82,7 +81,7 @@
     /**
      *  @brief implicit construct Entry by full name
      *
-     *  Allow implicit conversion from Name for SkipList lookups by Name
+     *  Allow implicit conversion from Name for set lookups by Name
      */
     Entry(const Name& name);
 
@@ -145,7 +144,7 @@
 
 private:
 
-  typedef SkipList<Entry> IndexSkipList;
+  typedef std::set<Entry> IndexContainer;
 
 public:
   explicit
@@ -214,7 +213,7 @@
    */
   std::pair<int64_t, Name>
   selectChild(const Interest& interest,
-              IndexSkipList::const_iterator startingPoint) const;
+              IndexContainer::const_iterator startingPoint) const;
 
   /**
    *  @brief check whether the index is full
@@ -234,10 +233,10 @@
    */
   std::pair<int64_t, Name>
   findFirstEntry(const Name& prefix,
-                 IndexSkipList::const_iterator startingPoint) const;
+                 IndexContainer::const_iterator startingPoint) const;
 
 private:
-  IndexSkipList m_skipList;
+  IndexContainer m_indexContainer;
   size_t m_maxPackets;
   size_t m_size;
 };
diff --git a/src/storage/skiplist.hpp b/src/storage/skiplist.hpp
deleted file mode 100644
index e6dd6a0..0000000
--- a/src/storage/skiplist.hpp
+++ /dev/null
@@ -1,439 +0,0 @@
-/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/**
-* Copyright (c) 2014, Regents of the University of California.
-*
-* This file is part of NDN repo-ng (Next generation of NDN repository).
-* See AUTHORS.md for complete list of repo-ng authors and contributors.
-*
-* repo-ng is free software: you can redistribute it and/or modify it under the terms
-* of the GNU General Public License as published by the Free Software Foundation,
-* either version 3 of the License, or (at your option) any later version.
-*
-* repo-ng is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
-* PURPOSE. See the GNU General Public License for more details.
-*
-* You should have received a copy of the GNU General Public License along with
-* repo-ng, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
-*/
-
-#ifndef REPO_STORAGE_SKIPLIST_HPP
-#define REPO_STORAGE_SKIPLIST_HPP
-
-#include "common.hpp"
-
-namespace repo {
-
-class SkipList32Levels25Probabilty
-{
-public:
-  static size_t
-  getMaxLevels()
-  {
-    return 32;
-  }
-
-  static double
-  getProbability()
-  {
-    return 0.25;  // 25%
-  }
-};
-
-template<typename T>
-struct SkipListNode
-{
-  typedef SkipListNode<T>* SkipListNodePointer;
-  T data;
-  std::vector<SkipListNodePointer> prevs;
-  std::vector<SkipListNodePointer> nexts;
-};
-
-template<typename T, class Ref, class Ptr>
-class SkipListIterator : public std::iterator<std::bidirectional_iterator_tag, T>
-{
-public:
-  typedef SkipListNode<T>* NodePointer;
-  NodePointer node;
-
-  typedef SkipListIterator<T, Ref, Ptr> Self;
-  typedef T value_type;
-  typedef Ptr pointer;
-  typedef Ref reference;
-  typedef ptrdiff_t difference_type;
-  typedef SkipListIterator<T, const T&, const T*> const_iterator;
-  /// alias of const_iterator
-  typedef const_iterator iterator;
-
-public:
-  // constructor
-  SkipListIterator()
-  {
-  }
-
-  explicit
-  SkipListIterator(NodePointer x)
-    : node(x)
-  {
-  }
-
-  SkipListIterator(const SkipListIterator& x)
-    : node(x.node)
-  {
-  }
-
-  bool
-  operator==(const const_iterator& x) const
-  {
-    return node == x.node;
-  }
-
-  bool
-  operator!=(const const_iterator& x) const
-  {
-    return node != x.node;
-  }
-
-  reference
-  operator*() const
-  {
-    return (*node).data;
-  }
-
-  pointer
-  operator->() const
-  {
-    return &(operator*());
-  }
-
-  Self&
-  operator++()
-  {
-    node = node->nexts[0];
-    return *this;
-  }
-
-  Self
-  operator++(int)
-  {
-    Self tmp = *this;
-    ++*this;
-    return tmp;
-  }
-
-  Self&
-  operator--()
-  {
-    node = node->prevs[0];
-    return *this;
-  }
-
-  Self
-  operator--(int)
-  {
-    Self tmp = *this;
-    --*this;
-    return tmp;
-  }
-};
-
-/*
- * @brief SkipList
- *
- * Examples of internal structure:
- * "A <-i-> B" means A->nexts[i] = B and B->prevs[i] = A
- *
- * case 1: an empty skip list
- * m_head <-0-> m_head
- *
- * case 2: a skip list with only one level and only one node
- * m_head <-0-> A <-0-> m_head
- *
- * case 3: a skip list with three nodes, node A and B appear on one level,
- * node C appears on two levels
- * m_head         <-1->         C <-1-> m_head
- * m_head <-0-> A <-0-> B <-0-> C <-0-> m_head
- */
-
-template<typename T, typename Compare = std::less<T>,
-         typename Traits = SkipList32Levels25Probabilty>
-class SkipList
-{
-public:
-  typedef T value_type;
-  typedef value_type* pointer;
-  typedef const value_type* const_pointer;
-  typedef value_type& reference;
-  typedef const value_type& const_reference;
-  typedef SkipListNode<T> Node;
-  typedef Node* NodePointer;
-  typedef size_t size_type;
-  typedef ptrdiff_t difference_type;
-  typedef SkipListIterator<T, const T&, const T*> const_iterator;
-  /// alias of const_iterator
-  typedef const_iterator iterator;
-
-public:
-  explicit
-  SkipList()
-  {
-    initializeHead();
-  }
-
-  ~SkipList()
-  {
-    clear();
-    deallocateNode(m_head);
-  }
-
-  const_iterator
-  begin() const
-  {
-    return const_iterator(*(*m_head).nexts.begin());
-  }
-
-  const_iterator
-  end() const
-  {
-    return const_iterator(m_head);
-  }
-
-  bool
-  empty() const
-  {
-    return *(m_head->nexts.begin()) == m_head;
-  }
-
-  size_t
-  size() const
-  {
-    return m_size;
-  }
-
-  const_iterator
-  lower_bound(const T& x) const;
-
-  const_iterator
-  find(const T& x) const;
-
-  std::pair<const_iterator, bool>
-  insert(const T& x);
-
-  const_iterator
-  erase(const_iterator it);
-
-protected:
-  /*
-   * @brief allocate memory for node
-   */
-  NodePointer
-  allocateNode()
-  {
-    return m_skiplistAllocator.allocate(sizeof(Node));
-  }
-
-  /*
-   * @brief deallocate memory of node
-   */
-  void
-  deallocateNode(NodePointer p)
-  {
-    m_skiplistAllocator.deallocate(p, sizeof(Node));
-  }
-
-  /*
-   * @brief initialize the node
-   */
-  NodePointer
-  createNode()
-  {
-    NodePointer p = allocateNode();
-    Node node;
-    m_skiplistAllocator.construct(p, node);
-    return p;
-  }
-
-  /*
-   * @brief initialize the node with given value
-   * @para to be set to the value of node
-   */
-  NodePointer
-  createNode(const T& x)
-  {
-    NodePointer p = allocateNode();
-    Node node;
-    m_skiplistAllocator.construct(p, node);
-    m_dataAllocator.construct(&(p->data), x);
-    return p;
-  }
-
-  /*
-   * @brief destructror of the node
-   * @para given pointer of node to be destructed
-   */
-  void
-  destroyNode(NodePointer p)
-  {
-    m_skiplistAllocator.destroy(p);
-    deallocateNode(p);
-  }
-
-  /*
-   * @brief initialize the head
-   */
-  void
-  initializeHead()
-  {
-    m_head = createNode();
-    m_head->prevs.push_back(m_head);
-    m_head->nexts.push_back(m_head);
-    m_size = 0;
-  }
-
-  /*
-   * @brief destroy all the nodes of skiplist except the head
-   */
-  void
-  clear()
-  {
-    NodePointer cur = m_head->nexts[0];
-    while (cur != m_head) {
-      NodePointer tmp = cur;
-      cur = cur->nexts[0];
-      destroyNode(tmp);
-    }
-    m_head->nexts[0] = m_head;
-    m_head->prevs[0] = m_head;
-  }
-
-  /*
-   * @brief pick a random height for inserted skiplist entry
-   */
-  size_t
-  pickRandomLevel() const
-  {
-    static boost::random::mt19937 gen;
-    static boost::random::geometric_distribution<size_t> dist(Traits::getProbability());
-    return std::min(dist(gen), Traits::getMaxLevels());
-  }
-
-protected:
-  NodePointer m_head;
-  std::allocator<Node> m_skiplistAllocator;
-  std::allocator<T> m_dataAllocator;
-  Compare m_compare;
-  size_t m_size;
-};
-
-
-template<typename T, typename Compare, typename Traits>
-typename SkipList<T, Compare, Traits>::const_iterator
-SkipList<T, Compare, Traits>::lower_bound(const T& x) const
-{
-  size_t nLevels = m_head->nexts.size();
-  NodePointer p = m_head;
-  NodePointer q = p->nexts[nLevels - 1];
-  for (int i = nLevels - 1; i >= 0; --i) {
-    q = p->nexts[i];
-    if (q != m_head) {
-      while (m_compare(q->data, x)) {
-        p = p->nexts[i];
-        q = p->nexts[i];
-        if (q == m_head) {
-          break;
-        }
-      }
-    }
-  }
-  return const_iterator(q);
-}
-
-template<typename T, typename Compare, typename Traits>
-typename SkipList<T, Compare, Traits>::const_iterator
-SkipList<T, Compare, Traits>::find(const T& x) const
-{
-  const_iterator it = this->lower_bound(x);
-  if (it == this->end() || *it != x)
-    return this->end();
-  return it;
-}
-
-template<typename T, typename Compare, typename Traits>
-std::pair<typename SkipList<T, Compare, Traits>::const_iterator, bool>
-SkipList<T, Compare, Traits>::insert(const T& x)
-{
-  size_t nLevels = m_head->nexts.size();
-  // 1. find insert position
-  std::vector<NodePointer> insertPositions(nLevels);
-  NodePointer p = m_head;
-  NodePointer q = p->nexts[nLevels - 1];
-  for (int i = nLevels - 1; i >= 0; --i) {
-    q = p->nexts[i];
-    if (q != m_head) {
-      while (m_compare(q->data, x)) {
-        p = p->nexts[i];
-        q = p->nexts[i];
-        if (q == m_head) {
-          break;
-        }
-      }
-    }
-    insertPositions[i] = p;
-  }
-  // 2. whether q->data == x?
-  if (q != m_head)
-    if (!m_compare(q->data, x) && !m_compare(x, q->data)) {
-      return std::pair<const_iterator, bool>(const_iterator(q), false);
-    }
-  // 3. construct new node;
-  NodePointer newNode = createNode(x);
-  // 4. pick random nLevels
-  size_t newLevel = pickRandomLevel();
-  // 5. insert the new node
-  newNode->nexts.resize(newLevel + 1);
-  newNode->prevs.resize(newLevel + 1);
-  if (newLevel > nLevels - 1) {
-    m_head->nexts.resize(newLevel + 1, m_head);
-    m_head->prevs.resize(newLevel + 1, m_head);
-    insertPositions.resize(newLevel + 1, m_head);
-  }
-  for (size_t i = 0; i <= newLevel; i++) {
-    newNode->nexts[i] = insertPositions[i]->nexts[i];
-    newNode->prevs[i] = insertPositions[i];
-    insertPositions[i]->nexts[i] = newNode;
-    newNode->nexts[i]->prevs[i] = newNode;
-  }
-
-  ++m_size;
-  return std::pair<const_iterator, bool>(const_iterator(newNode), true);
-}
-
-template<typename T, typename Compare, typename Traits>
-typename SkipList<T, Compare, Traits>::const_iterator
-SkipList<T, Compare, Traits>::erase(typename SkipList<T, Compare, Traits>::const_iterator it)
-{
-  NodePointer eraseNode = it.node;
-  if (!empty() && eraseNode != m_head) {
-    NodePointer returnNode = eraseNode->nexts[0];
-    size_t nLevels = eraseNode->nexts.size();
-    for (int i = nLevels - 1; i >= 0; --i) {
-      eraseNode->nexts[i]->prevs[i] = eraseNode->prevs[i];
-      eraseNode->prevs[i]->nexts[i] = eraseNode->nexts[i];
-      // clear empty nLevels
-      if ((eraseNode->nexts[i] == eraseNode->prevs[i]) && i > 0) {
-        m_head->nexts.pop_back();
-        m_head->prevs.pop_back();
-      }
-    }
-    destroyNode(eraseNode);
-    --m_size;
-    return const_iterator(returnNode);
-  }
-  else {
-    return end();
-  }
-}
-
-} // namespace repo
-
-#endif // REPO_STORAGE_SKIPLIST_HPP