tcollier-sommelier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7aec6ab221e7b53607609c6a5f7b3f84945461bb
+  data.tar.gz: a759cd1e83e4933366ae5b28d2fffb806d5c8ace
+SHA512:
+  metadata.gz: 43f4525771fec89eb6fc7703eb0503d15439c8c78c4ae5c7867eadcaae80c28ad208cc04818074b51908231de9a06068d58b1a83f0df9c21d06b8823d54c072e
+  data.tar.gz: c39b125857e32674f126970486399b3d9d98d47b44ab2960aade9c7cbcc920db8d6ab71a438094d1881a5ff29149c3ecfed166ae7c65d0b6b9ad306f9828b7af

data/.gitignore

@@ -0,0 +1,2 @@
+coverage/
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require 'spec_helper'

data/CHANGELOG.txt

@@ -0,0 +1,3 @@
+Version 0.1.0, 2018-07-20
+-------------------------
+e66dc58 Initial release with Gale-Shapely variant

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,53 @@
+PATH
+  remote: .
+  specs:
+    tcollier-sommelier (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    json (2.1.0)
+    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)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  pry-byebug (~> 3.3)
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  simplecov (~> 0.16)
+  tcollier-sommelier!
+
+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,66 @@
+# Sommelier
+
+Sommelier provides a solution to a variant of the Stable Marriage problem in
+mathematics. In this gem, the classical suitors are replaced with dishes from a
+restaurant menu and the brides-to-be are wines.
+
+## Stable Marriage Problem
+
+[![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
+
+### Installation
+
+```bash
+gem install tcollier-sommelier
+```
+
+### Example
+
+```ruby
+require 'sommelier'
+sommelier = Sommelier.new
+sommelier.add_match('Asparagus', 'Pinot Noir', 0.366)
+sommelier.add_match('Asparagus', 'Sauvignon Blanc', 0.453)
+sommelier.add_match('Asparagus', 'Chardonnay', 0.245)
+sommelier.add_match('Tofu', 'Rose', 0.486)
+sommelier.add_match('Tofu', 'Sauvignon Blanc', 0.304)
+sommelier.add_match('Eggplant', 'Sauvignon Blanc', 0.299)
+sommelier.add_match('Salmon', 'Sauvignon Blanc', 0.602)
+puts sommelier.pairings
+# {
+#   "Salmon" => "Sauvignon Blanc",
+#   "Tofu" => "Rose",
+#   "Asparagus" => "Pinot Noir"
+# }
+
+# Note: neither "Eggplant" nor "Chardonnay" were matched in the pairings 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/sommelier.rb

@@ -0,0 +1,61 @@
+require_relative 'sommelier/match_maker'
+require_relative 'sommelier/match_catalog'
+
+# Pair off members of one set with members of another, optimizing for the total
+# match score of all pairings. This is similar to how a sommelier may provide
+# a complete set of wine pairings for each dish on a menu.
+#
+# Example:
+#
+#   sommelier = Sommelier.new
+#   sommelier.add_match('Asparagus', 'Pinot Noir', 0.366)
+#   sommelier.add_match('Asparagus', 'Sauvignon Blanc', 0.453)
+#   sommelier.add_match('Asparagus', 'Chardonnay', 0.245)
+#   sommelier.add_match('Tofu', 'Rose', 0.486)
+#   sommelier.add_match('Tofu', 'Sauvignon Blanc', 0.304)
+#   sommelier.add_match('Eggplant', 'Sauvignon Blanc', 0.299)
+#   sommelier.add_match('Salmon', 'Sauvignon Blanc', 0.602)
+#   puts sommelier.pairings
+#   # {
+#   #   "Salmon" => "Sauvignon Blanc",
+#   #   "Tofu" => "Rose",
+#   #   "Asparagus" => "Pinot Noir"
+#   # }
+#
+#   # Note: neither "Eggplant" nor "Chardonnay" were matched in the pairings map
+#
+class Sommelier
+  def initialize
+    @match_catalog = MatchCatalog.new
+  end
+
+  # Include a potential pairing between the dish and wine. The pairing has a
+  # score (a higher score means a better pairing) that is used the generate
+  # preferences of dish => wines and wine => dishes. These preferences are used
+  # in a variant of the Gale-Shapely algorithm.
+  #
+  # Since the dishes are acting as the suitors (in Gale-Shapely terminology),
+  # they tend to get better preferred wines than vice versa. However, since a
+  # pairing is symmetrical, passing the wines in as the dish and the dishes in
+  # as the wine will work, but yield potentially different pairings.
+  #
+  # @param dish [Object] the proposal maker in the Gale-Shapely algorithm.
+  # @param wine [Object] the proposal acceptor/rejector in the Gale-Shapely
+  #   algorithm.
+  # @param score [Numeric] a numeric representation of the strength of the
+  #   pairing. A higher score means a better paring.
+  def add_match(dish, wine, score)
+    match_catalog.add(dish, wine, score)
+  end
+
+  # A map with dishes as keys and wines as objects
+  #
+  # @return [Hash<Object, Object>] the final matching between dishes and wines.
+  def pairings
+    MatchMaker.new(match_catalog).pairings
+  end
+
+  private
+
+  attr_reader :match_catalog
+end

data/lib/sommelier/descending_insertion_sort_array.rb

@@ -0,0 +1,22 @@
+class Sommelier
+  # An extension of the ruby built-in Array class with an optimization for
+  # insertion sort. This class assumes the array elements are sorted in
+  # descending order.
+  class DescendingInsertionSortArray < Array
+    # Insert `item` just before the element with the highest value that is lower
+    # than the value of `item`
+    #
+    # @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/sommelier/match_catalog.rb

@@ -0,0 +1,75 @@
+require_relative 'descending_insertion_sort_array'
+require_relative 'preference'
+
+class Sommelier
+  # A collection of all matches to consider for pairing up dishes and wines.
+  class MatchCatalog
+    attr_reader :max_dish_preferences
+
+    def initialize
+      @dishes = {}
+      @wines = {}
+      @max_dish_preferences = 0
+    end
+
+    # Add a symmetrical match for the dish and wine
+    #
+    # @param dish [Object] the dish
+    # @param wine [Object] the wine
+    # @param score [Number] a number dictating the strength of the match between
+    #   the dish and wine (a higher number indicate a stronger match)
+    def add(dish, wine, score)
+      dish_prefs = add_dish_prefs(dish)
+      wine_prefs = add_wine_prefs(wine)
+
+      dish_prefs.sorted_insert(Preference.new(wine, score))
+      if dish_prefs.count > max_dish_preferences
+        @max_dish_preferences = dish_prefs.count
+      end
+
+      wine_prefs.sorted_insert(Preference.new(dish, score))
+    end
+
+    # @yield dish, preferences_count [Object, Integer] yield each dish and the
+    #   number of wines in it's preference list.
+    def each_dish(&block)
+      dishes.each do |dish, prefs|
+        yield dish, prefs.count
+      end
+    end
+
+    # @param dish [Object] the dish to find the wine for
+    # @param rank [Integer] the 0-based rank in the dish's preferences
+    # @return [Object] return the Nth ranked wine based on the given dishes
+    #   preferences
+    def wine_preferred_at(dish, rank)
+      dishes[dish][rank].object
+    end
+
+    # Return the highest ranked dish (for the wine) in the list of dishes
+    #
+    # @param wine [Object]
+    # @param dishes [Array<Object>]
+    # @return [Object] the highest ranked dish in the list
+    def most_preferred_dish(wine, dishes)
+      wines[wine].detect do |preference|
+        dishes.include?(preference.object)
+      end.object
+    end
+
+    private
+
+    def add_dish_prefs(object)
+      dishes[object] ||= DescendingInsertionSortArray.new
+      dishes[object]
+    end
+
+    def add_wine_prefs(object)
+      wines[object] ||= DescendingInsertionSortArray.new
+      wines[object]
+    end
+
+    attr_reader :dishes, :wines
+  end
+  private_constant :MatchCatalog
+end

data/lib/sommelier/match_maker.rb

@@ -0,0 +1,43 @@
+require_relative 'match_maker/generator'
+require_relative 'match_maker/decider'
+
+class Sommelier
+  # Implementation of a variation of the Gale-Shapely algorithm. In this
+  # variation, every dish that isn't currently in a pairing and hasn't exhausted
+  # its list of preferred wines will attempt a pairing with its highest
+  # matching wine that it has not yet attempt to pair with.
+  #
+  # Once all of the pairings for a round are made, then wines will accept
+  # only the highest matching dish that has attempted to pair with it. It will
+  # reject all others, even if it had previously accepted the pairing in a prior
+  # round.
+  class MatchMaker
+    def initialize(match_catalog)
+      @match_catalog = match_catalog
+    end
+
+    # Return a set of pairings. Given that not all of the Gale-Shapely
+    # constraints must've been met, this is not guaranteed to include every
+    # dish or every wine.
+    #
+    # @return [Hash<Object, Object>] a mapping of dish to wine pairings
+    def pairings
+      accepted = {}
+      reversed = {}
+
+      generator = Generator.new(match_catalog)
+      decider = Decider.new(match_catalog)
+      (0...match_catalog.max_dish_preferences).each do |round|
+        requests = generator.requests(round, accepted)
+        decider.decide!(requests, accepted, reversed)
+      end
+
+      accepted
+    end
+
+    private
+
+    attr_reader :match_catalog
+  end
+  private_constant :MatchMaker
+end

data/lib/sommelier/match_maker/decider.rb

@@ -0,0 +1,39 @@
+class Sommelier
+  class MatchMaker
+    class Decider
+      def initialize(match_catalog)
+        @match_catalog = match_catalog
+      end
+
+      # Decide a single dish's pairing request to accept for each wine
+      #
+      # @param requests [Hash<Object, Array<Object>>] mapping of wines to
+      #   the list of dishes that have requested pairing in the current round
+      # @param accepted [Hash<Object, Object>] mapping of dishes to the wine
+      #   that has accepted its pairing request
+      # @param reversed [Hash<Object, Object>] mapping of wines to the dish
+      #   that has its pairing request accepted by wine
+      def decide!(requests, accepted, reversed)
+        requests.each do |wine, current_dishes|
+          # Be sure to consider the full set of current dishes and potentially
+          # a dish from a prior round who had its pairing request accepted by
+          # the wine.
+          prior_accepted_dish = reversed[wine]
+          dishes = current_dishes + [*prior_accepted_dish]
+          winning_dish = match_catalog.most_preferred_dish(wine, dishes)
+
+          if prior_accepted_dish != winning_dish
+            accepted.delete(prior_accepted_dish)
+            accepted[winning_dish] = wine
+            reversed[wine] = winning_dish
+          end
+        end
+      end
+
+      private
+
+      attr_reader :match_catalog
+    end
+    private_constant :Decider
+  end
+end

data/lib/sommelier/match_maker/generator.rb

@@ -0,0 +1,37 @@
+class Sommelier
+  class MatchMaker
+    class Generator
+      def initialize(match_catalog)
+        @match_catalog = match_catalog
+      end
+
+      # Generate all of the requested pairings for a single round of the
+      # algorithm. Each dish that isn't currently locked in a pairing from a
+      # prior round and hasn't exhausted its list of preferred wines will
+      # request a pairing with the highest matching wine it has not yet
+      # requested.
+      #
+      # @param round [Integer] the round number
+      # @param accepted [Hash<Object, Object>] mapping of dishes to the wine
+      #   that has accepted his pairing
+      # @return [Hash<Object, Array<Object>>] mapping of wines to the list of
+      #   dishes that have requested pairings in the current round
+      def requests(round, accepted)
+        requests = {}
+        match_catalog.each_dish do |dish, preferences_count|
+          if round < preferences_count && !accepted.key?(dish)
+            wine = match_catalog.wine_preferred_at(dish, round)
+            requests[wine] ||= []
+            requests[wine] << dish
+          end
+        end
+        requests
+      end
+
+      private
+
+      attr_reader :match_catalog
+    end
+    private_constant :Generator
+  end
+end

data/lib/sommelier/preference.rb

@@ -0,0 +1,18 @@
+class Sommelier
+  # Simple class to bind a score (useable for ranking/sorting) to a generic
+  # object.
+  class Preference
+    attr_reader :object, :score
+
+    def initialize(object, score)
+      @object = object
+      @score = score
+    end
+
+    # Items used in DescendingInsertionSortArray must implement `>`
+    def >(other)
+      score > other.score
+    end
+  end
+  private_constant :Preference
+end

data/lib/sommelier/version.rb

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

data/sommelier.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sommelier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tcollier-sommelier'
+  spec.version       = Sommelier::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/sommelier'
+  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'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: tcollier-sommelier
+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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: 
+email:
+- tcollier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.txt
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/sommelier.rb
+- lib/sommelier/descending_insertion_sort_array.rb
+- lib/sommelier/match_catalog.rb
+- lib/sommelier/match_maker.rb
+- lib/sommelier/match_maker/decider.rb
+- lib/sommelier/match_maker/generator.rb
+- lib/sommelier/preference.rb
+- lib/sommelier/version.rb
+- sommelier.gemspec
+homepage: https://github.com/tcollier/sommelier
+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: []