networkr 0.0.1 → 0.0.2

data/lib/networkr/graphs/multigraph.rb

@@ -1,36 +1,31 @@
-# require_relative "graph.rb"
-=begin
-Class for undirected graphs that can store parallel edges.
-
-A MultiGraph holds undirected edges. Self loops are allowed.
-
-See Also
---------
-Graph
-DiGraph
-=end
-
 module Networkr
-  class MultiGraph < Graph
-    def new_edge_key(u, v)
-=begin
-return an unused key for edges between nodes 'u' and 'v'.
 
-The nodes 'u' and 'v' do not need to be already in the graph.
-
-Notes
------
-
-The new key is the number of existing edges between 'u' and 'v', increased if necessary to ensure uniqueness. The first edge will have key 0, the second edge 1, etc. If an edge is removed, new keys may not be in this order.
-
-Parameters
-----------
-u, v: nodes
+  # Class for undirected graphs that can store parallel edges.
+  #
+  # A MultiGraph holds undirected edges. Self loops are allowed.
+  #
+  # See Also
+  # --------
+  # Graph
+  # DiGraph
+  class MultiGraph < Graph
 
-Returns
--------
-key: int
-=end
+    # returns an unused key for edges between nodes 'u' and 'v'.
+    #
+    # The nodes 'u' and 'v' do not need to be already in the graph.
+    #
+    # Notes
+    # -----
+    # The new key is the number of existing edges between 'u' and 'v', increased if necessary to ensure uniqueness. The first edge will have key 0, the second edge 1, etc. If an edge is removed, new keys may not be in this order.
+    #
+    # Parameters
+    # ----------
+    # u, v: nodes
+    #
+    # Returns
+    # -------
+    # key: int
+    def new_edge_key(u, v)
       if @adj[u] && @adj[u][v]
         keys = @adj[u][v]
         key = keys.length

data/lib/networkr/version.rb

@@ -1,3 +1,3 @@
 module Networkr
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/utils/heap.rb

@@ -1,7 +1,7 @@
 class BinaryMinHeap
   def initialize(&prc)
     @store = []
-    @index_map {}
+    @index_map = {}
     @prc = prc || Proc.new { |a, b| a <=> b }
   end
 

data/networkr.gemspec

@@ -9,10 +9,15 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Yi-Ke Peng"]
   spec.email         = ["yi.ke.peng@gmail.com"]
 
-  spec.summary       = %q{NetworkR}
-  spec.description   = %q{A gem for creating and manipulating graphs in Ruby.}
+  spec.summary       = %q{Create and manipulate graphs}
+  spec.description   = %q{Networkr is a Ruby gem inspired by the Python package NetworkX. It includes basic functionality for the creation, manipulation, and analysis of graphs.
+
+  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.}
   spec.homepage      = "http://github.com/ykpeng/networkr"
   spec.license       = "MIT"
+  spec.metadata["yard.run"] = "yri" # use "yard" to build full HTML docs.
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: networkr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Yi-Ke Peng
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-24 00:00:00.000000000 Z
+date: 2016-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: A gem for creating and manipulating graphs in Ruby.
+description: |-
+  Networkr is a Ruby gem inspired by the Python package NetworkX. It includes basic functionality for the creation, manipulation, and analysis of graphs.
+
+    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.
 email:
 - yi.ke.peng@gmail.com
 executables: []
@@ -60,6 +65,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".yardoc/checksums"
+- ".yardoc/complete"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -67,6 +77,27 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- doc/BinaryMinHeap.html
+- doc/Networkr.html
+- doc/Networkr/DiGraph.html
+- doc/Networkr/Graph.html
+- doc/Networkr/MultiGraph.html
+- doc/Networkr/Tracker.html
+- doc/NetworkrError.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/networkr.rb
 - lib/networkr/algorithms/dijkstra.rb
 - lib/networkr/algorithms/karger.rb
@@ -81,7 +112,8 @@ files:
 homepage: http://github.com/ykpeng/networkr
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -101,5 +133,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: NetworkR
+summary: Create and manipulate graphs
 test_files: []