d_heap 0.6.1 → 0.7.0

data/ext/d_heap/extconf.rb

@@ -8,8 +8,34 @@ require "mkmf"
 # $CFLAGS << " -g -ginline-points "
 # $CFLAGS << " -fno-omit-frame-pointer "
 
-if enable_config("debug")
-  CONFIG["warnflags"] << " -Werror -Wpedantic "
+# Use `rake compile -- --enable-debug`
+debug_mode = enable_config("debug", ENV["EXTCONF_DEBUG"] == "1")
+
+# Use `rake compile -- --enable-development`
+devel_mode = enable_config("development") || debug_mode
+
+if debug_mode
+  $stderr.puts "Building in debug mode." # rubocop:disable Style/StderrPuts
+  CONFIG["warnflags"] \
+    << " -ggdb" \
+    << " -DDEBUG"
+end
+
+if devel_mode
+  $stderr.puts "Building in development mode." # rubocop:disable Style/StderrPuts
+  CONFIG["warnflags"] \
+    << " -Wall " \
+    << " -Wpedantic" \
+  # There are warnings on MacOS that are annoying to debug (I don't have a Mac).
+  unless RbConfig::CONFIG["target_os"] =~ /darwin/
+    CONFIG["warnflags"] << " -Werror"
+  end
+end
+
+# Use `rake compile -- --enable-heapmap`
+if enable_config("heapmap", true)
+  $stderr.puts "Building with DHeap::Map support." # rubocop:disable Style/StderrPuts
+  $defs.push "-DDHEAP_MAP"
 end
 
 have_func "rb_gc_mark_movable" # since ruby-2.7
@@ -17,6 +43,11 @@ have_func "rb_gc_mark_movable" # since ruby-2.7
 check_sizeof("long")
 check_sizeof("unsigned long long")
 check_sizeof("long double")
-have_macro("LDBL_MANT_DIG", "float.h")
+check_sizeof("double")
+
+unless have_macro("LDBL_MANT_DIG", "float.h")
+  raise NotImplementedError, "Missing LDBL_MANT_DIG."
+end
 
+create_header
 create_makefile("d_heap/d_heap")

data/lib/d_heap.rb

@@ -83,7 +83,7 @@ class DHeap
   #          If all pushes are popped, the default is probably best.
   # @param capacity [Integer] initial capacity of the heap.
   def initialize(d: DEFAULT_D, capacity: DEFAULT_CAPA) # rubocop:disable Naming/MethodParameterName
-    __init_without_kw__(d, capacity)
+    __init_without_kw__(d, capacity, false)
   end
 
   # Consumes the heap by popping each minumum value until it is empty.
@@ -108,4 +108,28 @@ class DHeap
     nil
   end
 
+  if defined?(Map)
+
+    # Unlike {DHeap}, an object can only be added into a {DHeap::Map} once.  Any
+    # subsequent addition simply rescores the already existing member.  Objects
+    # are identified by their {#hash} value, just like with Hash.
+    class Map
+      alias score   :[]
+      alias rescore :[]=
+      alias update  :[]=
+
+      # Initialize a _d_-ary min-heap which can map objects to scores.
+      #
+      # @param d [Integer] Number of children for each parent node.
+      #          Higher values generally speed up push but slow down pop.
+      #          If all pushes are popped, the default is probably best.
+      # @param capacity [Integer] initial capacity of the heap.
+      def initialize(d: DEFAULT_D, capacity: DEFAULT_CAPA) # rubocop:disable Naming/MethodParameterName
+        __init_without_kw__(d, capacity, true)
+      end
+
+    end
+
+  end
+
 end

data/lib/d_heap/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 class DHeap
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: d_heap
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - nicholas a. evans
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-24 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark_driver
@@ -48,53 +48,29 @@ extensions:
 - ext/d_heap/extconf.rb
 extra_rdoc_files: []
 files:
+- ".clang-format"
 - ".github/workflows/main.yml"
 - ".gitignore"
-- ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
+- D
 - LICENSE.txt
-- N
 - README.md
-- Rakefile
-- benchmarks/perf.rb
-- benchmarks/push_n.yml
-- benchmarks/push_n_pop_n.yml
-- benchmarks/push_pop.yml
-- benchmarks/stackprof.rb
-- bin/bench_charts
-- bin/bench_n
-- bin/benchmark-driver
-- bin/benchmarks
-- bin/console
-- bin/profile
-- bin/rake
-- bin/rspec
-- bin/rubocop
-- bin/setup
 - d_heap.gemspec
 - docs/benchmarks-2.txt
 - docs/benchmarks-mem.txt
 - docs/benchmarks.txt
 - docs/profile.txt
+- ext/d_heap/.rubocop.yml
 - ext/d_heap/d_heap.c
 - ext/d_heap/extconf.rb
 - images/push_n.png
 - images/push_n_pop_n.png
 - images/push_pop.png
 - images/wikipedia-min-heap.png
-- lib/benchmark_driver/runner/ips_zero_fail.rb
 - lib/d_heap.rb
-- lib/d_heap/benchmarks.rb
-- lib/d_heap/benchmarks/benchmarker.rb
-- lib/d_heap/benchmarks/implementations.rb
-- lib/d_heap/benchmarks/profiler.rb
-- lib/d_heap/benchmarks/rspec_matchers.rb
 - lib/d_heap/version.rb
 homepage: https://github.com/nevans/d_heap
 licenses:
@@ -121,5 +97,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: A d-ary heap implementation, for priority queues
+summary: very fast min-heap priority queue
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.2
-before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in d_heap.gemspec
-gemspec
-
-gem "pry"
-gem "rake", "~> 13.0"
-gem "rake-compiler"
-gem "rspec", "~> 3.10"
-gem "rubocop", "~> 1.0"
-
-install_if -> { RUBY_PLATFORM !~ /darwin/ } do
-  gem "benchmark_driver-output-gruff"
-end
-
-gem "perf"
-gem "priority_queue_cxx"
-gem "stackprof"

data/Gemfile.lock

@@ -1,83 +0,0 @@
-PATH
-  remote: .
-  specs:
-    d_heap (0.6.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.1)
-    benchmark_driver (0.15.16)
-    benchmark_driver-output-gruff (0.3.1)
-      benchmark_driver (>= 0.12.0)
-      gruff
-    coderay (1.1.3)
-    diff-lcs (1.4.4)
-    gruff (0.12.1)
-      histogram
-      rmagick
-    histogram (0.2.4.1)
-    method_source (1.0.0)
-    parallel (1.19.2)
-    parser (2.7.2.0)
-      ast (~> 2.4.1)
-    perf (0.1.2)
-    priority_queue_cxx (0.3.4)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    rake-compiler (1.1.1)
-      rake
-    regexp_parser (1.8.2)
-    rexml (3.2.3)
-    rmagick (4.1.2)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (1.2.0)
-      parallel (~> 1.10)
-      parser (>= 2.7.1.5)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
-      rexml
-      rubocop-ast (>= 1.0.1)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.1)
-      parser (>= 2.7.1.5)
-    ruby-prof (1.4.2)
-    ruby-progressbar (1.10.1)
-    stackprof (0.2.16)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  benchmark_driver
-  benchmark_driver-output-gruff
-  d_heap!
-  perf
-  priority_queue_cxx
-  pry
-  rake (~> 13.0)
-  rake-compiler
-  rspec (~> 3.10)
-  rubocop (~> 1.0)
-  ruby-prof
-  stackprof
-
-BUNDLED WITH
-   2.2.3

data/Rakefile

@@ -1,20 +0,0 @@
-# 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
-
-Rake::ExtensionTask.new("d_heap") do |ext|
-  ext.lib_dir = "lib/d_heap"
-end
-
-task default: %i[clobber compile spec rubocop]

data/benchmarks/perf.rb

@@ -1,29 +0,0 @@
-#!/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

@@ -1,35 +0,0 @@
----
-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

@@ -1,52 +0,0 @@
----
-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