networkr 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43e672ad355d6a2b7535dcea503b62266cc29d8c
-  data.tar.gz: 054fb810a76cc380e31f6c51a184d798538106d5
+  metadata.gz: 7edd7e7378f063576f1ec7eb1f99c5249e87e414
+  data.tar.gz: e5a82633408291f00db0c0d722b8f3048779c89b
 SHA512:
-  metadata.gz: 3f623b282a654a2ec6b18d4e8ab4cf2e05c2839c82c48da0e830ddfbc0cc8c2ad5c916ad609fd5835a189364df528e5f0a558e4e2d463681fcc6565c14193795
-  data.tar.gz: f9dbe521e03f73414c12b03fc7d7ab7550a98318f26b03f19283af502e59636a224d4d2854ebbbf51a14088390ad33268b301f916adaad385668c9e3f9853cac
+  metadata.gz: 60fe3c7de61c2229be0498da555d48becb4a150d083d788f39f6f280deae06389cd4150d5258a61bba5e78cf0e46a2af2d8a8b55daf8d36a861eb04e052c18a6
+  data.tar.gz: 50b22e9e6ab999cc4f569fc84e59a19076f842fc207366afb07702671526e99c96994e778b976c24af43e4bdfc220cc60183a557565268169188341e4771f894

data/.yardoc/checksums

@@ -0,0 +1,10 @@
+lib/networkr.rb 43923214b5cfdb4b79e5956d3cb0f45eeb2b7e6f
+lib/utils/heap.rb a495d1e614cf0c11895f1036968f1ef059cbf837
+lib/networkr/version.rb 3ea15170a76704b53f3b9174590913bccfbe19c8
+lib/networkr/graphs/graph.rb 0dccca2beba586bb30958644434f06fb4933651d
+lib/networkr/graphs/digraph.rb 6e5f9be871d96dcb4d4a285ee099a83c9ac3b360
+lib/networkr/algorithms/prim.rb abbee9c7c2868dcb04ad2b8a613efc4c58d7c218
+lib/networkr/graphs/multigraph.rb 383153b0c94aa98545f40da23ccb65910fa7e9bc
+lib/networkr/algorithms/karger.rb 2b95c1a6da1f27603330848b6bae3af76bf17ddd
+lib/networkr/algorithms/kosaraju.rb 30203afd643e3bb67341fc928a30338ae592f577
+lib/networkr/algorithms/dijkstra.rb c8493d7c3ec640e6e1bf96d154eab8a02c23f317

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    networkr (0.0.1)
+    networkr (0.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,10 @@
 # Networkr
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/networkr`. To experiment with that code, run `bin/console` for an interactive prompt.
+Networkr is a Ruby gem inspired by the Python package NetworkX. It includes basic functionality for the creation, manipulation, and analysis of graphs.
 
-TODO: Delete this and the text above, and describe your gem
+Graphs supported include undirected single-edge graphs (weighted or unweighted), directed single-edge graphs (weighted or unweighted), and undirected multi-edge graphs (weighted or unweighted).
+
+Algorithms available include Dijkstra's shortest paths, Karger's minimum cut, Kosaraju's strongly connected components, and Prim's minimum spanning tree.
 
 ## Installation
 
@@ -22,19 +24,154 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Graphs
+
+All `Networkr` graphs store nodes, an adjacency list, and optional attributes.
+
+- `Networkr::Graph` is the base class for `Networkr::DiGraph` and `Networkr::MultiGraph`. `Networkr::Graph` graphs hold undirected edges. Self loops are allowed but parallel edges are not.
+
+- `Networkr::DiGraph` graphs hold directed edges. Self loops are allowed but parallel edges are not.
+
+- `Networkr::MultiGraph` graphs hold undirected edges. Self loops and parallel edges are allowed.
+
+**Graphs**
+
+Create an empty `Networkr::Graph`:
+
+```ruby
+g = Networkr::Graph.new
+```
+
+Create an empty `Networkr::Graph` with an attribute:
+```ruby
+g = Networkr::Graph.new(name: "users")
+g.graph
+{ name: "users" }
+```
+
+`Networkr` graphs can be grown in several ways.
 
-## Development
+**Nodes**
 
-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.
+Nodes can be any Ruby object and can hold optional attributes.
+
+Add a node:
+
+```ruby
+g.add_node(1)
+```
+
+Add nodes with an attributes:
+
+```ruby
+g.add_node(1, username: "janedoe")
+g.add_node(3, username: "johndoe")
+g.nodes[1]
+{ username: "janedoe" }
+```
+
+Add/update node attributes using `#add_node` or `g.nodes`:
+
+```ruby
+g.nodes[1][:score] = 10
+g.nodes[1].delete(:score) # remove attribute
+g.nodes
+{ 1 => { username: "janedoe" }, 3 => { username: "johndoe" } }
+```
+
+**Edges**
+
+Edges are represented in an adjacency list can also hold optional attributes. If an edge connects nodes not yet in the graph, the nodes are added automatically. There are no errors when adding nodes or edges that already exist.
+
+Add an edge:
+
+```ruby
+g.add_edge(1, 2)
+```
+
+Add/update edge attributes using `#add_edge` or `g.adj`:
+
+```ruby
+g.add_edge(1, 2, weight: 10)
+g.adj[1][2][:weight] = 4
+g.adj[1][2]
+{ weight: 4 }
+```
+
+Other methods that can be called on `Networkr` graphs:
+
+- `#remove_edge(u, v)` removes edge `u`-`v`
+
+- `#children_of(node)` returns hash containing children of `node`
+
+- `#has_node?(node)` returns `true` if graph contains node `node`
+
+- `#has_edge?(u, v)` returns `true` if graph contains edge `u`-`v`
+
+- `#length` returns number of nodes in graph
+
+- `#clear` clears graph
+
+- `#deep_copy` returns deep copy of graph
+
+- `#is_directed?` returns boolean
+
+- `#is_multigraph?` returns boolean
+
+- `#to_s` returns string representation of graph
+
+### Algorithms
+
+**Shortest Paths**
+
+`Networkr::dijkstra` computes the shortest paths to every node in a weighted, undirected graph from a single source node. Weights must be non-negative.
+
+```ruby
+g = Networkr::Graph.new
+...
+Networkr::dijkstra(g, source_node) #returns a hash where keys are destination nodes and values are distances
+```
+
+**Minimum Spanning Tree**
+
+`Networkr::prim` finds the minimum spanning tree of a weighted, undirected graph. Weights can be negative. `source_node` should be a random node in the graph.
+
+```ruby
+g = Networkr::Graph.new
+...
+Networkr::prim(g, source_node) #returns a Networkr::Graph graph
+```
+
+**Minimum Cut**
+
+`Networkr::karger` finds a cut that crosses the minimum number of edges in a connected multi-edge graph. Karger's algorithm is a random algorithm and is not guaranteed to generate the correct output. However, if run |V|^2 log |V| times, its success probability is very high.
+
+Use `Networkr::karger` to run the algorithm once. Use `Networkr::karger_repeated` to run it |V|^2 log |V| times.
+
+```ruby
+g = Networkr::MultiGraph.new
+...
+Networkr::karger_repeated(g) #returns the minimum number of edges crossed by a cut
+```
+
+**Strongly Connected Components**
+
+`Networkr::kosaraju_scc_sizes` and `Networkr::kosaraju_num_scc` find the strongly connected components in a directed graph.
+
+```ruby
+g = Networkr::DiGraph.new
+g_rev = Networkr::DiGraph.new #reversed graph of g
+...
+Networkr::kosaraju_scc_sizes(g, g_rev) #returns the sizes of strongly connected components in descending order
+Neworkr::kosaraju_num_scc(g, g_rev) #returns the number of strongly connected components
+```
 
-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).
+## Future Directions
 
-## TODO
-more robust tests
-use heap
-more flexibility
-add algorithms
+- Implement algorithms with more efficient data structures
+- Add more robust tests
+- Allow algorithms to take more than one kind of graph and produce more than one kind of result
+- Add more algorithms
 
 ## Contributing
 

data/doc/BinaryMinHeap.html

@@ -0,0 +1,870 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: BinaryMinHeap
+  
+    &mdash; Documentation by YARD 0.9.5
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "BinaryMinHeap";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="_index.html">Index (B)</a> &raquo;
+    
+    
+    <span class="title">BinaryMinHeap</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <iframe id="search_frame" src="class_list.html"></iframe>
+
+      <div id="content"><h1>Class: BinaryMinHeap
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">BinaryMinHeap</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/utils/heap.rb</dd>
+  </dl>
+  
+</div>
+
+
+
+
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#child_indices-class_method" title="child_indices (class method)">.<strong>child_indices</strong>(len, parent_index)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#heapify_down-class_method" title="heapify_down (class method)">.<strong>heapify_down</strong>(array, index_map, parent_idx, len = array.length, &amp;prc)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#heapify_up-class_method" title="heapify_up (class method)">.<strong>heapify_up</strong>(array, child_idx, len = array.length, &amp;prc)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#parent_index-class_method" title="parent_index (class method)">.<strong>parent_index</strong>(child_index)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#swap%21-class_method" title="swap! (class method)">.<strong>swap!</strong>(array, index_map, i1, i2)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#count-instance_method" title="#count (instance method)">#<strong>count</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(&amp;prc)  &#x21d2; BinaryMinHeap </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of BinaryMinHeap.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#peek-instance_method" title="#peek (instance method)">#<strong>peek</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#pop-instance_method" title="#pop (instance method)">#<strong>pop</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#push-instance_method" title="#push (instance method)">#<strong>push</strong>(val)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#reduce%21-instance_method" title="#reduce! (instance method)">#<strong>reduce!</strong>(val)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    #<strong>initialize</strong>(&amp;prc)  &#x21d2; <tt><span class='object_link'><a href="" title="BinaryMinHeap (class)">BinaryMinHeap</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns a new instance of BinaryMinHeap</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+2
+3
+4
+5
+6</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utils/heap.rb', line 2</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_prc'>prc</span><span class='rparen'>)</span>
+  <span class='ivar'>@store</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='ivar'>@index_map</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+  <span class='ivar'>@prc</span> <span class='op'>=</span> <span class='id identifier rubyid_prc'>prc</span> <span class='op'>||</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='id identifier rubyid_b'>b</span><span class='op'>|</span> <span class='id identifier rubyid_a'>a</span> <span class='op'>&lt;=&gt;</span> <span class='id identifier rubyid_b'>b</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="child_indices-class_method">
+  
+    .<strong>child_indices</strong>(len, parent_index)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+52
+53
+54</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utils/heap.rb', line 52</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_child_indices'>child_indices</span><span class='lparen'>(</span><span class='id identifier rubyid_len'>len</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_index'>parent_index</span><span class='rparen'>)</span>
+  <span class='lbracket'>[</span><span class='int'>2</span> <span class='op'>*</span> <span class='id identifier rubyid_parent_index'>parent_index</span> <span class='op'>+</span> <span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span> <span class='op'>*</span> <span class='id identifier rubyid_parent_index'>parent_index</span> <span class='op'>+</span> <span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_idx'>idx</span><span class='op'>|</span> <span class='id identifier rubyid_idx'>idx</span> <span class='op'>&lt;</span> <span class='id identifier rubyid_len'>len</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="heapify_down-class_method">
+  
+    .<strong>heapify_down</strong>(array, index_map, parent_idx, len = array.length, &amp;prc)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utils/heap.rb', line 64</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_heapify_down'>heapify_down</span><span class='lparen'>(</span><span class='id identifier rubyid_array'>array</span><span class='comma'>,</span> <span class='id identifier rubyid_index_map'>index_map</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_idx'>parent_idx</span><span class='comma'>,</span> <span class='id identifier rubyid_len'>len</span> <span class='op'>=</span> <span class='id identifier rubyid_array'>array</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_prc'>prc</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_prc'>prc</span> <span class='op'>||=</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='id identifier rubyid_b'>b</span><span class='op'>|</span> <span class='id identifier rubyid_a'>a</span> <span class='op'>&lt;=&gt;</span> <span class='id identifier rubyid_b'>b</span> <span class='rbrace'>}</span>
+
+  <span class='kw'>while</span> <span class='id identifier rubyid_parent_idx'>parent_idx</span> <span class='op'>&lt;=</span> <span class='id identifier rubyid_parent_index'>parent_index</span><span class='lparen'>(</span><span class='id identifier rubyid_len'>len</span> <span class='op'>-</span> <span class='int'>1</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_children'>children</span> <span class='op'>=</span> <span class='id identifier rubyid_child_indices'>child_indices</span><span class='lparen'>(</span><span class='id identifier rubyid_len'>len</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_idx'>parent_idx</span><span class='rparen'>)</span>
+
+    <span class='kw'>if</span> <span class='id identifier rubyid_children'>children</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>==</span> <span class='int'>1</span>
+      <span class='id identifier rubyid_smallest_child_idx'>smallest_child_idx</span> <span class='op'>=</span> <span class='id identifier rubyid_children'>children</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
+    <span class='kw'>else</span>
+      <span class='id identifier rubyid_child1_idx'>child1_idx</span><span class='comma'>,</span> <span class='id identifier rubyid_child2_idx'>child2_idx</span> <span class='op'>=</span> <span class='id identifier rubyid_children'>children</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_children'>children</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
+
+      <span class='kw'>if</span> <span class='id identifier rubyid_prc'>prc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_array'>array</span><span class='lbracket'>[</span><span class='id identifier rubyid_child1_idx'>child1_idx</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_array'>array</span><span class='lbracket'>[</span><span class='id identifier rubyid_child2_idx'>child2_idx</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>&lt;=</span> <span class='int'>0</span>
+        <span class='id identifier rubyid_smallest_child_idx'>smallest_child_idx</span> <span class='op'>=</span> <span class='id identifier rubyid_child1_idx'>child1_idx</span>
+      <span class='kw'>else</span>
+        <span class='id identifier rubyid_smallest_child_idx'>smallest_child_idx</span> <span class='op'>=</span> <span class='id identifier rubyid_child2_idx'>child2_idx</span>
+      <span class='kw'>end</span>
+    <span class='kw'>end</span>
+
+    <span class='kw'>if</span> <span class='id identifier rubyid_prc'>prc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_array'>array</span><span class='lbracket'>[</span><span class='id identifier rubyid_parent_idx'>parent_idx</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_array'>array</span><span class='lbracket'>[</span><span class='id identifier rubyid_smallest_child_idx'>smallest_child_idx</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>&gt;</span> <span class='int'>0</span>
+      <span class='id identifier rubyid_swap!'>swap!</span><span class='lparen'>(</span><span class='id identifier rubyid_array'>array</span><span class='comma'>,</span> <span class='id identifier rubyid_index_map'>index_map</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_idx'>parent_idx</span><span class='comma'>,</span> <span class='id identifier rubyid_smallest_child_idx'>smallest_child_idx</span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_parent_idx'>parent_idx</span> <span class='op'>=</span> <span class='id identifier rubyid_smallest_child_idx'>smallest_child_idx</span>
+    <span class='kw'>else</span>
+      <span class='kw'>break</span>
+    <span class='kw'>end</span>
+
+  <span class='kw'>end</span>
+
+  <span class='id identifier rubyid_array'>array</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="heapify_up-class_method">
+  
+    .<strong>heapify_up</strong>(array, child_idx, len = array.length, &amp;prc)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+94
+95
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utils/heap.rb', line 94</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_heapify_up'>heapify_up</span><span class='lparen'>(</span><span class='id identifier rubyid_array'>array</span><span class='comma'>,</span> <span class='id identifier rubyid_child_idx'>child_idx</span><span class='comma'>,</span> <span class='id identifier rubyid_len'>len</span> <span class='op'>=</span> <span class='id identifier rubyid_array'>array</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_prc'>prc</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_prc'>prc</span> <span class='op'>||=</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='id identifier rubyid_b'>b</span><span class='op'>|</span> <span class='id identifier rubyid_a'>a</span> <span class='op'>&lt;=&gt;</span> <span class='id identifier rubyid_b'>b</span> <span class='rbrace'>}</span>
+
+  <span class='kw'>while</span> <span class='id identifier rubyid_child_idx'>child_idx</span> <span class='op'>&gt;</span> <span class='int'>0</span>
+    <span class='id identifier rubyid_parent_idx'>parent_idx</span> <span class='op'>=</span> <span class='id identifier rubyid_parent_index'>parent_index</span><span class='lparen'>(</span><span class='id identifier rubyid_child_idx'>child_idx</span><span class='rparen'>)</span>
+
+    <span class='kw'>if</span> <span class='id identifier rubyid_prc'>prc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_array'>array</span><span class='lbracket'>[</span><span class='id identifier rubyid_parent_idx'>parent_idx</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_array'>array</span><span class='lbracket'>[</span><span class='id identifier rubyid_child_idx'>child_idx</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>&gt;</span> <span class='int'>0</span>
+      <span class='id identifier rubyid_swap!'>swap!</span><span class='lparen'>(</span><span class='id identifier rubyid_array'>array</span><span class='comma'>,</span> <span class='id identifier rubyid_index_map'>index_map</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_idx'>parent_idx</span><span class='comma'>,</span> <span class='id identifier rubyid_child_idx'>child_idx</span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_child_idx'>child_idx</span> <span class='op'>=</span> <span class='id identifier rubyid_parent_idx'>parent_idx</span>
+    <span class='kw'>else</span>
+      <span class='kw'>break</span>
+    <span class='kw'>end</span>
+
+  <span class='kw'>end</span>
+
+  <span class='id identifier rubyid_array'>array</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="parent_index-class_method">
+  
+    .<strong>parent_index</strong>(child_index)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+56
+57
+58
+59
+60
+61
+62</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utils/heap.rb', line 56</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parent_index'>parent_index</span><span class='lparen'>(</span><span class='id identifier rubyid_child_index'>child_index</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_child_index'>child_index</span> <span class='op'>==</span> <span class='int'>0</span>
+    <span class='kw'>return</span> <span class='kw'>nil</span>
+  <span class='kw'>else</span>
+    <span class='lparen'>(</span><span class='id identifier rubyid_child_index'>child_index</span> <span class='op'>-</span> <span class='int'>1</span><span class='rparen'>)</span> <span class='op'>/</span> <span class='int'>2</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="swap!-class_method">
+  
+    .<strong>swap!</strong>(array, index_map, i1, i2)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+47
+48
+49
+50</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utils/heap.rb', line 47</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_swap!'>swap!</span><span class='lparen'>(</span><span class='id identifier rubyid_array'>array</span><span class='comma'>,</span> <span class='id identifier rubyid_index_map'>index_map</span><span class='comma'>,</span> <span class='id identifier rubyid_i1'>i1</span><span class='comma'>,</span> <span class='id identifier rubyid_i2'>i2</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_array'>array</span><span class='lbracket'>[</span><span class='id identifier rubyid_i1'>i1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_array'>array</span><span class='lbracket'>[</span><span class='id identifier rubyid_i2'>i2</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_array'>array</span><span class='lbracket'>[</span><span class='id identifier rubyid_i2'>i2</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_array'>array</span><span class='lbracket'>[</span><span class='id identifier rubyid_i1'>i1</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_index_map'>index_map</span><span class='lbracket'>[</span><span class='id identifier rubyid_parent_val'>parent_val</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_index_map'>index_map</span><span class='lbracket'>[</span><span class='id identifier rubyid_child_val'>child_val</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_child_idx'>child_idx</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_idx'>parent_idx</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="count-instance_method">
+  
+    #<strong>count</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utils/heap.rb', line 8</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_count'>count</span>
+  <span class='ivar'>@store</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="peek-instance_method">
+  
+    #<strong>peek</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+27
+28
+29
+30</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utils/heap.rb', line 27</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_peek'>peek</span>
+  <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>==</span> <span class='int'>0</span>
+  <span class='ivar'>@store</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="pop-instance_method">
+  
+    #<strong>pop</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utils/heap.rb', line 12</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_pop'>pop</span>
+  <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>==</span> <span class='int'>0</span>
+
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_swap!'>swap!</span><span class='lparen'>(</span><span class='ivar'>@store</span><span class='comma'>,</span> <span class='ivar'>@index_map</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>-</span> <span class='int'>1</span><span class='rparen'>)</span>
+
+  <span class='id identifier rubyid_val'>val</span> <span class='op'>=</span> <span class='ivar'>@store</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span>
+  <span class='ivar'>@index_map</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_val'>val</span><span class='rparen'>)</span>
+
+  <span class='kw'>unless</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>==</span> <span class='int'>0</span>
+    <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_heapify_down'>heapify_down</span><span class='lparen'>(</span><span class='ivar'>@store</span><span class='comma'>,</span> <span class='ivar'>@index_map</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_prc'>prc</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+
+  <span class='id identifier rubyid_val'>val</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="push-instance_method">
+  
+    #<strong>push</strong>(val)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+32
+33
+34
+35
+36</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utils/heap.rb', line 32</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_val'>val</span><span class='rparen'>)</span>
+  <span class='ivar'>@store</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_val'>val</span>
+  <span class='ivar'>@index_map</span><span class='lbracket'>[</span><span class='id identifier rubyid_val'>val</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>-</span> <span class='int'>1</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_heapify_up'>heapify_up</span><span class='lparen'>(</span><span class='ivar'>@store</span><span class='comma'>,</span> <span class='ivar'>@index_map</span><span class='comma'>,</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>-</span> <span class='int'>1</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_prc'>prc</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="reduce!-instance_method">
+  
+    #<strong>reduce!</strong>(val)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+38
+39
+40
+41</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/utils/heap.rb', line 38</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_reduce!'>reduce!</span><span class='lparen'>(</span><span class='id identifier rubyid_val'>val</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='ivar'>@index_map</span><span class='lbracket'>[</span><span class='id identifier rubyid_val'>val</span><span class='rbracket'>]</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_heapify_up'>heapify_up</span><span class='lparen'>(</span><span class='ivar'>@store</span><span class='comma'>,</span> <span class='ivar'>@index_map</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_prc'>prc</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Sun Jul 24 17:23:15 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.5 (ruby-2.1.2).
+</div>
+
+    </div>
+  </body>
+</html>