d_heap 0.2.1 → 0.6.0

data/Rakefile

@@ -1,14 +1,20 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
 require "rake/extensiontask"
 
-task :build => :compile
+task build: :compile
 
 Rake::ExtensionTask.new("d_heap") do |ext|
   ext.lib_dir = "lib/d_heap"
 end
 
-task :default => [:clobber, :compile, :spec]
+task default: %i[clobber compile spec rubocop]

data/benchmarks/perf.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "perf"
+
+system("#{RbConfig.ruby} bin/rake compile", err: :out, exception: true)
+require "d_heap/benchmarks"
+include DHeap::Benchmarks # rubocop:disable Style/MixinUsage
+fill_random_vals
+
+n = ENV.fetch("BENCH_N", 5_000_000).to_i
+# interval = ENV.fetch("PROF_INTERVAL", 100).to_i # measured in μs
+
+i = 0
+
+q = initq RbHeap
+n.times { q << n }
+q.clear
+
+Perf.record do
+  while i < n
+    q << random_val
+    i += 1
+  end
+  while 0 < i # rubocop:disable Style/NumericPredicate
+    q.pop
+    i -= 1
+  end
+end

data/benchmarks/push_n.yml

@@ -0,0 +1,35 @@
+---
+prelude: |
+  system("#{RbConfig.ruby} bin/rake compile", err: :out, exception: true)
+  require "d_heap/benchmarks"
+  include DHeap::Benchmarks
+  fill_random_vals
+
+  N = ENV.fetch("BENCH_N", 1000).to_i
+
+benchmark:
+  - script: &script |
+       if __bmdv_i % N == 0
+         q.clear
+       end
+
+       q << random_val
+    name:    "push N (findmin)"
+    prelude: "q = initq FindMin"
+    loop_count: 24000000
+  - script: *script
+    name:    "push N (bsearch)"
+    prelude: "q = initq BSearch"
+    loop_count:  2300000
+  - script: *script
+    name:    "push N (rb_heap)"
+    prelude: "q = initq RbHeap"
+    loop_count:  9800000
+  - script: *script
+    name:    "push N (c++ stl)"
+    prelude: "q = initq CppSTL"
+    loop_count: 18700000
+  - script: *script
+    name:    "push N (c_dheap)"
+    prelude: "q = initq DHeap"
+    loop_count: 25100000

data/benchmarks/push_n_pop_n.yml

@@ -0,0 +1,52 @@
+---
+prelude: |
+  system("#{RbConfig.ruby} bin/rake compile", err: :out, exception: true)
+  require "d_heap/benchmarks"
+  include DHeap::Benchmarks
+  fill_random_vals
+
+  N = ENV.fetch("BENCH_N", 1000).to_i
+  N2 = N * 2
+
+  i = j = 0
+
+benchmark:
+  - script: &script |
+      if i < N
+        q.clear if __bmdv_i == 0
+        q << random_val
+        i += 1
+
+      elsif j < N
+        q.pop
+        j += 1
+
+      elsif q.empty?
+        i = 1
+        j = 0
+        q.clear
+        q << random_val
+
+      else
+        raise "q not empty!"
+      end
+
+    name:    "push N + pop N (findmin)"
+    prelude: "q = initq FindMin"
+    loop_count:   200000
+  - script: *script
+    name:    "push N + pop N (bsearch)"
+    prelude: "q = initq BSearch"
+    loop_count:  4000000
+  - script: *script
+    name:    "push N + pop N (rb_heap)"
+    prelude: "q = initq RbHeap"
+    loop_count:  4000000
+  - script: *script
+    name:    "push N + pop N (c++ stl)"
+    prelude: "q = initq CppSTL"
+    loop_count: 16000000
+  - script: *script
+    name:    "push N + pop N (c_dheap)"
+    prelude: "q = initq DHeap"
+    loop_count: 16000000

data/benchmarks/push_pop.yml

@@ -0,0 +1,32 @@
+---
+prelude: |
+  system("#{RbConfig.ruby} bin/rake compile", err: :out, exception: true)
+  require "d_heap/benchmarks"
+  include DHeap::Benchmarks
+  fill_random_vals
+
+  n = ENV.fetch("BENCH_N", 1000).to_i
+
+benchmark:
+  - script: &script |
+       q << random_val
+       q.pop
+    name:    "push + pop (findmin)"
+    prelude: "q = FindMin.new(n) { random_val }"
+    loop_count:   250000
+  - script: *script
+    name:    "push + pop (bsearch)"
+    prelude: "q = BSearch.new(n) { random_val }"
+    loop_count:  5000000
+  - script: *script
+    name:    "push + pop (rb_heap)"
+    prelude: "q = RbHeap.new(n) { random_val }"
+    loop_count:  2000000
+  - script: *script
+    name:    "push + pop (c++ stl)"
+    prelude: "q = initq CppSTL, n"
+    loop_count: 13000000
+  - script: *script
+    name:    "push + pop (c_dheap)"
+    prelude: "q = initq DHeap, n"
+    loop_count: 20000000

data/benchmarks/stackprof.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "stackprof"
+
+system("#{RbConfig.ruby} bin/rake compile", err: :out, exception: true)
+require "d_heap/benchmarks"
+include DHeap::Benchmarks # rubocop:disable Style/MixinUsage
+fill_random_vals
+
+n = ENV.fetch("BENCH_N", 5_000_000).to_i
+interval = ENV.fetch("PROF_INTERVAL", 100).to_i # measured in μs
+
+i = 0
+
+q = initq RbHeap
+n.times { q << n }
+q.clear
+
+StackProf.run(mode: :cpu, out: "stackprof-cpu-push.dump", interval: interval) do
+  while i < n
+    q << random_val
+    i += 1
+  end
+end
+StackProf.run(mode: :cpu, out: "stackprof-cpu-pop.dump", interval: interval) do
+  while 0 < i # rubocop:disable Style/NumericPredicate
+    q.pop
+    i -= 1
+  end
+end

data/bin/bench_charts

@@ -0,0 +1,13 @@
+#!/bin/bash
+set -eu
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" > /dev/null; pwd -P)
+PROJECT_DIR=$(cd "$SCRIPT_DIR" > /dev/null; cd .. > /dev/null; pwd -P)
+cd "$PROJECT_DIR"
+
+opts=( --bundle -e 'N 100000;N 10000;N 1000;N 100;N 10' -o gruff )
+
+for bm in push_n push_n_pop_n push_pop; do
+  bin/benchmark-driver "${opts[@]}" "benchmarks/${bm}.yml"
+  mv graph.png "images/${bm}.png"
+done
+

data/bin/bench_n

@@ -0,0 +1,7 @@
+#!/bin/sh
+set -eu
+
+export BENCH_N="$1"
+shift
+
+exec ruby "$@"

data/bin/benchmark-driver

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'benchmark-driver' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("benchmark_driver", "benchmark-driver")

data/bin/benchmarks

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "rubygems"
+require "bundler/setup"
+
+require "d_heap/benchmarks/benchmarker"
+DHeap::Benchmarks::Benchmarker.new.call

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "d_heap"

data/bin/profile

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "rubygems"
+require "bundler/setup"
+
+require "d_heap/benchmarks/profiler"
+DHeap::Benchmarks::Profiler.new.call

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/d_heap.gemspec

@@ -1,4 +1,6 @@
-require_relative 'lib/d_heap/version'
+# frozen_string_literal: true
+
+require_relative "lib/d_heap/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "d_heap"
@@ -6,14 +8,14 @@ Gem::Specification.new do |spec|
   spec.authors       = ["nicholas a. evans"]
   spec.email         = ["nicholas.evans@gmail.com"]
 
-  spec.summary       = %q{A d-ary heap implementation, for priority queues}
+  spec.summary       = "A d-ary heap implementation, for priority queues"
   spec.description   = <<~DESC
     A C extension implementation of a d-ary heap data structure, suitable for
     use in e.g. priority queues or Djikstra's algorithm.
   DESC
   spec.homepage      = "https://github.com/nevans/#{spec.name}"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -21,11 +23,14 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
+  spec.files = Dir.chdir(File.expand_path(__dir__)) {
+    `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
+  }
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.extensions    = ["ext/d_heap/extconf.rb"]
+
+  spec.add_development_dependency "benchmark_driver"
+  spec.add_development_dependency "ruby-prof"
 end

data/docs/benchmarks-2.txt

@@ -0,0 +1,75 @@
+Warming up --------------------------------------
+push + pop (findmin)             136.044 i/s -     140.000 times in 1.029078s (7.35ms/i)
+push + pop (bsearch)              5.700k i/s -      5.984k times in 1.049902s (175.45μs/i)
+push + pop (rb_heap)            466.447k i/s -    496.977k times in 1.065453s (2.14μs/i)
+push + pop (c++ stl)              3.023M i/s -      3.038M times in 1.004830s (330.81ns/i, 794clocks/i)
+push + pop (c_dheap)              3.579M i/s -      3.620M times in 1.011429s (279.40ns/i, 785clocks/i)
+Calculating -------------------------------------
+                     bin/bench_n 1000000  bin/bench_n 10000  bin/bench_n 25000  bin/bench_n 50000  bin/bench_n 100000  bin/bench_n 250000  bin/bench_n 500000  bin/bench_n 10000000  bin/bench_n 2500000  bin/bench_n 5000000
+push + pop (findmin)             136.690            11.014k             4.426k             2.178k              1.084k             408.671             215.680                13.169               52.037               26.307 i/s -     408.000 times in 2.984861s 0.037045s 0.092186s 0.187334s 0.376306s 0.998359s 1.891687s 30.981982s 7.840594s 15.509132s
+push + pop (bsearch)              5.639k           786.334k           364.964k           200.521k             88.607k             34.530k             17.965k               288.811               1.302k              592.009 i/s -     17.098k times in 3.032244s 0.021744s 0.046848s 0.085268s 0.192965s 0.495157s 0.951721s 59.201408s 13.131805s 28.881310s
+push + pop (rb_heap)            513.523k           736.618k           670.187k           618.157k            579.251k            572.795k            543.648k              423.119k             460.849k             445.235k i/s -      1.399M times in 2.724978s 1.899681s 2.087985s 2.263730s 2.415776s 2.443003s 2.573980s 3.307202s 3.036440s 3.142928s
+push + pop (c++ stl)              3.396M             4.902M             4.794M             4.532M              4.316M              4.204M              3.903M                2.022M               2.659M               2.347M i/s -      9.069M times in 2.670712s 1.850114s 1.891786s 2.001185s 2.101354s 2.157093s 2.323676s 4.484351s 3.410224s 3.864573s
+push + pop (c_dheap)              4.403M             7.311M             6.407M             6.738M              6.254M              5.918M              5.126M                2.138M               3.304M               2.665M i/s -     10.737M times in 2.438365s 1.468580s 1.675785s 1.593589s 1.716764s 1.814447s 2.094553s 5.022305s 3.249709s 4.029170s
+
+Comparison:
+             push + pop (findmin)
+   bin/bench_n 10000:     11013.7 i/s
+   bin/bench_n 25000:      4425.8 i/s - 2.49x  slower
+   bin/bench_n 50000:      2177.9 i/s - 5.06x  slower
+  bin/bench_n 100000:      1084.2 i/s - 10.16x  slower
+  bin/bench_n 250000:       408.7 i/s - 26.95x  slower
+  bin/bench_n 500000:       215.7 i/s - 51.06x  slower
+ bin/bench_n 1000000:       136.7 i/s - 80.57x  slower
+ bin/bench_n 2500000:        52.0 i/s - 211.65x  slower
+ bin/bench_n 5000000:        26.3 i/s - 418.66x  slower
+bin/bench_n 10000000:        13.2 i/s - 836.34x  slower
+
+             push + pop (bsearch)
+   bin/bench_n 10000:    786334.2 i/s
+   bin/bench_n 25000:    364963.8 i/s - 2.15x  slower
+   bin/bench_n 50000:    200520.6 i/s - 3.92x  slower
+  bin/bench_n 100000:     88607.0 i/s - 8.87x  slower
+  bin/bench_n 250000:     34530.5 i/s - 22.77x  slower
+  bin/bench_n 500000:     17965.4 i/s - 43.77x  slower
+ bin/bench_n 1000000:      5638.7 i/s - 139.45x  slower
+ bin/bench_n 2500000:      1302.0 i/s - 603.93x  slower
+ bin/bench_n 5000000:       592.0 i/s - 1328.25x  slower
+bin/bench_n 10000000:       288.8 i/s - 2722.66x  slower
+
+             push + pop (rb_heap)
+   bin/bench_n 10000:    736618.2 i/s
+   bin/bench_n 25000:    670186.8 i/s - 1.10x  slower
+   bin/bench_n 50000:    618156.7 i/s - 1.19x  slower
+  bin/bench_n 100000:    579250.7 i/s - 1.27x  slower
+  bin/bench_n 250000:    572795.0 i/s - 1.29x  slower
+  bin/bench_n 500000:    543648.3 i/s - 1.35x  slower
+ bin/bench_n 1000000:    513523.4 i/s - 1.43x  slower
+ bin/bench_n 2500000:    460848.9 i/s - 1.60x  slower
+ bin/bench_n 5000000:    445234.5 i/s - 1.65x  slower
+bin/bench_n 10000000:    423119.0 i/s - 1.74x  slower
+
+             push + pop (c++ stl)
+   bin/bench_n 10000:   4901711.5 i/s
+   bin/bench_n 25000:   4793735.8 i/s - 1.02x  slower
+   bin/bench_n 50000:   4531675.9 i/s - 1.08x  slower
+  bin/bench_n 100000:   4315657.8 i/s - 1.14x  slower
+  bin/bench_n 250000:   4204141.1 i/s - 1.17x  slower
+  bin/bench_n 500000:   3902748.9 i/s - 1.26x  slower
+ bin/bench_n 1000000:   3395620.2 i/s - 1.44x  slower
+ bin/bench_n 2500000:   2659274.8 i/s - 1.84x  slower
+ bin/bench_n 5000000:   2346630.0 i/s - 2.09x  slower
+bin/bench_n 10000000:   2022304.5 i/s - 2.42x  slower
+
+             push + pop (c_dheap)
+   bin/bench_n 10000:   7311366.6 i/s
+   bin/bench_n 50000:   6737824.5 i/s - 1.09x  slower
+   bin/bench_n 25000:   6407340.6 i/s - 1.14x  slower
+  bin/bench_n 100000:   6254396.3 i/s - 1.17x  slower
+  bin/bench_n 250000:   5917684.5 i/s - 1.24x  slower
+  bin/bench_n 500000:   5126307.6 i/s - 1.43x  slower
+ bin/bench_n 1000000:   4403494.1 i/s - 1.66x  slower
+ bin/bench_n 2500000:   3304088.2 i/s - 2.21x  slower
+ bin/bench_n 5000000:   2664897.7 i/s - 2.74x  slower
+bin/bench_n 10000000:   2137927.6 i/s - 3.42x  slower
+

data/docs/benchmarks-mem.txt

@@ -0,0 +1,39 @@
+Calculating -------------------------------------
+                     bin/bench_n 10000  bin/bench_n 100000  bin/bench_n 1000000  bin/bench_n 10000000
+push + pop (findmin)           40.280M             42.236M              58.956M              204.536M bytes -       1.000 times
+push + pop (bsearch)           40.212M             42.036M              59.012M              204.536M bytes -       1.000 times
+push + pop (rb_heap)           40.264M             41.780M              58.940M              204.364M bytes -       1.000 times
+push + pop (c++ stl)           40.416M             42.268M              56.624M              302.152M bytes -       1.000 times
+push + pop (c_dheap)           40.848M             43.968M              72.888M              568.828M bytes -       1.000 times
+
+Comparison:
+             push + pop (findmin)
+   bin/bench_n 10000:  40280000.0 bytes
+  bin/bench_n 100000:  42236000.0 bytes - 1.05x  larger
+ bin/bench_n 1000000:  58956000.0 bytes - 1.46x  larger
+bin/bench_n 10000000: 204536000.0 bytes - 5.08x  larger
+
+             push + pop (bsearch)
+   bin/bench_n 10000:  40212000.0 bytes
+  bin/bench_n 100000:  42036000.0 bytes - 1.05x  larger
+ bin/bench_n 1000000:  59012000.0 bytes - 1.47x  larger
+bin/bench_n 10000000: 204536000.0 bytes - 5.09x  larger
+
+             push + pop (rb_heap)
+   bin/bench_n 10000:  40264000.0 bytes
+  bin/bench_n 100000:  41780000.0 bytes - 1.04x  larger
+ bin/bench_n 1000000:  58940000.0 bytes - 1.46x  larger
+bin/bench_n 10000000: 204364000.0 bytes - 5.08x  larger
+
+             push + pop (c++ stl)
+   bin/bench_n 10000:  40416000.0 bytes
+  bin/bench_n 100000:  42268000.0 bytes - 1.05x  larger
+ bin/bench_n 1000000:  56624000.0 bytes - 1.40x  larger
+bin/bench_n 10000000: 302152000.0 bytes - 7.48x  larger
+
+             push + pop (c_dheap)
+   bin/bench_n 10000:  40848000.0 bytes
+  bin/bench_n 100000:  43968000.0 bytes - 1.08x  larger
+ bin/bench_n 1000000:  72888000.0 bytes - 1.78x  larger
+bin/bench_n 10000000: 568828000.0 bytes - 13.93x  larger
+