dijkstra_fast 1.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0806b283afa40238d914c51d06c587a4dc053d65431bb68c55b6a06a827bb245'
+  data.tar.gz: c070c8d2f5bfb38b3fe25469190ef460ca1581a3c670b1715cb3696b6e46373b
+SHA512:
+  metadata.gz: 04640eac7496a7fd98dae710d4582f27397b86f4782e9c6fec3eb4a4ef4d46aff809c33a7295dee419c56f09a276214937b09beb1a03220bcbcf3c65d977e2d6
+  data.tar.gz: ee26aad2a4a9ab681754e4b8682f8b465e94bc36797da88f3d2ef62de260f4e69e9f2c80dd6856962f3e80a88f3e31cc3e871d9ac9d5d0146a6cfb10906856c7

data/.codeclimate.yml

@@ -0,0 +1,24 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+    checks:
+      Similar code:
+        enabled: false
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+    exclude_fingerprints:
+    - 4218049e28199ed950d3cd721df86dce
+    - c8179d0de3a9df18a2c45750d3f8647e
+    - 03f6eee11d86507da564695007106721
+    channel: rubocop-1-23-0
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.rake_tasks
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/html/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.bundle
+*.so
+extconf.rb

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,195 @@
+AllCops:
+  Exclude:
+  - dijkstra.gemspec
+  - Rakefile
+  - ext/**/*
+  - tmp/**/*
+Gemspec/DateAssignment:
+  Enabled: true
+Gemspec/RequireMFA:
+  Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+Layout/ExtraSpacing:
+  Enabled: false
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+Layout/LineLength:
+  Max: 120
+  Enabled: false
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+Lint/AmbiguousAssignment:
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+Lint/AmbiguousRange:
+  Enabled: true
+Lint/DeprecatedConstants:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Lint/EmptyInPattern:
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/NumberedParameterAssignment:
+  Enabled: true
+Lint/OrAssignmentToConstant:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/RedundantDirGlobSort:
+  Enabled: true
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Lint/SymbolConversion:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/TripleQuotes:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Lint/UselessRuby2Keywords:
+  Enabled: true
+Metrics/AbcSize:
+  Max: 50
+  Enabled: false
+Metrics/BlockLength:
+  Max: 50
+  Enabled: false
+Metrics/ClassLength:
+  Max: 50
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Max: 30
+  Enabled: false
+Metrics/MethodLength:
+  Max: 20
+  Enabled: false
+Metrics/ModuleLength:
+  Max: 1000
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Max: 30
+  Enabled: false
+Security/IoMethods:
+  Enabled: true
+Security/MarshalLoad:
+  Enabled: false
+Style/AndOr:
+  Enabled: false
+Style/ArgumentsForwarding:
+  Enabled: true
+Style/CaseEquality:
+  Enabled: false
+Style/CollectionCompact:
+  Enabled: true
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/EndlessMethod:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/HashConversion:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashExcept:
+  Enabled: true
+Style/HashSyntax:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/IfUnlessModifier:
+  Enabled: false
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+Style/InPatternThen:
+  Enabled: true
+Style/MultilineBlockChain:
+  Enabled: false
+Style/MultilineIfModifier:
+  Enabled: false
+Style/MultilineInPatternThen:
+  Enabled: true
+Style/MutableConstant:
+  Enabled: false
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/NumberedParameters:
+  Enabled: true
+Style/NumberedParametersLimit:
+  Enabled: true
+Style/OpenStructUse:
+  Enabled: true
+Style/QuotedSymbols:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+Style/RescueModifier:
+  Enabled: false
+Style/RescueStandardError:
+  Enabled: false
+Style/SelectByRegexp:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Style/StringChars:
+  Enabled: true
+Style/SwapValues:
+  Enabled: true
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/ZeroLengthPredicate:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.0.3

data/.travis.yml

@@ -0,0 +1,16 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=b5370328873f97034f05a0c49b63b7d13b6eeaed129f1bdf17509f183cd6a2f7
+language: ruby
+rvm:
+  - 3.0.3
+before_install: gem install bundler -v 2.2.32
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+  - bundle exec rake compile
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at david@bloomfire.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David McCullars
+
+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,69 @@
+# Dijkstra (Fast!)
+
+* README:         https://github.com/david-mccullars/dijkstra_fast
+* Documentation:  http://www.rubydoc.info/github/david-mccullars/dijkstra_fast
+* Bug Reports:    https://github.com/david-mccullars/dijkstra_fast/issues
+
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/dijkstra_fast.svg)](https://badge.fury.io/rb/dijkstra_fast)
+[![Travis Build Status](https://travis-ci.org/david-mccullars/dijkstra_fast.svg?branch=master)](https://travis-ci.org/david-mccullars/dijkstra_fast)
+[![Code Climate](https://codeclimate.com/github/david-mccullars/dijkstra_fast/badges/gpa.svg)](https://codeclimate.com/github/david-mccullars/dijkstra_fast)
+[![Test Coverage](https://codeclimate.com/github/david-mccullars/dijkstra_fast/badges/coverage.svg)](https://codeclimate.com/github/david-mccullars/dijkstra_fast/coverage)
+
+
+## Description
+
+[Dijkstra](https://en.wikipedia.org/wiki/Dijkstra's_algorithm) is a commonly
+used algorithm for finding the shortest path through a graph or network.
+
+
+## Features
+
+* Native implementation of Dijkstra's algorithm intended for use on large,
+sparse graphs for which an array of arrays is inefficient.
+
+
+## Installation
+
+```
+gem install dijkstra_fast
+```
+
+## Requirements
+
+* Ruby 3.0 or higher
+
+## Usage
+
+**Dijkstra**
+
+```ruby
+require 'dijkstra_fast'
+
+graph = DijkstraFast::Graph.new
+graph.add("A", "B", distance: 5)
+graph.add("A", "C", distance: 8)
+graph.add("B", "C", distance: 2)
+best_path = graph.shortest_path("A", "C")
+best_path.path
+
+=> ["A", "B", "C"]
+
+best_path.distance
+
+=> 7
+```
+
+
+## License
+
+MIT. See the `LICENSE` file.
+
+
+## References
+
+> Cormen, Thomas H.; Leiserson, Charles E.; Rivest, Ronald L.; Stein, Clifford (2001). "Section 24.3: Dijkstra's algorithm". Introduction to Algorithms (Second ed.). MIT Press and McGraw–Hill. pp. 595–601. ISBN 0-262-03293-7.
+
+> Knuth, D.E. (1977). "A Generalization of Dijkstra's Algorithm". Information Processing Letters. 6 (1): 1–5. doi:10.1016/0020-0190(77)90002-3.

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+end
+
+Rake::ExtensionTask.new('dijkstra_fast') do |ext|
+  ext.lib_dir = 'lib/dijkstra_fast'
+end

data/dijkstra_fast.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dijkstra_fast/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dijkstra_fast'
+  spec.version       = DijkstraFast::VERSION
+  spec.authors       = ['David McCullars']
+  spec.email         = ['david.mccullars@gmail.com']
+
+  spec.summary       = '(Native) implementation of Dijkstra algorithm for large, sparse graphs'
+  spec.description   = <<~DESCRIPTION
+Native implementation of Dijkstra algorithm for finding the shortest path
+between two vertices in a large, sparse graphs. Underlying algorithm is
+implemented in C using a priority queue.  Edges are represented using linked
+lists rather than an adjacency matrix to reduce memory footprint when operating
+on very large graphs where the average number of edges between nodes is
+relatively small (e.g. < 1/10 the number of nodes). See
+https://en.wikipedia.org/wiki/Dijkstra's_algorithm for additional information.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/david-mccullars/dijkstra_fast'
+  spec.license       = 'MIT'
+
+  spec.files         = `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.extensions    = ['ext/dijkstra_fast/extconf.rb']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rake-compiler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'yard'
+end

data/ext/dijkstra_fast/dijkstra_fast.c

@@ -0,0 +1,5 @@
+#include <dijkstra_graph.h>
+
+void Init_dijkstra_fast() {
+  Init_dijkstra_graph();
+}

data/ext/dijkstra_fast/dijkstra_graph.c

@@ -0,0 +1,234 @@
+#include <ruby.h>
+#include <dijkstra_graph.h>
+#include <prioritized_item_list.h>
+
+const size_t VERTEX_LIST_SIZE = sizeof(VertexListStruct);
+const size_t EDGE_LIST_SIZE = sizeof(EdgeListStruct);
+const size_t VERTEX_SIZE = sizeof(VertexStruct);
+const size_t EDGE_SIZE = sizeof(EdgeStruct);
+const size_t GRAPH_SIZE = sizeof(GraphStruct);
+
+static const rb_data_type_t graph_typed_data = {
+  "Dijkstra/Graph",
+  { 0, free_graph, },
+  0, 0,
+  RUBY_TYPED_FREE_IMMEDIATELY,
+};
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+void Init_dijkstra_graph() {
+  VALUE DijkstraFastModule, GraphClass;
+
+  DijkstraFastModule = rb_const_get(rb_cObject, rb_intern("DijkstraFast"));
+  GraphClass = rb_const_get(DijkstraFastModule, rb_intern("Graph"));
+
+  rb_define_alloc_func(GraphClass, dijkstra_graph_allocate);
+  rb_define_private_method(GraphClass, "_add_edge", dijkstra_graph_add_edge, 3);
+  rb_define_private_method(GraphClass, "_shortest_path", dijkstra_graph_shortest_path, 3);
+}
+
+VALUE dijkstra_graph_allocate(VALUE self) {
+  Graph g = malloc(GRAPH_SIZE);
+
+  // Grab a reference to the hash type used by a generic Ruby {}
+  // which accepts any key and any value.  We'll need this type to create
+  // a st_table in which to put arbitrary VALUE keys.  This hash type
+  // should be a static constant and thus should be safe to utilize without
+  // fear of garbage collection.
+  const struct st_hash_type *objhash = rb_hash_tbl(rb_hash_new(), "dijkstra.c", 1)->type;
+
+  g->vertex_count = 0;
+  g->vertices = NULL;
+  g->vertex_lookup = st_init_table_with_size(objhash, 0);
+
+  return TypedData_Wrap_Struct(self, &graph_typed_data, g);
+}
+
+VALUE dijkstra_graph_add_edge(VALUE self, VALUE source_label, VALUE dest_label, VALUE distance) {
+  Graph g;
+
+  TypedData_Get_Struct(self, GraphStruct, &graph_typed_data, g);
+  add_edge_with_labels(g, source_label, dest_label, NUM2INT(distance));
+  return Qnil;
+}
+
+VALUE dijkstra_graph_shortest_path(VALUE self, VALUE source_label, VALUE dest_label, VALUE best_path) {
+  Graph g;
+  Vertex source, dest;
+
+  TypedData_Get_Struct(self, GraphStruct, &graph_typed_data, g);
+  source = lookup_vertex(g, source_label, false);
+  dest = lookup_vertex(g, dest_label, false);
+
+  if (source == NULL || dest == NULL) {
+    return Qnil;
+  } else {
+    return INT2NUM(shortest_path(g, source, dest, best_path));
+  }
+}
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+void free_graph(void *data) {
+  Graph g = (Graph)data;
+
+  struct EdgeListStruct **vertices;
+
+  free_vertex_list(g->vertices, free_vertex);
+  free(g->vertex_lookup);
+  free(g);
+}
+
+void free_vertex(Vertex n) {
+  free_edge_list(n->edges, free_edge);
+  free(n);
+}
+
+void free_vertex_list(VertexList vertices, void (*free_item)(Vertex)) {
+  VertexList tmp;
+  while (vertices != NULL) {
+    tmp = vertices;
+    vertices = vertices->next;
+    if (free_item) {
+      free_item(tmp->vertex);
+    }
+    free(tmp);
+  }
+}
+
+void free_edge(Edge e) {
+  // Assume source and destination vertices were allocated elsewhere and will be free'd elsewhere
+  free(e);
+}
+
+void free_edge_list(EdgeList edges, void (*free_item)(Edge)) {
+  EdgeList tmp;
+  while (edges != NULL) {
+    tmp = edges;
+    edges = edges->next;
+    if (free_item) {
+      free_item(tmp->edge);
+    }
+    free(tmp);
+  }
+}
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+Vertex add_vertex(Graph g, VALUE label) {
+  VertexList tmp = malloc(VERTEX_LIST_SIZE);
+
+  tmp->vertex = malloc(VERTEX_SIZE);
+  tmp->vertex->id = g->vertices != NULL ? g->vertices->vertex->id + 1 : 0; // Auto-incrementing id
+  tmp->vertex->label = label;
+  tmp->vertex->edges = NULL;
+
+  tmp->next = g->vertices;
+  g->vertices = tmp;
+  g->vertex_count += 1;
+
+  return tmp->vertex;
+}
+
+VertexList add_vertex_to_list(VertexList list, VALUE label) {
+  VertexList tmp = malloc(VERTEX_LIST_SIZE);
+
+  tmp->vertex = malloc(VERTEX_SIZE);
+  tmp->vertex->label = label;
+  tmp->vertex->edges = NULL;
+
+  tmp->next = list;
+  return tmp;
+}
+
+Edge add_edge(Vertex source, Vertex dest, int distance) {
+  EdgeList tmp = malloc(EDGE_LIST_SIZE);
+
+  tmp->edge = malloc(EDGE_SIZE);
+  tmp->edge->source = source;
+  tmp->edge->dest = dest;
+  tmp->edge->distance = distance;
+
+  tmp->next = source->edges;
+  source->edges = tmp;
+
+  return tmp->edge;
+}
+
+Edge add_edge_with_labels(Graph g, VALUE source_label, VALUE dest_label, int distance) {
+  Vertex source, dest;
+
+  source = lookup_vertex(g, source_label, true);
+  dest = lookup_vertex(g, dest_label, true);
+
+  return add_edge(source, dest, distance);
+}
+
+Vertex lookup_vertex(Graph g, VALUE label, bool create_if_missing) {
+  Vertex n = NULL;
+
+  if (!st_lookup(g->vertex_lookup, (st_data_t)label, (st_data_t *)&n)) {
+    if (!create_if_missing) return NULL;
+    n = add_vertex(g, label);
+    st_add_direct(g->vertex_lookup, (st_data_t)label, (st_data_t)n);
+  }
+  return n;
+}
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+int shortest_path(Graph g, Vertex source, Vertex dest, VALUE best_path) {
+  Vertex *items, *prevs;
+  PrioritizedItemList list;
+
+  int d, du, dv;
+  Vertex u, v;
+  VertexList vl;
+  EdgeList el;
+  bool reached = source == dest;
+
+  items = malloc(g->vertex_count * sizeof(Vertex));
+  prevs = malloc(g->vertex_count * sizeof(Vertex));
+  list = make_prioritized_item_list(g->vertex_count);
+
+  for (vl = g->vertices; vl != NULL; vl = vl->next) {
+    v = vl->vertex;
+    items[v->id] = v;
+    prevs[v->id] = NULL;
+  }
+
+  update_prioritized_item(list, source->id, 0);
+
+  while (!empty_prioritized_item_list(list)) {
+    u = items[next_prioritized_item(list)];
+    du = get_priority(list, u->id);
+    for (el = u->edges; el != NULL; el = el->next) {
+      v = el->edge->dest;
+      dv = get_priority(list, v->id);
+      d = du + el->edge->distance;
+      if (d < 0) d = INT_MAX; // Wrapped around
+
+      if (in_prioritized_item_list(list, v->id) && d < dv) {
+        update_prioritized_item(list, v->id, d);
+        prevs[v->id] = u;
+        reached = reached || v == dest;
+      }
+    }
+  }
+
+  if (reached) {
+    for (v = dest; v != NULL; v = prevs[v->id]) {
+      rb_ary_unshift(best_path, v->label); 
+    }
+    d = get_priority(list, dest->id);
+  } else {
+    d = -1;
+  }
+
+  free(items);
+  free(prevs);
+  free_prioritized_item_list(list);
+
+  return d;
+}

data/ext/dijkstra_fast/dijkstra_graph.h

@@ -0,0 +1,83 @@
+#ifndef DIJKSTRA_GRAPH_H
+#define DIJKSTRA_GRAPH_H
+
+#include <ruby.h>
+
+struct VertexListStruct;
+typedef struct VertexListStruct* VertexList;
+
+typedef struct VertexListStruct {
+  struct VertexStruct *vertex;
+  struct VertexListStruct *next;
+} VertexListStruct;
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+struct EdgeListStruct;
+typedef struct EdgeListStruct* EdgeList;
+
+typedef struct EdgeListStruct {
+  struct EdgeStruct *edge;
+  struct EdgeListStruct *next;
+} EdgeListStruct;
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+struct VertexStruct;
+typedef struct VertexStruct* Vertex;
+
+typedef struct VertexStruct {
+  EdgeList edges;
+  int id;
+  VALUE label;
+} VertexStruct;
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+struct EdgeStruct;
+typedef struct EdgeStruct* Edge;
+
+typedef struct EdgeStruct {
+  Vertex source;
+  Vertex dest;
+  int distance;
+} EdgeStruct;
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+struct GraphStruct;
+typedef struct GraphStruct* Graph;
+
+typedef struct GraphStruct {
+  unsigned long vertex_count;
+  VertexList vertices;
+  st_table *vertex_lookup;
+} GraphStruct;
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+void free_graph(void *data);
+void free_vertex(Vertex n);
+void free_vertex_list(VertexList vertices, void (*free_item)(Vertex));
+void free_edge(Edge e);
+void free_edge_list(EdgeList edges, void (*free_item)(Edge));
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+Vertex add_vertex(Graph g, VALUE label);
+Edge add_edge(Vertex source, Vertex dest, int distance);
+Edge add_edge_with_labels(Graph g, VALUE source_label, VALUE dest_label, int distance);
+Vertex lookup_vertex(Graph g, VALUE label, bool create_if_missing);
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+int shortest_path(Graph g, Vertex source, Vertex dest, VALUE best_path);
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+void Init_dijkstra_graph();
+VALUE dijkstra_graph_allocate(VALUE self);
+VALUE dijkstra_graph_add_edge(VALUE self, VALUE source_label, VALUE dest_label, VALUE distance);
+VALUE dijkstra_graph_shortest_path(VALUE self, VALUE source_label, VALUE dest_label, VALUE best_path);
+
+#endif

data/ext/dijkstra_fast/extconf.rb

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

data/ext/dijkstra_fast/prioritized_item_list.c

@@ -0,0 +1,128 @@
+#include <prioritized_item_list.h>
+
+PrioritizedItemList make_prioritized_item_list(int capacity) {
+  int i;
+
+  PrioritizedItemList list = malloc(sizeof(PrioritizedItemListStruct));
+  list->priorities = malloc(capacity * sizeof(PrioritizedItem));
+  list->indices = malloc(capacity * sizeof(int));
+  list->capacity = capacity;
+  list->last = capacity - 1;
+  for (i = 0; i < capacity; i++) {
+    list->priorities[i] = malloc(sizeof(PrioritizedItemStruct));
+    list->priorities[i]->item = i;
+    list->priorities[i]->priority = INT_MAX;
+    list->indices[i] = i;
+  }
+  return list;
+}
+
+bool empty_prioritized_item_list(PrioritizedItemList list) {
+  return list->last < 0;
+}
+
+bool in_prioritized_item_list(PrioritizedItemList list, int item) {
+  return list->indices[item] <= list->last;
+}
+
+void swap_prioritized_items(PrioritizedItemList list, int i, int j) {
+  PrioritizedItem tmp = list->priorities[i];
+  list->priorities[i] = list->priorities[j];
+  list->priorities[j] = tmp;
+  list->indices[list->priorities[i]->item] = i;
+  list->indices[list->priorities[j]->item] = j;
+}
+
+void reprioritize_right(PrioritizedItemList list, int i) {
+int orig_i = i;
+  int wi, wj_left, wj_right;
+  int j_left, j_right;
+  wi = list->priorities[i]->priority;
+
+  while (true) {
+    j_left = (i << 1) + 1;
+    j_right = j_left + 1;
+
+    wj_left = j_left <= list->last ? list->priorities[j_left]->priority : INT_MAX;
+    wj_right = j_right <= list->last ? list->priorities[j_right]->priority : INT_MAX;
+
+    if (wj_right < wi && wj_right < wj_left) {
+      swap_prioritized_items(list, i, j_right);
+      i = j_right;
+
+    } else if (wj_left < wi) {
+      swap_prioritized_items(list, i, j_left);
+      i = j_left;
+
+    } else {
+      return;
+    } 
+  }
+}
+
+void reprioritize_left(PrioritizedItemList list, int i) {
+  int wi, wj;
+  int j;
+  wi = list->priorities[i]->priority;
+
+  while (i > 0) {
+    j = (i - 1) >> 1;
+    wj = list->priorities[j]->priority;
+
+    if (wj > wi) {
+      swap_prioritized_items(list, i, j);
+      i = j;
+
+    } else {
+      return;
+    }
+  }
+}
+
+int next_prioritized_item(PrioritizedItemList list) {
+  PrioritizedItem item;
+
+  if (empty_prioritized_item_list(list)) {
+    return -1;
+  }
+
+  item = list->priorities[0];
+  swap_prioritized_items(list, 0, list->last);
+  list->last--;
+  reprioritize_right(list, 0);
+
+  return item->item;
+}
+
+void update_prioritized_item(PrioritizedItemList list, int item, int priority) {
+  int i = list->indices[item];
+  list->priorities[i]->priority = priority;
+
+  if (i <= list->last) {
+    reprioritize_left(list, i);
+  }
+}
+
+int get_priority(PrioritizedItemList list, int item) {
+  int index = list->indices[item];
+  return list->priorities[index]->priority;
+}
+
+// For debugging only
+void print_prioritized_item_list(PrioritizedItemList list) {
+  for (int i = 0; i <= list->last; i++) {
+    if (i > 0) printf(", ");
+    printf("%d (%d)", list->priorities[i]->item, list->priorities[i]->priority);
+  }
+  printf("\n");
+}
+
+void free_prioritized_item_list(PrioritizedItemList list) {
+  for (int i = 0; i < list->capacity; i++) {
+    free(list->priorities[i]);
+  }
+
+  free(list->priorities);
+  free(list->indices);
+  free(list);
+}

data/ext/dijkstra_fast/prioritized_item_list.h

@@ -0,0 +1,39 @@
+#ifndef PRIORITIZED_ITEM_LIST_H
+#define PRIORITIZED_ITEM_LIST_H
+
+#include <ruby.h>
+
+struct PrioritizedItemStruct;
+typedef struct PrioritizedItemStruct* PrioritizedItem;
+
+typedef struct PrioritizedItemStruct {
+  int item;
+  int priority;
+} PrioritizedItemStruct;
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+struct PrioritizedItemListStruct;
+typedef struct PrioritizedItemListStruct* PrioritizedItemList;
+
+typedef struct PrioritizedItemListStruct {
+  PrioritizedItem *priorities;
+  int *indices;
+  int capacity;
+  int last;
+} PrioritizedItemListStruct;
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+PrioritizedItemList make_prioritized_item_list(int capacity);
+bool empty_prioritized_item_list(PrioritizedItemList list);
+bool in_prioritized_item_list(PrioritizedItemList list, int item);
+int next_prioritized_item(PrioritizedItemList list);
+void update_prioritized_item(PrioritizedItemList list, int item, int priority);
+void print_prioritized_item_list(PrioritizedItemList list);
+int get_priority(PrioritizedItemList list, int item);
+void free_prioritized_item_list(PrioritizedItemList list);
+
+//////////////////////////////////////////////////////////////////////////////////////
+
+#endif

data/lib/dijkstra_fast/best_path.rb

@@ -0,0 +1,17 @@
+module DijkstraFast
+  ##
+  # The "best path" from applying Dijkstra's algorithm contains both the ordered
+  # list of nodes travelled as well as the total distance travelled.
+  ##
+  class BestPath
+
+    attr_reader :path
+    attr_accessor :distance
+
+    def initialize
+      @path = []
+      @distance = 0
+    end
+
+  end
+end

data/lib/dijkstra_fast/graph.rb

@@ -0,0 +1,63 @@
+module DijkstraFast
+  ##
+  # Dijkstra's algorithm finds the shortest "distance" between two items within a
+  # collection.  For any two items within that collection that are "connected"
+  # there should be an associated "distance" between them.  We can represent this
+  # collection of items as nodes in a directed graph, and we can represent the
+  # associated connections as weighted edges.
+  #
+  # = Example
+  #
+  #  graph = DijkstraFast::Graph.new
+  #  graph.add("A", "B", distance: 5)
+  #  graph.add("A", "C", distance: 8)
+  #  graph.add("B", "C", distance: 2)
+  #  best_path = graph.shortest_path("A", "C")
+  #  best_path.path
+  #
+  #  => ["A", "B", "C"]
+  #
+  #  best_path.distance
+  #
+  #  => 7
+  #
+  ##
+  class Graph
+
+    def initialize
+      @nodes = {}
+    end
+
+    # Adds a weighted edge to the graph. This represents a possible path from the
+    # source item to the destination item with corresponding "distance."
+    # @param source [Object] Any Ruby object that represents the source item
+    # @param dest [Object] Any Ruby object that represents the destination item
+    # @param distance [Integer] Optional distance between source and destination.
+    #                           If not provided, a default distance of `1` is used.
+    # @return [nil]
+    def add(source, dest, distance: 1)
+      _add_edge(node(source), node(dest), distance) unless source == dest
+    end
+
+    # Finds the shortest path between items, returning both the path as well as
+    # the total distance travelled.
+    # @param source [Object] Any Ruby object that represents the source item
+    # @param dest [Object] Any Ruby object that represents the destination item
+    # @return [BestPath]
+    def shortest_path(source, dest)
+      best_path = BestPath.new
+      best_path.distance = _shortest_path(node(source), node(dest), best_path.path)
+      if best_path.path.empty? || best_path.distance.nil? || best_path.distance < 0
+        raise NoPathExistsError
+      end
+      best_path
+    end
+
+    private
+
+    def node(obj)
+      @nodes[obj] ||= @nodes.size # Auto-increment id
+    end
+
+  end
+end

data/lib/dijkstra_fast/no_path_exists_error.rb

@@ -0,0 +1,6 @@
+module DijkstraFast
+  ##
+  # Raised when no path exists between the given source and destination items.
+  ##
+  class NoPathExistsError < StandardError; end
+end

data/lib/dijkstra_fast/version.rb

@@ -0,0 +1,6 @@
+module DijkstraFast
+
+  # Current gem version
+  VERSION = '1.4.2'
+
+end

data/lib/dijkstra_fast.rb

@@ -0,0 +1,22 @@
+##
+# Provides native implementation of Dijkstra's algorithm for finding the shortest
+# path between two vertices in a large, sparse graph.
+#
+# Underlying algorithm is implemented in C using a priority queue.  Edges are
+# represented using linked lists rather than an adjacency matrix to reduce memory
+# footprint when operating on very large graphs where the average number of edges
+# between nodes is relatively small (e.g. < 1/10 the number of nodes). See
+#
+# @see README
+# @see https://en.wikipedia.org/wiki/Dijkstra's_algorithm
+##
+module DijkstraFast
+
+  autoload :BestPath,           'dijkstra_fast/best_path'
+  autoload :Graph,              'dijkstra_fast/graph'
+  autoload :NoPathExistsError,  'dijkstra_fast/no_path_exists_error'
+  autoload :VERSION,            'dijkstra_fast/version'
+
+end
+
+require 'dijkstra_fast/dijkstra_fast'

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: dijkstra_fast
+version: !ruby/object:Gem::Version
+  version: 1.4.2
+platform: ruby
+authors:
+- David McCullars
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Native implementation of Dijkstra algorithm for finding the shortest path
+  between two vertices in a large, sparse graphs. Underlying algorithm is
+  implemented in C using a priority queue.  Edges are represented using linked
+  lists rather than an adjacency matrix to reduce memory footprint when operating
+  on very large graphs where the average number of edges between nodes is
+  relatively small (e.g. < 1/10 the number of nodes). See
+  https://en.wikipedia.org/wiki/Dijkstra's_algorithm for additional information.
+email:
+- david.mccullars@gmail.com
+executables: []
+extensions:
+- ext/dijkstra_fast/extconf.rb
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dijkstra_fast.gemspec
+- ext/dijkstra_fast/dijkstra_fast.c
+- ext/dijkstra_fast/dijkstra_graph.c
+- ext/dijkstra_fast/dijkstra_graph.h
+- ext/dijkstra_fast/extconf.rb
+- ext/dijkstra_fast/prioritized_item_list.c
+- ext/dijkstra_fast/prioritized_item_list.h
+- lib/dijkstra_fast.rb
+- lib/dijkstra_fast/best_path.rb
+- lib/dijkstra_fast/graph.rb
+- lib/dijkstra_fast/no_path_exists_error.rb
+- lib/dijkstra_fast/version.rb
+homepage: https://github.com/david-mccullars/dijkstra_fast
+licenses:
+- MIT
+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: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: "(Native) implementation of Dijkstra algorithm for large, sparse graphs"
+test_files: []