stable_marriage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75eb013fa666c7e0bf2f44c2e566be9038cdc043
+  data.tar.gz: c048c9b0fea7f68473d6f7d54183c8f1effa8923
+SHA512:
+  metadata.gz: 05e7d654750796ea8b08b762b9f284f9f0ff93410171c73590c163784a0dd51e2d7e423e5593145342af584216d209f11b0048f552f2155f973052f03a3ce9a3
+  data.tar.gz: 0403e2c0dfd5b57a06646661d5b3027f255b9cf9dbdae3d4cf94b45ac215974de59592814395989b83a1cdf80d1cacd48500a0ebd640ec00c54fbcd93f0afa60

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in amsi.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    stable_marriage (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  pry-byebug (~> 3.3)
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  stable_marriage!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tom Collier
+
+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,56 @@
+# Stable Marriage
+
+[![Numberphile: Stable Marriage Problem](https://img.youtube.com/vi/Qcv1IqHWAzg/0.jpg)](https://www.youtube.com/watch?v=Qcv1IqHWAzg)
+
+The [Stable Marriage Problem](https://en.wikipedia.org/wiki/Stable_marriage_problem)
+is a mathematical problem that attempts to uniquely match a set of _N_ items
+(classically male suitors) with another set of _N_ items (classically females the
+suitors wish to marry). The final matches are referred to as proposals.
+
+## Gale-Shapely Algorithm
+
+This gem provides a variant of the [Gale-Shapely algorithm](https://en.wikipedia.org/wiki/Stable_marriage_problem#Solution).
+Gale-Shapely guarantees a complete matching (i.e. every suitor is paired with
+exactly one female and vice versa). Though this algorithm assumes every member
+of either group has a complete ranking of the other group. For large populations,
+this is not always practical.
+
+## Variation
+
+The algorithm applied here has 2 primary differences from Gale-Shapely
+
+1. Neither suitors nor suitees need to have a complete ranking of the other set.
+2. The rankings are determined by a symmetrical match score. For example, the match
+score for Alice and Steve is the same as for Steve and Alice. Though scores are
+relative, so Alice's match score for Steve may be her highest scoring match, but
+that same score may only be the fifth highest scoring match for Steve.
+
+Because of these differences, not every suitor or suitee is guaranteed to have
+a proposal. Swapping the suitor and suitee sets can have dramatic effects on the
+final set of proposals.
+
+## Usage
+
+```bash
+gem install stable-marriage
+```
+
+```ruby
+require 'stable_marriage'
+sm = StableMarriage.new
+sm.add_match('Alice', 'Marcus', 0.366)
+sm.add_match('Alice', 'Steve', 0.453)
+sm.add_match('Alice', 'Will', 0.245)
+sm.add_match('Janice', 'Phil', 0.486)
+sm.add_match('Janice', 'Steve', 0.304)
+sm.add_match('Lily', 'Steve', 0.299)
+sm.add_match('Maria', 'Steve', 0.602)
+puts sm.proposals
+# {
+#   "Maria" => "Steve",
+#   "Janice" => "Phil",
+#   "Alice" => "Marcus"
+# }
+
+# Note: neither Lily nor Will were matched in the proposals map
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/stable_marriage/descending_insertion_sort_array.rb

@@ -0,0 +1,17 @@
+class StableMarriage
+  class DescendingInsertionSortArray < Array
+    # @param item [Object] any object that responds to `>`
+    def sorted_insert(item)
+      insertion_index = (0...size).bsearch(&search_proc(item))
+      insert(insertion_index || length, item)
+    end
+
+    private
+
+    def search_proc(item)
+      ->(index) { item > self[index] }
+    end
+  end
+
+  private_constant :DescendingInsertionSortArray
+end

data/lib/stable_marriage/match_maker.rb

@@ -0,0 +1,36 @@
+class StableMarriage
+  class MatchMaker
+    def initialize(match_set)
+      @match_set = match_set
+    end
+
+    def proposals
+      proposals = {}
+      (0...match_set.max_suitor_preferences).each do |round|
+        suitee_proposals = {}
+        match_set.each_suitor_prefs do |suitor, suitor_prefs|
+          if round < suitor_prefs.count && !proposals.key?(suitor)
+            suitee = match_set.suitee_preferred_at(suitor, round)
+            suitee_proposals[suitee] ||= []
+            suitee_proposals[suitee] << suitor
+          end
+        end
+
+        suitee_proposals.each do |suitee, suitors|
+          winning_suitor = match_set.most_preferred(suitee, suitors)
+          proposals[winning_suitor] = suitee
+          suitors.each do |suitor|
+            proposals.delete(suitor) unless suitor == winning_suitor
+          end
+        end
+      end
+
+      proposals
+    end
+
+    private
+
+    attr_reader :match_set
+  end
+  private_constant :MatchMaker
+end

data/lib/stable_marriage/match_set.rb

@@ -0,0 +1,55 @@
+require_relative 'descending_insertion_sort_array'
+require_relative 'preference'
+
+class StableMarriage
+  class MatchSet
+    attr_reader :max_suitor_preferences
+
+    def initialize
+      @suitors = {}
+      @suitees = {}
+      @max_suitor_preferences = 0
+    end
+
+    def add(suitor, suitee, score)
+      suitor_prefs = add_suitor_prefs(suitor)
+      suitee_prefs = add_suitee_prefs(suitee)
+
+      suitor_prefs.sorted_insert(Preference.new(suitee, score))
+      if suitor_prefs.count > max_suitor_preferences
+        @max_suitor_preferences = suitor_prefs.count
+      end
+
+      suitee_prefs.sorted_insert(Preference.new(suitor, score))
+    end
+
+    def each_suitor_prefs(&block)
+      suitors.each(&block)
+    end
+
+    def suitee_preferred_at(suitor, round)
+      suitors[suitor][round].object
+    end
+
+    def most_preferred(suitee, suitors)
+      suitees[suitee].detect do |preference|
+        suitors.include?(preference.object)
+      end.object
+    end
+
+    private
+
+    def add_suitor_prefs(object)
+      suitors[object] ||= DescendingInsertionSortArray.new
+      suitors[object]
+    end
+
+    def add_suitee_prefs(object)
+      suitees[object] ||= DescendingInsertionSortArray.new
+      suitees[object]
+    end
+
+    attr_reader :suitors, :suitees
+  end
+  private_constant :MatchSet
+end

data/lib/stable_marriage/preference.rb

@@ -0,0 +1,27 @@
+class StableMarriage
+  class Preference
+    attr_reader :object, :score
+
+    def initialize(object, score)
+      @object = object
+      @score = score
+    end
+
+    def hash
+      object.hash
+    end
+
+    def ==(other)
+      return false unless other.is_a?(self.class)
+      hash == other.hash
+    end
+    alias_method :eql?, :==
+
+    # Items used in DescendingInsertionSortArray must implement `>`
+    def >(other)
+      score > other.score
+    end
+  end
+
+  private_constant :Preference
+end

data/lib/stable_marriage/version.rb

@@ -0,0 +1,3 @@
+class StableMarriage
+  VERSION = '0.1.0'
+end

data/lib/stable_marriage.rb

@@ -0,0 +1,32 @@
+require_relative 'stable_marriage/match_maker'
+require_relative 'stable_marriage/match_set'
+
+class StableMarriage
+  def initialize
+    @match_set = MatchSet.new
+  end
+
+  # The the matching between the suitor and suitee with the match score.
+  #
+  # @param suitor [Object] the proposal maker in the Gale-Shapely algorithm.
+  #   This party tends to fare better than the suitee in the algorithm.
+  # @param suitee [Object] the proposal acceptor/rejector in the Gale-Shapely
+  #   algorithm.
+  # @param score [Numeric] a numeric representation of the strength of the
+  #   match. A higher score means a better match.
+  def add_match(suitor, suitee, score)
+    match_set.add(suitor, suitee, score)
+  end
+
+  # A map with suitors as keys and suitees as objects
+  #
+  # @return [Hash<Object, Object>] the final matching between suitors and
+  #   suitees.
+  def proposals
+    MatchMaker.new(match_set).proposals
+  end
+
+  private
+
+  attr_reader :match_set
+end

data/stable-marriage.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stable_marriage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stable_marriage'
+  spec.version       = StableMarriage::VERSION
+  spec.authors       = ['Tom Collier']
+  spec.email         = ['tcollier@gmail.com']
+
+  spec.summary       = 'Ruby implementation of a Stable Marriage solver'
+  spec.homepage      = 'https://github.com/tcollier/stable-marriage'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'pry-byebug', '~> 3.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: stable_marriage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Collier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- tcollier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/stable_marriage.rb
+- lib/stable_marriage/descending_insertion_sort_array.rb
+- lib/stable_marriage/match_maker.rb
+- lib/stable_marriage/match_set.rb
+- lib/stable_marriage/preference.rb
+- lib/stable_marriage/version.rb
+- stable-marriage.gemspec
+homepage: https://github.com/tcollier/stable-marriage
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of a Stable Marriage solver
+test_files: []