graphmatch 1.0.0.pre → 1.0.0

data/lib/graphmatch.rb

@@ -1,25 +1,37 @@
 class Graphmatch
-  def self.test_gem
-    "Hello, World!"
-  end
-
-  def self.match(left_vertices, right_vertices, edges, search_type='BFS')
+  # Optimally match two sets of vertices.
+  #
+  # The edges must be specified as a hash of hashes, the keys being left vertices
+  # and the values be a hash of right vertices and the weights to them.
+  #
+  # Ex. Matching ['a', 'b'] to [1, 2], restrict it so 'a' can only reach 2.
+  #     All path lengths are uniform (= 0)
+  #
+  #      left_vertices = ["a", "b"]
+  #      right_vertices = [1, 2]
+  #      edges = {"a" => {2 => 0},
+  #               "b" => {1 => 0, 2 >= 0}}
+  #
+  # If the path lengths are equal, set search to :shortest_path
+  # If the path lengths vary, set search to :min_cost to optimize for min-cost max-flow
+  #
+  # @param left_vertices [Array] list of names of vertices on the left
+  # @param right_vertices [Array] list of names of vertices on the right
+  # @param edges [Hash] a hash of hashes, edges and their weights from left to right
+  # @param search [Symbol] the augmentation path search type, :shortest_path or :min_cost 
+  # @return [Hash] keys are left vertices, values are right vertices
+  def self.match(left_vertices, right_vertices, edges, search = :shortest_path)
     vertices = left_vertices + right_vertices + [:sink, :source]
 
     edges[:sink] = {}
-    edges[:source] = {}
+    edges[:source] = {} 
 
     left_vertices.each { |lv| edges[:source][lv] = 0 }
     right_vertices.each { |rv| edges[rv] = { :sink => 0 } }
 
     graph = { vertices: vertices, edges: edges }
-    puts graph
-
-    matching = Graphmatch::Maxflow.best_matching! graph
-    puts "Created matching"
-    puts matching
 
-    matching
+    matching = Maxflow.best_matching! graph, search = search
   end
 end
 

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: graphmatch
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Paul Hemberger
@@ -10,9 +10,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-02-23 00:00:00.000000000 Z
 dependencies: []
-description: An implementation of the Ford-Fulkerson max-flow algorithm
+description: An implementation of the Ford-Fulkerson max-flow algorithm.Supports maximum
+  flow as well as minimum-cost maximum flow.
 email: pwh@mit.edu
 executables: []
 extensions: []
@@ -34,9 +35,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -44,3 +45,4 @@ signing_key:
 specification_version: 3
 summary: Optimal bipartite graph matching
 test_files: []
+has_rdoc: