fast_priority_queue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b07c36a55c10c48198b7822e32d013063683e20
+  data.tar.gz: f0e1aa78ced4e6e615ea87609969d153b3550203
+SHA512:
+  metadata.gz: e53b4d3a10fe20394f5cc50fd5b569b1fa06ad283b2bc89fbf7c4a40b2a5a23ab44952d1220d77026e13020402f980149ee29a708deee0e72812acc7fdf508f6
+  data.tar.gz: c9f3dd45f5b3ea6ebdb16435290cd271d5b0d1de7532b672857a148ee3d0340cb28a6b83ba6e5a8751dfc57e581452b57b1dff1efd10bdc65066d5bb63bdf2fa

data/.gitignore

@@ -0,0 +1,15 @@
+# ruby
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rust
+target/
+Cargo.lock
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2

data/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "fast_priority_queue"
+version = "0.1.0"
+authors = ["Simon Soriano <simon0191@gmail.com>"]
+
+[dependencies]
+ruru = "0.8.1"
+
+[lib]
+crate-type = ["dylib"]

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fast_priority_queue.gemspec
+gemspec

data/README.md

@@ -0,0 +1,92 @@
+# FastPriorityQueue
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fast_priority_queue`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fast_priority_queue'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fast_priority_queue
+
+## Usage
+
+```
+fpq = FastPriorityQueue.new
+# or use a custom comparator function
+fpq = FastPriorityQueue.new { |a,b| a<=>b }
+# add elements to the queue
+fpq.add 5
+fpq.add 4
+fpq.add 3
+fpq.add 2
+fpq.add 1
+# see what's in the top of the queue
+fpq.top # => 1
+# take the top element
+fpq.pop # => 1
+fpq.pop # => 2
+# see how many elements are in the queue
+fpq.length # => 3
+```
+
+## Benchmarks
+FastPriorityQueue is super fast. Here are some benchmarks against [PQueue](https://github.com/rubyworks/pqueue):
+
+*(the smallest the number, the better)*
+
+Benchmark of add and pop with fixnums:
+```
+Rehearsal -----------------------------------------------
+Fast#add      0.830000   0.010000   0.840000 (  0.854182)
+PQueue#push  22.610000  40.740000  63.350000 ( 67.128790)
+Fast#pop      1.280000   0.010000   1.290000 (  1.331896)
+PQueue#pop    0.010000   0.000000   0.010000 (  0.012800)
+------------------------------------- total: 65.490000sec
+
+                  user     system      total        real
+Fast#add      0.860000   0.010000   0.870000 (  0.896107)
+PQueue#push  22.570000  41.690000  64.260000 ( 68.815510)
+Fast#pop      1.250000   0.010000   1.260000 (  1.275417)
+PQueue#pop    0.010000   0.000000   0.010000 (  0.011788)
+```
+
+Benchmark of add and pop with objects:
+```
+Rehearsal -----------------------------------------------
+Fast#add      0.380000   0.010000   0.390000 (  0.393005)
+PQueue#push  36.730000  53.990000  90.720000 ( 96.215730)
+Fast#pop      1.850000   0.020000   1.870000 (  1.911544)
+PQueue#pop    0.010000   0.000000   0.010000 (  0.012731)
+------------------------------------- total: 92.990000sec
+
+                  user     system      total        real
+Fast#add      0.410000   0.010000   0.420000 (  0.423021)
+PQueue#push  37.190000  55.130000  92.320000 (100.046236)
+Fast#pop      1.970000   0.010000   1.980000 (  2.031743)
+PQueue#pop    0.020000   0.000000   0.020000 (  0.014687)
+```
+I had to use `Array#pop` from ruby because there's no `Array.pop` native extension by now.
+That's why `#pop` benchmark is a little bit worse than PQueue.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fast_priority_queue.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'thermite/tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+Thermite::Tasks.new
+
+desc 'Run Rust & Ruby testsuites'
+task test: ['thermite:build', 'thermite:test', :spec]
+
+task :default => :test

data/benchmark.rb

@@ -0,0 +1,46 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+require 'benchmark'
+require 'fast_priority_queue'
+require 'pqueue'
+
+t = 100_000
+nums = (0..t).to_a
+Benchmark.bmbm do |x|
+  fpq = FastPriorityQueue.new { |a,b| b <=> a  }
+  pq = PQueue.new { |a,b| a > b }
+
+
+  x.report('Fast#add') { nums.each { |x| fpq.add x } }
+  x.report('PQueue#push') { nums.each { |x| pq.push x } }
+
+  x.report("Fast#pop")  { fpq.pop until fpq.empty? }
+  x.report("PQueue#pop") { pq.pop until pq.empty? }
+end
+
+class Patient < Struct.new(:name,:age,:severity)
+  def <=>(other)
+    if self.severity != other.severity
+      other.severity <=> self.severity
+    elsif  self.age != other.age
+      other.age <=> self.age
+    else
+      self.name <=> other.name
+    end
+  end
+end
+
+t = 100_000
+r = Random.new 182544861145423751987946792099462507225
+patients = t.times.map { |i| Patient.new("patient - #{i}",r.rand(80),r.rand(3)) }
+Benchmark.bmbm do |x|
+  fpq = FastPriorityQueue.new
+  pq = PQueue.new { |a,b| (a <=> b) > 0}
+
+
+  x.report('Fast#add') { patients.each { |x| fpq.add x } }
+  x.report('PQueue#push') { patients.each { |x| pq.push x } }
+
+  x.report("Fast#pop")  { fpq.pop until fpq.empty? }
+  x.report("PQueue#pop") { pq.pop until pq.empty? }
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fast_priority_queue"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/Rakefile

@@ -0,0 +1,5 @@
+require 'thermite/tasks'
+
+project_dir = File.dirname(File.dirname(__FILE__))
+Thermite::Tasks.new(cargo_project_path: project_dir, ruby_project_path: project_dir)
+task default: %w(thermite:build)

data/fast_priority_queue.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fast_priority_queue/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fast_priority_queue"
+  spec.version       = FastPriorityQueue::VERSION
+  spec.authors       = ["Simon Soriano"]
+  spec.email         = ["simon0191@gmail.com"]
+
+  spec.summary       = "Fast priority queue using Rust"
+  spec.description   = "Fast priority queue using Rust"
+  spec.homepage      = "https://github.com/simon0191/fast_priority_queue"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #  if spec.respond_to?(:metadata)
+  #    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #  else
+  #    raise "RubyGems 2.0 or newer is required to protect against " \
+  #      "public gem pushes."
+  #  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pqueue", "~> 2.1"
+
+  spec.extensions << 'ext/Rakefile'
+  spec.add_runtime_dependency 'thermite', '~> 0'
+end

data/lib/fast_priority_queue.rb

@@ -0,0 +1,46 @@
+require 'fast_priority_queue/version'
+require 'thermite/fiddle'
+
+class FastPriorityQueue
+
+  attr_reader :cmp
+
+  def initialize
+    @array = [nil]
+    if block_given?
+      @cmp = ->(a,b) { yield a,b }
+    else
+      @cmp = ->(a,b) { a <=> b }
+    end
+  end
+
+  def length
+    @array.length - 1
+  end
+
+  def add(x)
+    _add(@array,@cmp,x)
+  end
+
+  def top
+    @array[1]
+  end
+
+  def pop
+    _pop(@array,@cmp)
+  end
+
+  def empty?
+    length == 0
+  end
+
+  def _pop_last_element
+    #TODO: find a way to do this in Rust
+    @array.pop
+  end
+end
+
+toplevel_dir = File.dirname(File.dirname(__FILE__))
+Thermite::Fiddle.load_module('init_fast_priority_queue',
+                             cargo_project_path: toplevel_dir,
+                             ruby_project_path: toplevel_dir)

data/lib/fast_priority_queue/version.rb

@@ -0,0 +1,3 @@
+class FastPriorityQueue
+  VERSION = "0.1.0"
+end

data/src/lib.rs

@@ -0,0 +1,101 @@
+#[macro_use]
+extern crate ruru;
+
+use ruru::{Class,Object,RString,Fixnum,AnyObject,Array,Proc,NilClass};
+class!(FastPriorityQueue);
+
+methods!(
+    FastPriorityQueue,
+    _itself,
+
+    fn hello_world() -> RString {
+        RString::new("hello world")
+    }
+
+    fn _add(arr: Array, cmp: Proc, x: AnyObject) -> NilClass {
+        let mut arr = arr.unwrap();
+        let x = x.unwrap();
+        let cmp = cmp.unwrap();
+        arr.push(x);
+        // bubble_up
+        let mut curr_index = (arr.length() - 1) as i64;
+        loop {
+            if curr_index <= 1 {
+                return NilClass::new();
+            }
+            let parent_index = curr_index/2;
+            let curr = arr.at(curr_index);
+            let parent = arr.at(parent_index);
+            let cmp_result = cmp.call(vec![ arr.at(curr_index) , arr.at(parent_index) ])
+                                    .try_convert_to::<Fixnum>()
+                                    .unwrap()
+                                    .to_i64();
+
+            if cmp_result > 0 {
+                return NilClass::new();
+            }
+            // exchange
+            arr.store(curr_index,parent);
+            arr.store(parent_index,curr);
+
+            curr_index = parent_index;
+        }
+    }
+
+    fn _pop(arr: Array, cmp: Proc) -> AnyObject {
+        let mut arr = arr.unwrap();
+        let cmp = cmp.unwrap();
+        let mut arr_len = arr.length() as i64;
+
+        if arr_len <= 1 {
+            return NilClass::new().to_any_object()
+        } else if arr_len == 2 {
+            return _itself.send("_pop_last_element",vec![]);
+        }
+
+        let top_val = arr.at(1);
+        let last_val = arr.at(arr_len - 1);
+        arr.store(1,last_val);
+        _itself.send("_pop_last_element",vec![]);
+        arr_len -= 1;
+
+        let mut curr_index: i64 = 1;
+        while curr_index * 2 < arr_len {
+            let mut child_index = curr_index * 2;
+
+            let not_the_last_element = child_index + 1 < arr_len;
+            if not_the_last_element {
+                let cmp_result = cmp.call(vec![ arr.at(child_index) , arr.at(child_index + 1) ])
+                                        .try_convert_to::<Fixnum>()
+                                        .unwrap()
+                                        .to_i64();
+
+                if cmp_result > 0 {
+                    child_index += 1;
+                }
+            }
+            let cmp_result = cmp.call(vec![ arr.at(curr_index) , arr.at(child_index) ])
+                                    .try_convert_to::<Fixnum>()
+                                    .unwrap()
+                                    .to_i64();
+            if cmp_result <= 0 {
+                return top_val;
+            }
+            let curr = arr.at(curr_index);
+            let child = arr.at(child_index);
+            arr.store(curr_index,child);
+            arr.store(child_index,curr);
+
+            curr_index = child_index;
+        }
+        return top_val;
+    }
+);
+
+#[no_mangle]
+pub extern fn init_fast_priority_queue() {
+    Class::from_existing("FastPriorityQueue").define(|itself| {
+        itself.def("_add", _add);
+        itself.def("_pop", _pop);
+    });
+}

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: fast_priority_queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Soriano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pqueue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: thermite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fast priority queue using Rust
+email:
+- simon0191@gmail.com
+executables: []
+extensions:
+- ext/Rakefile
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Cargo.toml
+- Gemfile
+- README.md
+- Rakefile
+- benchmark.rb
+- bin/console
+- bin/setup
+- ext/Rakefile
+- fast_priority_queue.gemspec
+- lib/fast_priority_queue.rb
+- lib/fast_priority_queue/version.rb
+- src/lib.rs
+homepage: https://github.com/simon0191/fast_priority_queue
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Fast priority queue using Rust
+test_files: []