priority_queue_cxx17 0.3.5

data/ext/fast_containers/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+extension_name = 'fast_containers'
+
+create_makefile(extension_name)

data/ext/fast_containers/fc_pq.cpp

@@ -0,0 +1,158 @@
+// Copyright (c) 2014 Roberto Esposito
+//
+// 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.
+#include "fc_pq.h"
+#include <iostream>
+
+namespace fc_pq {
+
+  typedef std::pair<void*,double> PQElem;
+
+  class PairsComparator
+  {
+    bool reverse;
+  public:
+    PairsComparator(PQueueKind kind) {reverse=(kind==MIN_QUEUE);}
+    bool operator() (const PQElem& lhs, const PQElem& rhs) const
+    {
+      if (reverse) return (lhs.second>rhs.second);
+      else return (lhs.second<rhs.second);
+    }
+  };
+
+  // --------------------------------------
+  // PQueue
+  // --------------------------------------
+
+  typedef std::vector<PQElem> PQueueStorage;
+  typedef unsigned int PQueueStorageVersion;
+
+  typedef struct _PQueue {
+    PQueueStorage storage;
+    PairsComparator comparator;
+    PQueueStorageVersion version;
+
+    _PQueue(PQueueKind kind) : comparator(kind), version(0) { }
+  }* PQueue;
+
+  void destroy(PQueue q){
+    delete q;
+  }
+
+  PQueue create(PQueueKind kind) {
+    return new _PQueue(kind);
+  }
+
+  /* Getting the size of the container */
+  unsigned int size(PQueue q) {
+     return q->storage.size();
+  }
+
+
+  void push(PQueue q, void* value, double priority) {
+    q->version++;
+    q->storage.push_back(PQElem(value, priority));
+    push_heap(q->storage.begin(), q->storage.end(), q->comparator);
+  }
+
+  void* top(PQueue q) {
+    return q->storage.at(0).first;
+  }
+
+  double top_key(PQueue q) {
+    return q->storage.at(0).second;
+  }
+
+  double second_best_key(PQueue q) {
+     if(q->storage.size()==2)
+        return q->storage.at(1).second;
+
+     double key1 = q->storage.at(1).second;
+     double key2 = q->storage.at(2).second;
+     if( key1 > key2 ) {
+        return key1;
+     } else {
+        return key2;
+     }
+  }
+
+  void pop(PQueue q) {
+    q->version++;
+    pop_heap(q->storage.begin(), q->storage.end(), q->comparator);
+    q->storage.pop_back();
+  }
+
+  bool empty(PQueue q) {
+    return q->storage.empty();
+  }
+
+  // --------------------------------------
+  // Iterator
+  // --------------------------------------
+
+
+  typedef struct _PQueueIterator {
+    PQueueStorage::const_iterator iterator;
+    PQueue pqueue;
+    PQueueStorage* storage;
+    PQueueStorageVersion version;
+
+    _PQueueIterator(PQueue q) : iterator(q->storage.begin()), pqueue(q), storage(&q->storage), version(q->version)
+      { }
+
+    void checkVersion() throw() {
+      if(version != pqueue->version) {
+        std::terminate();
+      }
+    }
+  } PQueueImplIterator;
+  #define QIT(it) ((PQueueImplIterator*)(it))
+
+  /* Returns a new iterator object */
+  PQueueIterator iterator(PQueue q) {
+    PQueueImplIterator* it = new PQueueImplIterator(q);
+    return it;
+  }
+
+  void iterator_dispose(PQueueIterator it) {
+    delete it;
+  }
+
+  /* Returns the value of the current element */
+  void* iterator_get_value(PQueueIterator it) {
+    return it->iterator->first;
+  }
+
+  /* Returns the priority of the current  element */
+  double iterator_get_key(PQueueIterator it) {
+    return it->iterator->second;
+  }
+
+  /* Moves on to the next element */
+  PQueueIterator iterator_next(PQueueIterator it) throw() {
+    it->checkVersion();
+    it->iterator++;
+    return it;
+  }
+
+  bool iterator_end(PQueueIterator it) {
+    return it->iterator == it->storage->end();
+  }
+}

data/ext/fast_containers/fc_pq.h

@@ -0,0 +1,84 @@
+// Copyright (c) 2014 Roberto Esposito
+//
+// 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 FC_QUEUE_H_KTY6FH1S
+#define FC_QUEUE_H_KTY6FH1S
+
+#include <queue>
+#include <stdexcept>
+
+namespace fc_pq {
+  class PQueueException : public std::runtime_error {
+  public:
+    PQueueException(const char* msg) : std::runtime_error(msg) {}
+  };
+
+  typedef struct _PQueue* PQueue;
+  typedef struct _PQueueIterator* PQueueIterator;
+  typedef enum { MIN_QUEUE, MAX_QUEUE } PQueueKind;
+
+  /* Constructor. It defaults to construct a max queue. If true is passed
+  it construct a min queue.*/
+  PQueue create(PQueueKind kind);
+
+  /* Destructor */
+  void destroy(PQueue q);
+
+  /* Getting the size of the container */
+  unsigned int size(PQueue q);
+
+  /* Adding elements */
+  void push(PQueue q, void* value, double priority);
+
+  /* Inspecting the queue top (for values) */
+  void* top(PQueue q);
+
+  /* Inspecting the queue top (for priorities) */
+  double top_key(PQueue q);
+
+ /* Returns the priority of the next best element */
+  double second_best_key(PQueue q);
+
+  /* Removing the queue top */
+  void pop(PQueue q);
+
+  /* Returns true if the queue is empty */
+  bool empty(PQueue q);
+
+  /* Returns a new iterator object */
+  PQueueIterator iterator(PQueue q);
+
+  /* Dispose the iterator */
+  void iterator_dispose(PQueueIterator it);
+
+  /* Returns the value of the current element */
+  void* iterator_get_value(PQueueIterator it);
+
+  /* Returns the priority of the current  element */
+  double iterator_get_key(PQueueIterator it);
+
+  /* Moves on to the next element */
+  PQueueIterator iterator_next(PQueueIterator it) throw();
+
+  /* Return true if the iterator is already out of the container */
+  bool iterator_end(PQueueIterator it);
+}
+
+#endif /* end of include guard: FC_QUEUE_H_KTY6FH1S */

data/lib/fc.rb

@@ -0,0 +1,32 @@
+# Copyright (c) 2014 Roberto Esposito
+#
+# 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.
+require 'fast_containers'
+
+module FastContainers
+  VERSION = "0.3.4"
+
+  class PriorityQueue
+    include Enumerable
+
+    alias_method :next, :top
+    alias_method :next_key, :top_key
+  end
+end

data/test/performance/test_fc_vs_algorithms.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2014 Roberto Esposito
+#
+# 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.
+require 'fc'
+require 'algorithms'
+require 'benchmark'
+
+# Performs 50.000 pushes and pops in priority queues using the fc and
+# algorithms implementations and reports the time spent.
+
+N = 50_000
+algo_pq = Containers::PriorityQueue.new
+fc_pq = FastContainers::PriorityQueue.new(:min)
+
+Benchmark.bm do |bm|
+  bm.report('algo:push') { N.times { |n| algo_pq.push(n.to_s, rand) } }
+  bm.report('fc:push')   { N.times { |n| fc_pq.push(n.to_s, rand) } }
+  bm.report('algo:pop')  { N.times { algo_pq.pop } }
+  bm.report('fc:pop')    { N.times { fc_pq.pop } }
+end

data/test/performance/test_fc_vs_cpriority_queue.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2014 Roberto Esposito
+#
+# 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.
+require 'fc'
+require 'priority_queue'
+require 'benchmark'
+
+# Performs 5,000,000 pushes and pops in priority queues using the fc and
+# algorithms implementations and reports the time spent.
+
+N = 5_000_000
+pq_pq = CPriorityQueue.new
+fc_pq = FastContainers::PriorityQueue.new(:min)
+
+Benchmark.bm do |bm|
+  bm.report('pq:push') { N.times { |n| pq_pq.push(n.to_s,rand) } }
+  bm.report('fc:push')   { N.times { |n| fc_pq.push(n.to_s, rand) } }
+  bm.report('pq:pop')  { N.times { pq_pq.delete_min } }
+  bm.report('fc:pop')    { N.times { fc_pq.pop } }
+end

data/test/performance/test_fc_vs_em_priority_queue.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2014 Roberto Esposito
+#
+# 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.
+require 'fc'
+require 'em-priority-queue'
+require 'benchmark'
+
+# Performs 50.000 pushes and pops in priority queues using the fc and
+# algorithms implementations and reports the time spent.
+
+N = 500_000
+em_pq = EM::PriorityQueue.new
+fc_pq = FastContainers::PriorityQueue.new(:min)
+
+Benchmark.bm do |bm|
+  bm.report('em:push') { N.times { |n| em_pq.push(n.to_s, rand) } }
+  bm.report('fc:push') { N.times { |n| fc_pq.push(n.to_s, rand) } }
+  bm.report('em:pop')  { N.times { em_pq.pop {} } }
+  bm.report('fc:pop')  { N.times { fc_pq.pop } }
+end

data/test/performance/test_fc_vs_pqueue.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2014 Roberto Esposito
+#
+# 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.
+require 'fc'
+require 'pqueue'
+require 'benchmark'
+
+# Performs 50.000 pushes and pops in priority queues using the fc and
+# algorithms implementations and reports the time spent.
+
+N = 100_000
+pq_pq = PQueue.new { |x,y| x[1] <=> y[1] }
+fc_pq = FastContainers::PriorityQueue.new(:min)
+
+Benchmark.bm do |bm|
+  bm.report('pq:push') { N.times { |n| pq_pq.push([n,rand]) } }
+  bm.report('fc:push')   { N.times { |n| fc_pq.push(n.to_s, rand) } }
+  bm.report('pq:pop')  { N.times { pq_pq.pop } }
+  bm.report('fc:pop')    { N.times { fc_pq.pop } }
+end

data/test/performance/test_fc_vs_priority_queue.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2014 Roberto Esposito
+#
+# 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.
+require 'fc'
+require 'priority_queue'
+require 'benchmark'
+
+# Performs 50.000 pushes and pops in priority queues using the fc and
+# algorithms implementations and reports the time spent.
+
+N = 50_000
+pq_pq = PriorityQueue.new
+fc_pq = FastContainers::PriorityQueue.new(:min)
+
+Benchmark.bm do |bm|
+  bm.report('pq:push') { N.times { |n| pq_pq[rand] << n.to_s } }
+  bm.report('fc:push')   { N.times { |n| fc_pq.push(n.to_s, rand) } }
+  bm.report('pq:pop')  { N.times { pq_pq.shift } }
+  bm.report('fc:pop')    { N.times { fc_pq.pop } }
+end