d_heap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 585cdfa768be7f778b92fa500d952f4207b98ea46378d7289f2ff936bc1f06f0
+  data.tar.gz: d306234243d78a9dfd0ef9beb06e569ddd9915f2c733ebd9109953fc84584e11
+SHA512:
+  metadata.gz: dd379eecd4bc218b62729d2fdd39773ffbf1e248fb83eeffda910f439644ad5ed8588cf1e8fd4de807ca074f3165e073300d584eb64fae2c54aeed5206374cfc
+  data.tar.gz: 7fac571f7d14bb2a7b6d2773fe531a803474587a83508710c4898c15649117558aaa399151d5be3dd49f07afbb06ffd38fe55161e07e483cee729c4f1efdbb20

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nicholas.evans@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in d_heap.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rake-compiler"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    d_heap (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rake-compiler (1.1.1)
+      rake
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  d_heap!
+  rake (~> 12.0)
+  rake-compiler
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 nicholas a. evans
+
+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.

data/README.md

@@ -0,0 +1,141 @@
+# DHeap
+
+A fast _d_-ary heap implementation for ruby, useful in priority queues and graph
+algorithms.
+
+The _d_-ary heap data structure is a generalization of the binary heap, in which
+the nodes have _d_ children instead of 2.  This allows for "decrease priority"
+operations to be performed more quickly with the tradeoff of slower delete
+minimum.  Additionally, _d_-ary heaps can have better memory cache behavior than
+binary heaps, allowing them to run more quickly in practice despite slower
+worst-case time complexity.
+
+_TODO:_ In addition to a basic _d_-ary heap class (`DHeap`), this library
+~~includes~~ _will include_ extensions to `Array`, allowing an Array to be
+directly handled as a priority queue.  These extension methods are meant to be
+used similarly to how `#bsearch` and `#bsearch_index` might be used.
+
+_TODO:_ Also included is `DHeap::Set`, which augments the basic heap with an
+internal `Hash`, which maps a set of values to scores.
+loosely inspired by go's timers.  e.g: It lazily sifts its heap after deletion
+and adjustments, to achieve faster average runtime for *add* and *cancel*
+operations.
+
+_TODO:_ Also included is `DHeap::Timers`, which contains some features that are
+loosely inspired by go's timers.  e.g: It lazily sifts its heap after deletion
+and adjustments, to achieve faster average runtime for *add* and *cancel*
+operations.
+
+## Motivation
+
+Ruby's Array class comes with some helpful methods for maintaining a sorted
+array, by combining `#bsearch_index` with `#insert`.  With certain insert/remove
+workloads that can perform very well, but in the worst-case an insert or delete
+can result in O(n), since it may need to memcopy a significant portion of the
+array.  Knowing that priority queues are usually implemented with a heap, and
+that the heap is a relatively simple data structure, I set out to replace my
+`#bsearch_index` and `#insert` code with a one.  I was surprised to find that,
+at least under certain benchmarks, my ruby Heap implementation was tied with or
+slower than inserting into a fully sorted array.  On the one hand, this is a
+testament to ruby's fine-tuned Array implementation.  On the other hand, it
+seemed like a heap implementated in C should easily match the speed of ruby's
+bsearch + insert.
+
+Additionally, I was inspired by reading go's "timer.go" implementation to
+experiment with a 4-ary heap, instead of the traditional binary heap.  In the
+case of timers, new timers are usually scheduled to run after most of the
+existing timers and timers are usually canceled before they have a chance to
+run. While a binary heap holds 50% of its elements in its last layer, 75% of a
+4-ary heap will have no children.  That diminishes the extra comparison
+overhead during sift-down.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'd_heap'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install d_heap
+
+## Usage
+
+The simplest way to use it is simply with `#push` and `#pop`.  Push will 
+
+```ruby
+require "d_heap"
+
+heap = DHeap.new # defaults to a 4-ary heap
+
+# storing [time, task] tuples
+heap << [Time.now + 5*60, Task.new(1)]
+heap << [Time.now +   30, Task.new(2)]
+heap << [Time.now +   60, Task.new(3)]
+heap << [Time.now +    5, Task.new(4)]
+
+# peeking and popping (using last to get the task and ignore the time)
+heap.pop.last # => Task[4]
+heap.pop.last # => Task[2]
+heap.peak.last # => Task[3]
+heap.pop.last # => Task[3]
+heap.pop.last # => Task[1]
+```
+
+Read the `rdoc` for more detailed documentation and examples.
+
+## Benchmarks
+
+_TODO: put benchmarks here._
+
+## Alternative data structures
+
+Depending on what you're doing, maintaining a sorted `Array` using
+`#bsearch_index` and `#insert` might be faster!
+
+If it is important to be able to quickly enumerate the set or find the ranking
+of values in it, then you probably want to use a self-balancing binary search
+tree (e.g. a red-black tree) or a skip-list.
+
+A Hashed Timing Wheel or Heirarchical Timing Wheels (or some variant in that
+family of data structures) can be constructed to have effectively O(1) running
+time in most cases.  However, the implementation for that data structure is much
+more complex than a heap.  If a 4-ary heap is good enough for go's timers,
+it should be suitable for many use cases.
+
+## 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/nevans/d_heap. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [code of
+conduct](https://github.com/nevans/d_heap/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DHeap project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/nevans/d_heap/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "d_heap"
+
+# 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(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' 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("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' 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("rspec-core", "rspec")

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/d_heap.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/d_heap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "d_heap"
+  spec.version       = DHeap::VERSION
+  spec.authors       = ["nicholas a. evans"]
+  spec.email         = ["nicholas.evans@gmail.com"]
+
+  spec.summary       = %q{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.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/Changelog.md"
+
+  # 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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/d_heap/extconf.rb"]
+end

data/ext/d_heap/d_heap.c

@@ -0,0 +1,219 @@
+#include "d_heap.h"
+
+ID id_ivar_a;
+ID id_ivar_d;
+
+#define DHEAP_Check_d_size(d) \
+    if (d < 2) { \
+        rb_raise(rb_eIndexError, "DHeap d=%d is too small", d); \
+    } \
+    if (d > DHEAP_MAX_D) { \
+        rb_raise(rb_eIndexError, "DHeap d=%d is too large", d); \
+    }
+
+#define DHEAP_Check_Sift_Idx(sift_idx, last_idx) \
+    if (sift_idx < 0) { \
+        rb_raise(rb_eIndexError, "sift_idx %ld too small", sift_idx); \
+    } \
+    else if (last_idx < sift_idx) { \
+        rb_raise(rb_eIndexError, "sift_idx %ld too large", sift_idx); \
+    }
+
+#define DHEAP_Load_Sift_Vals(heap_array, dval, idxval) \
+    Check_Type(dval, T_FIXNUM); \
+    int d = FIX2INT(dval); \
+    long sift_idx = NUM2LONG(idxval);
+
+#define DHEAP_Check_Sift_Args(heap_array, d, sift_idx) \
+    DHEAP_Check_d_size(d); \
+    Check_Type(heap_array, T_ARRAY); \
+    long last_idx = RARRAY_LEN(heap_array) - 1; \
+    DHEAP_Check_Sift_Idx(sift_idx, last_idx); \
+    \
+    VALUE sift_val = rb_ary_entry(heap_array, sift_idx);
+
+VALUE
+dheap_ary_sift_up(VALUE heap_array, int d, long sift_idx) {
+    DHEAP_Check_Sift_Args(heap_array, d, sift_idx);
+    // sift it up to where it belongs
+    for (long parent_idx; 0 < sift_idx; sift_idx = parent_idx) {
+        parent_idx = (sift_idx - 1) / d;
+        VALUE parent_val = rb_ary_entry(heap_array, parent_idx);
+
+        // parent is smaller: heap is restored
+        if (CMP_LTE(parent_val, sift_val)) break;
+
+        // parent is larger: swap and continue sifting up
+        rb_ary_store(heap_array, sift_idx, parent_val);
+        rb_ary_store(heap_array, parent_idx, sift_val);
+    }
+    return LONG2NUM(sift_idx);
+}
+
+
+VALUE
+dheap_ary_sift_down(VALUE heap_array, int d, long sift_idx) {
+    DHEAP_Check_Sift_Args(heap_array, d, sift_idx);
+     // iteratively sift it down to where it belongs
+    for (long child_idx; sift_idx < last_idx; sift_idx = child_idx) {
+        // find first child index, and break if we've reached the last layer
+        long child_idx0 = sift_idx * d + 1;
+        child_idx = child_idx0;
+        if (last_idx < child_idx0) break;
+
+        // find the min child (and its child_idx)
+        // requires "d" comparisons. (d - 1 to find min child; + 1 vs sift_val)
+        VALUE child_val = rb_ary_entry(heap_array, child_idx0);
+        for (int i = 1; i < d; i++) {
+            long sibling_idx = child_idx0 + i;
+            if (last_idx < sibling_idx) break;
+
+            VALUE sibling_val = rb_ary_entry(heap_array, sibling_idx);
+
+            if (CMP_LT(sibling_val, child_val)) {
+                child_val = sibling_val;
+                child_idx = sibling_idx;
+            }
+        }
+
+        // child is larger: heap is restored
+        if (CMP_GT(child_val, sift_val)) break;
+
+        // child is smaller: swap and continue sifting down
+        rb_ary_store(heap_array, sift_idx, child_val);
+        rb_ary_store(heap_array, child_idx, sift_val);
+    }
+    return LONG2NUM(sift_idx);
+}
+
+/*
+ * call-seq:
+ *    DHeap.array_sift_up(heap_array, d, sift_idx)
+ *
+ * Treats +heap_array+ as a +d+-ary heap and sifts up from +sift_idx+ to restore
+ * the heap property.
+ *
+ * Time complexity: O(d log n / log d).  If the average up shifted element sorts
+ * into the bottom layer (e.g. new timers), this can avg O(1).
+ *
+ */
+static VALUE
+dheap_sift_up_s(VALUE unused, VALUE heap_array, VALUE dval, VALUE idxval) {
+    DHEAP_Load_Sift_Vals(heap_array, dval, idxval);
+    return dheap_ary_sift_up(heap_array, d, sift_idx);
+}
+
+/*
+ * call-seq:
+ *    DHeap.array_sift_down(heap_array, d, sift_idx)
+ *
+ * Treats +heap_array+ as a +d+-ary heap and sifts down from +sift_idx+ to
+ * restore the heap property.
+ *
+ * Time complexity: O(d log n / log d).  If the average down shifted element
+ * sorts into the bottom layer (e.g. canceled timers), this can avg O(1).
+ *
+ */
+static VALUE
+dheap_sift_down_s(VALUE unused, VALUE heap_array, VALUE dval, VALUE idxval) {
+    DHEAP_Load_Sift_Vals(heap_array, dval, idxval);
+    return dheap_ary_sift_down(heap_array, d, sift_idx);
+}
+
+static VALUE
+dheap_initialize(int argc, VALUE *argv, VALUE self) {
+    rb_check_arity(argc, 0, 1);
+    int d = DHEAP_DEFAULT_D;
+    if (argc) {
+        d = NUM2INT(argv[0]);
+    }
+    DHEAP_Check_d_size(d);
+    rb_ivar_set(self, id_ivar_d, INT2FIX(d));
+    rb_ivar_set(self, id_ivar_a, rb_ary_new());
+    return self;
+}
+
+static inline VALUE dheap_get_a(VALUE dheap) { return rb_ivar_get(dheap, id_ivar_a); }
+static inline VALUE dheap_get_d(VALUE dheap) { return rb_ivar_get(dheap, id_ivar_d); }
+
+static VALUE dheap_a(VALUE dheap) { return dheap_get_a(dheap); }
+static VALUE dheap_d(VALUE dheap) { return dheap_get_d(dheap); }
+
+/*
+ * Push val onto the end of the heap, then sift up to maintain heap property.
+ *
+ * Returns the index of the value's final position.
+ *
+ */
+static VALUE
+dheap_push(VALUE dheap, VALUE val) {
+    VALUE heap_a = dheap_get_a(dheap);
+    VALUE heap_d = dheap_get_d(dheap);
+    rb_ary_push(heap_a, val);
+    long last_idx = RARRAY_LEN(heap_a) - 1;
+    return dheap_sift_up_s(Qnil, heap_a, heap_d, LONG2NUM(last_idx));
+}
+
+/*
+ * Push val onto the end of the heap, then sift up to maintain heap property.
+ *
+ * Time complexity: O(d log n / log d).
+ *
+ * Returns +self+.
+ *
+ */
+static VALUE
+dheap_left_shift(VALUE dheap, VALUE val) {
+    dheap_push(dheap, val);
+    return dheap;
+}
+
+/*
+ * Pops the minimum value from the top of the heap, sifting down to maintain
+ * heap property.
+ *
+ * Time complexity: O(log n / log d).
+ *
+ */
+static VALUE
+dheap_pop(VALUE dheap) {
+    VALUE heap_a = dheap_get_a(dheap);
+    VALUE heap_d = dheap_get_d(dheap);
+    long last_idx = RARRAY_LEN(heap_a) - 1;
+
+    /*
+     * short-circuit empty or nearly empty
+     */
+    if (last_idx <= 0) return rb_ary_pop(heap_a);
+
+    /*
+     * swap with last, then sift down
+     */
+    VALUE pop_val  = rb_ary_entry(heap_a, 0);
+    VALUE sift_val = rb_ary_entry(heap_a, last_idx);
+    rb_ary_store(heap_a, 0, sift_val);
+    rb_ary_pop(heap_a);
+    dheap_sift_down_s(Qnil, heap_a, heap_d, LONG2NUM(0));
+
+    return pop_val;
+}
+
+void
+Init_d_heap(void)
+{
+    id_cmp = rb_intern_const("<=>");
+    id_ivar_a = rb_intern_const("ary");
+    id_ivar_d = rb_intern_const("d");
+
+    rb_cDHeap = rb_define_class("DHeap", rb_cObject);
+    rb_define_method(rb_cDHeap, "initialize", dheap_initialize, -1);
+    rb_define_method(rb_cDHeap, "d", dheap_d, 0);
+    rb_define_private_method(rb_cDHeap, "_ary_", dheap_a, 0);
+
+    rb_define_singleton_method(rb_cDHeap, "heap_sift_down", dheap_sift_down_s, 3);
+    rb_define_singleton_method(rb_cDHeap, "heap_sift_up",   dheap_sift_up_s, 3);
+
+    rb_define_method(rb_cDHeap, "push", dheap_push, 1);
+    rb_define_method(rb_cDHeap, "<<",   dheap_left_shift,  1);
+    rb_define_method(rb_cDHeap, "pop",  dheap_pop,  0);
+}

data/ext/d_heap/d_heap.h

@@ -0,0 +1,33 @@
+#ifndef D_HEAP_H
+#define D_HEAP_H 1
+
+#include "ruby.h"
+
+// This is somewhat a arbitary boundary, but it is highly unlikely that the
+// gains from fewer levels can outweight doing this many comparisons per level.
+// Since the comparisons will still be executed using <=> on ruby objects, it's
+// likely they will be too slow to make any d > 8 worthwhile.
+#define DHEAP_MAX_D 128
+#define DHEAP_DEFAULT_D 4
+
+#define CMP_LT(a, b) \
+    (rb_cmpint(rb_funcallv(a, id_cmp, 1, &b), a, b) < 0)
+#define CMP_LTE(a, b) \
+    (rb_cmpint(rb_funcallv(a, id_cmp, 1, &b), a, b) <= 0)
+#define CMP_GT(a, b) \
+    (rb_cmpint(rb_funcallv(a, id_cmp, 1, &b), a, b) > 0)
+#define CMP_GTE(a, b) \
+    (rb_cmpint(rb_funcallv(a, id_cmp, 1, &b), a, b) >= 0)
+
+VALUE rb_cDHeap;
+ID id_cmp;
+
+#define puts(v) { \
+    ID sym_puts = rb_intern("puts"); \
+    rb_funcall(rb_mKernel, sym_puts, 1, v); \
+}
+
+VALUE dheap_ary_sift_up(VALUE heap_array, int d, long sift_idx);
+VALUE dheap_ary_sift_down(VALUE heap_array, int d, long sift_idx);
+
+#endif /* D_HEAP_H */

data/ext/d_heap/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile("d_heap/d_heap")

data/lib/d_heap.rb

@@ -0,0 +1,38 @@
+require "d_heap/d_heap"
+require "d_heap/version"
+
+class DHeap
+
+  def initialize_dup(other)
+    super
+    _ary_.replace(_ary_.dup)
+  end
+
+  def freeze
+    _ary_.freeze
+    super
+  end
+
+  def peek
+    _ary_[0]
+  end
+
+  def empty?
+    _ary_.empty?
+  end
+
+  def size
+    _ary_.size
+  end
+
+  def each_in_order
+    return to_enum(__method__) unless block_given?
+    heap = dup
+    yield val until heap.emptu?
+  end
+
+  def to_a
+    _ary_.dup
+  end
+
+end

data/lib/d_heap/version.rb

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

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: d_heap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nicholas a. evans
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-23 00:00:00.000000000 Z
+dependencies: []
+description: |
+  A C extension implementation of a d-ary heap data structure, suitable for
+  use in e.g. priority queues or Djikstra's algorithm.
+email:
+- nicholas.evans@gmail.com
+executables: []
+extensions:
+- ext/d_heap/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- d_heap.gemspec
+- ext/d_heap/d_heap.c
+- ext/d_heap/d_heap.h
+- ext/d_heap/extconf.rb
+- lib/d_heap.rb
+- lib/d_heap/version.rb
+homepage: https://github.com/nevans/d_heap
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nevans/d_heap
+  source_code_uri: https://github.com/nevans/d_heap
+  changelog_uri: https://github.com/nevans/d_heap/blob/master/Changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A d-ary heap implementation, for priority queues
+test_files: []