rkneufeld-fuzzy-realty 0.1.0 → 0.3.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 1
+:minor: 3
 :patch: 0

data/lib/fuzzy_realty.rb

@@ -1,4 +1,7 @@
 require 'stubs.rb'
+require 'scores_table.rb'
+require 'weights.rb'
+require 'rulebase.rb'
 require 'rulebase.rb'
 
 module FuzzyRealty
@@ -14,26 +17,35 @@ module FuzzyRealty
           change = FuzzyRealty::METHODS[param.type].call(listing,param)
           # if score is bad and parameter is required then reduce it further
           change = (change < 0.70 and param.required) ? (change - 1) : change
+          
           score += change * FuzzyRealty::WEIGHTS[param.type]
         end
-        scores << {listing => score}
+        scores << { :score => score, :listing => listing}
       end
-      return scores
+      return scores.sort {|a,b| b[:score] <=> a[:score]}
     end
   end
-
-  # Have a table of ways to calculate the score modifier
-  # --> i.e. price will allow cheaper, sqft will allow bigger, etc.
 end
 
 if __FILE__ == $0
-  # Creating a library of stub models
-  a = FuzzyRealty::Listing.new({:price => 112000, :sqft => 720, :location => 'A'})
-  b = FuzzyRealty::Listing.new({:price => 142000, :sqft => 1420, :location => 'B'})
+  listings = []
+  10000.times do |i|
+    listings << FuzzyRealty::Listing.new({
+      :price => 20_000 + rand(250_000),
+      :sqft => 300 + rand(2000),
+      :location => %W{A B C D}[rand(4)],
+      :style => %W{Bungalow Bi-level Split-level Two-story Condominium}[rand(5)]
+    })
+  end
   # The user wants price around 110k and in location A, 
-  p1 = FuzzyRealty::Parameter.new(false,:price,110000)
-  p2 = FuzzyRealty::Parameter.new(true,:location, 'A')
-
-  q = FuzzyRealty::Query.new([p1,p2])
-  puts FuzzyRealty::ExpertSystem.scores([a,b],q).inspect
+  parameters = []
+  parameters << FuzzyRealty::Parameter.new(:price,250000)
+  parameters << FuzzyRealty::Parameter.new(:location, 'A',true)
+  parameters << FuzzyRealty::Parameter.new(:style,"Condominium",true)
+  parameters << FuzzyRealty::Parameter.new(:sqft,1575,true)
+  query  = FuzzyRealty::Query.new(parameters)
+  scores = FuzzyRealty::ExpertSystem.scores(listings,query)
+  scores.each do |score| 
+    puts "%.2f" % score[:score] + "\t\t#{score[:listing].inspect}"
+  end
 end

data/lib/rulebase.rb

@@ -1,48 +1,60 @@
 module FuzzyRealty
   METHODS = {
+    # Not yet implemented
+    :bathroom => 1,
+    :garage => 1,
+    :deck => 1,
+    
     # Price is match when desired is 90-105%  of actual. Otherwise give a
     # reduced factor.
     :price => 
       lambda do |listing,param| 
-        actual,desired = param.desired,listing.price.to_f
-        if (desired*0.90..desired*1.05) === actual
-          1
+        puts "Called price"
+        actual,desired = listing.price.to_f, param.desired
+        result = if (desired*0.90..desired*1.05) === actual
+          1.0
         else 
           1 - ((desired - actual) / actual).abs
         end
+        puts result
+        result
       end,
   
     # Location calc. does lookup to find score for desired and actual
     ## Currently just return 1 if exact, 0 otherwise
     :location => 
       lambda do |listing,param|
-        FuzzyRealty::LOCN[param.desired][listing.location]
-      end
-  }
-  
-  # Chosen weights are largely arbitrary. Expert was consulted for relative ratings, 
-  # but as the knowledge engineer I was forced to pick the crisp values. 
-  # Experimentation with larger user groups would likely show specific values to do 
-  # better 
-  WEIGHTS = {
-    :sqft => 15, 
-    :price => 10, 
-    :location => 25
-  }
+        puts "Called location"
+        # Perform a quick lookup (i.e. FuzzyRealty::LOCN[:A][:A] => 1.0)
+        puts FuzzyRealty::LOCN[param.desired.to_sym][listing.location.to_sym]
+        FuzzyRealty::LOCN[param.desired.to_sym][listing.location.to_sym]
+      end,
+      
+    :sqft => 
+      lambda do |listing,param|
+                puts "Called sqft"
+        actual, desired = listing.sqft, param.desired
+        result = if (actual + 50) >= desired
+          1.0
+        elsif (actual + 150) >= desired
+          0.8
+        elsif (actual + 300) >= desired
+          0.5
+        else
+          0.0
+        end
+        puts result
+        result
+      end,
+    # Style's follow lookup table similar to Location
 
-  # A is a high-class suburb
-  # B is a middle-class area
-  # C is an older middle-class area
-  # D is a "ghetto"
-  #   A    B      C   D
-  # A 1.0  0.75  0.2  0.0
-  # B 0.75 1.00  0.4  0.1
-  # C 0.2  0.4   1.0  0.6
-  # D 0.0  0.1   0.6  1.0  
-  LOCN = {
-    'A' => {'A' => 1.0,  'B' => 0.75, 'C' => 0.2, 'D' => 0.0}, 
-    'B' => {'A' => 0.75, 'B' => 1.0,  'C' => 0.4, 'D' => 0.1},
-    'C' => {'A' => 0.2,  'B' => 0.4,  'C' => 1.0, 'D' => 0.6},
-    'D' => {'A' => 0.0,  'B' => 0.1,  'C' => 0.6, 'D' => 1.0}
+    :style => 
+      lambda do |listing,param|
+                puts "Called style"
+        desired = FuzzyRealty::STYLE[:Symbol][param.desired]
+        actual  = FuzzyRealty::STYLE[:Symbol][listing.style]
+        puts FuzzyRealty::STYLE[desired][actual]
+        FuzzyRealty::STYLE[desired][actual]
+      end
   }
 end

data/lib/scores_table.rb

@@ -0,0 +1,39 @@
+module FuzzyRealty
+  # Table for looking up score of relative locations
+  # 
+  # A is a high-class suburb
+  # B is a middle-class area
+  # C is an older middle-class area
+  # D is a "ghetto"
+  #   A    B      C   D
+  # A 1.0  0.75  0.2  0.0
+  # B 0.75 1.00  0.4  0.1
+  # C 0.2  0.4   1.0  0.6
+  # D 0.0  0.1   0.6  1.0  
+  LOCN = {
+    :A => {:A => 1.0,  :B => 0.75, :C => 0.2, :D => 0.0}, 
+    :B => {:A => 0.75, :B => 1.0,  :C => 0.4, :D => 0.1},
+    :C => {:A => 0.2,  :B => 0.4,  :C => 1.0, :D => 0.6},
+    :D => {:A => 0.0,  :B => 0.1,  :C => 0.6, :D => 1.0}
+  }
+
+  # Table for lookup of score of desired and actual styles
+  # - Arbitrary values provied by my wife, at present the leanings aren't quite right
+  #
+  # Bu = Bungalow, Bi = Bilevel, Sp = Splitlevel, Tw = Two Story, Co = Condo
+  #|    |   Bu |  Sp |  Tw |   Bi |  Co |
+  #| Bu |    1 | 0.4 | 0.8 | 0.65 | 0.1 |
+  #| Sp |  0.5 |   1 | 0.7 | 0.95 | 0.2 |
+  #| Tw |  0.0 | 0.6 |   1 |  0.5 | 0.0 |
+  #| Bi | 0.75 | 0.6 | 0.8 |    1 | 0.0 |
+  #| Co |  0.7 | 0.0 | 0.0 |  0.0 |   1 |  
+  STYLE = {
+    :Symbol => {"Bungalow" => :Bu, "Bi-level" => :Bi, "Split-level" => :Sp,
+                "Two-story" => :Tw, "Condominium" => :Co},
+    :Bu => { :Bu => 1,   :Sp => 0.4, :Tw => 0.8, :Bi => 0.65, :Co => 0.1 },
+    :Sp => { :Bu => 0.5, :Sp => 1.0, :Tw => 0.7, :Bi => 0.95, :Co => 0.2 },
+    :Tw => { :Bu => 0.0, :Sp => 0.6, :Tw => 1.0, :Bi => 0.5,  :Co => 0.0 },
+    :Bi => { :Bu => 0.75,:Sp => 0.6, :Tw => 0.8, :Bi => 1.0,  :Co => 0.0 },
+    :Co => { :Bu => 0.7, :Sp => 0.0, :Tw => 0.0, :Bi => 0.0,  :Co => 1.0 }
+  }
+end

data/lib/stubs.rb

@@ -1,6 +1,6 @@
 module FuzzyRealty
   class Listing
-    attr_accessor :price, :sqft, :location
+    attr_accessor :price, :sqft, :location, :style
     def initialize(values={})
       values.each_key {|k| instance_variable_set(:"@#{k}", values[k])}
     end
@@ -14,8 +14,8 @@ module FuzzyRealty
   end
   
   class Parameter
-    attr_accessor :required, :type, :desired
-    def initialize(required,type,desired)
+    attr_accessor :required, :type, :desired, :style
+    def initialize(type,desired,required=false)
       @required,@type,@desired = required, type, desired
     end
   end

data/lib/weights.rb

@@ -0,0 +1,15 @@
+module FuzzyRealty
+  # Chosen weights are largely arbitrary. Expert was consulted for relative ratings, 
+  # but as the knowledge engineer I was forced to pick the crisp values. 
+  # Experimentation with larger user groups would likely show specific values to do 
+  # better 
+  WEIGHTS = {
+    :sqft => 15, 
+    :price => 10, 
+    :location => 25,
+    :style => 18
+  }
+  def self.max_score
+    WEIGHTS.inject(0) {|sum,n| sum + n[1]}
+  end
+end

data/test/fuzzy_realty_test.rb

@@ -1,7 +1,30 @@
 require 'test_helper'
 
 class FuzzyRealtyTest < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  
+  context "Score verification" do
+    setup do
+      @listing = FuzzyRealty::Listing.new({
+          :price => 250_000,
+          :sqft => 1_575,
+          :location => 'A',
+          :style =>  'Condominium'
+        })
+    end
+    
+    should "score perfect for perfect house" do
+      # The user wants price around 110k and in location A, 
+      params = []
+      params << FuzzyRealty::Parameter.new(:price,250_000,true)
+      params << FuzzyRealty::Parameter.new(:location, 'A',true)
+      params << FuzzyRealty::Parameter.new(:style,"Condominium",true)
+      params << FuzzyRealty::Parameter.new(:sqft,1575,true)
+      query  = FuzzyRealty::Query.new(params)
+
+      scores = FuzzyRealty::ExpertSystem.scores([@listing],query)
+      puts "%.2f" % scores[0][:score] + "\t\t#{scores[0][:listing].inspect}"
+      assert_equal(scores[0][:score], FuzzyRealty.max_score)
+    end
   end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rkneufeld-fuzzy-realty
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Ryan Neufeld
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-18 00:00:00 -07:00
+date: 2009-04-19 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -30,7 +30,9 @@ files:
 - lib/TODO
 - lib/fuzzy_realty.rb
 - lib/rulebase.rb
+- lib/scores_table.rb
 - lib/stubs.rb
+- lib/weights.rb
 - test/fuzzy_realty_test.rb
 - test/test_helper.rb
 has_rdoc: true