metric_space 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7441e2c577b880b3d511bdd2e726fb1082d111f
+  data.tar.gz: 5897051193d86ae84a6b00ad7c3c742bf660bb06
+SHA512:
+  metadata.gz: ec725f1af4b59acc0ad656800aff00526c3de08ab4104a6a7266320e4fdcda9d8bb511e44ba745b0d1d96a9d514dc02bbec47675b5efe056317a3fb93920ff19
+  data.tar.gz: 0e8599bcc362dbc17eb91f6c8e9fdb892485f350ae2530b0ed41a667e23ba51397488c7bec944219a3075abceb049bc4da2c88b9f8390fdc397e35318ebdea99

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+metric_space

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,13 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) do |array|
+    name = array.last
+    "spec/#{name}_spec.rb"
+  end
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fractal Soft
+
+MIT License
+
+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,29 @@
+# MetricSpace
+
+Count distance between points in selected metric space
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'metric_space'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metric_space
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task default: :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = "--tag fast"
+end

data/lib/metric_space/british_rail.rb

@@ -0,0 +1,35 @@
+module MetricSpace
+  # The British Rail metric (also called the Post Office metric or
+  # the SNCF metric).
+  class BritishRail
+    # Distance between two points in British Rail metrics
+    #
+    #   point1 = {a:2.5, b:5.0, c:1.0}
+    #   point2 = {a:-1.5, b:1.5, c:0.5}
+    #   self.distance(point1, point2) #=> 7.85835781757061
+    #
+    #   point1 = {b:1.0, c:2.5, d:5.0}
+    #   point2 = {a:-1.5, b:3.0, c:-1.5}
+    #   self.distance(point1, point2) #=> 9.353142959975042
+    def self.distance(one, two)
+      first, second = self.normalize(one), self.normalize(two)
+      if first == second
+        Euclidean.distance(one, two)
+      else
+        Euclidean.distance(one, {}) + Euclidean.distance(two, {})
+      end
+    end
+
+    # Normalize point (all coefficients scaled to the largest one)
+    #
+    #   self.normalize({a:2.0, b:1.0, c:0.5}) #=> {a:1.0, b:0.5, c:0.25}
+    #   self.normalize({a:-2.0, b:4.0, c:-1.0}) #=> {a:-0.5, b:1.0, c:-0.25}
+    def self.normalize(point)
+      hash, max = point.dup, point.values.map(&:abs).max
+      hash.each_pair do |index, value|
+        hash[index] = value/max
+      end
+      hash
+    end
+  end
+end

data/lib/metric_space/euclidean.rb

@@ -0,0 +1,23 @@
+module MetricSpace
+  # Euclidean distance or Euclidean metric is the "ordinary" distance
+  # between two points that one would measure with a ruler,
+  # and is given by the Pythagorean formula.
+  class Euclidean < Metric
+    # Distance between two points in Euclidean metrics
+    #
+    #   point1 = {a: 2.5, b: 5.0, c: 1.0}
+    #   point2 = {a:-1.5, b: 1.5, c: 0.5}
+    #   self.distance(point1, point2) #=> 5.338539126015656
+    #
+    #   point1 = {b: 1.0, c: 2.5, d: 5.0}
+    #   point2 = {a:-1.5, b: 3.0, c:-1.5}
+    #   self.distance(point1, point2) #=> 6.87386354243376
+    def self.distance(one, two)
+      array, result = (one.keys + two.keys).uniq, 0.0
+      array.each do |index|
+        result += difference(one, two, index)**2
+      end
+      Math.sqrt(result)
+    end
+  end
+end

data/lib/metric_space/maximum.rb

@@ -0,0 +1,20 @@
+module MetricSpace
+  # Maximum metric, Chebyshev distance, also known as chessboard distance,
+  # since in the game of chess the minimum number of moves needed by a king
+  # to go from one square on a chessboard to another equals the Chebyshev
+  # distance between the centers of the squares
+  class Maximum < Metric
+    # Distance between two points in Maximum (Chebyshev) metrics
+    #
+    #   self.distance({a:2.5, b:5.0, c:1.0}, {a:-1.5, b:1.5, c:0.5}) #=> 4.0
+    #   self.distance({a:-1.5, b:3.0, c:-1.5}, {b:1.0, c:2.5, d:5.0}) #=> 5.0
+    def self.distance(one, two)
+      array, max = (one.keys + two.keys).uniq, 0.0
+      array.each do |index|
+        value = difference(one, two, index)
+        max = value if value > max
+      end
+      max
+    end
+  end
+end

data/lib/metric_space/metric.rb

@@ -0,0 +1,10 @@
+module MetricSpace
+  # Difference between two values in one dimension
+  class Metric
+    protected
+      # Count difference between two points in selected dimension
+      def self.difference(one, two, index)
+        ((one[index] || 0.0) - (two[index] || 0.0)).abs
+      end
+  end
+end

data/lib/metric_space/taxicab.rb

@@ -0,0 +1,20 @@
+module MetricSpace
+  # The name relates to the distance a taxi has to drive in a rectangular street
+  # grid to get from the origin to the point x.
+  class Taxicab
+    # Distance between two points in taxicab metrics
+    #
+    #   self.distance({a:2.5, b:5.0, c:1.0 }, {a:-1.5, b:1.5, c:0.5}) #=> 8.0
+    #   self.distance({b:0.3, c:0.5, d:0.2 }, {a:-0.5, b:0.4, c:-0.4}) #=> 3.0
+    def self.distance(one, two)
+      array, result = (one.keys + two.keys).uniq, 0.0
+      array.each do |item|
+        result += (
+          (one.has_key?(item) ? one[item] : 0.0) -
+          (two.has_key?(item) ? two[item] : 0.0)
+        ).abs
+      end
+      result
+    end
+  end
+end

data/lib/metric_space/version.rb

@@ -0,0 +1,3 @@
+module MetricSpace
+  VERSION = "0.0.1"
+end

data/lib/metric_space.rb

@@ -0,0 +1,9 @@
+require "metric_space/metric"
+require "metric_space/british_rail"
+require "metric_space/euclidean"
+require "metric_space/maximum"
+require "metric_space/taxicab"
+require "metric_space/version"
+
+module MetricSpace
+end

data/metric_space.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metric_space/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "metric_space"
+  spec.version       = MetricSpace::VERSION
+  spec.authors       = ["Aleksander Malaszkiewicz"]
+  spec.email         = ["info@fractalsoft.org"]
+  spec.summary       = %q{Count distance between points in selected metric space}
+  spec.homepage      = "https://github.com/fractalsoft/metric_space"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
+end

data/spec/metric_space/british_rail_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe MetricSpace::BritishRail do
+  let(:klass) { MetricSpace::BritishRail }
+
+  describe ".distance" do
+    [
+      {
+        point1: {a: 3.0, b: 4.0},
+        point2: {a: 8.0, b: 6.0},
+        distance: 15.0
+      },
+      {
+        point1: {a: 3.0, c: 4.0},
+        point2: {a: 8.0, b: 6.0},
+        distance: 15.0
+      },
+      {
+        point1: {a: 4.0, b: 3.0},
+        point2: {a: 8.0, b: 6.0},
+        distance: 5.0
+      },
+      {
+        point1: {a: 4.0, b: -3.0},
+        point2: {a: -8.0, b: 6.0},
+        distance: 15.0
+      },
+      {
+        point1: {a: -1.5, b: 1.5},
+        point2: {a: 1.5, b: -1.5},
+        distance: 3*(2.0**0.5)
+      },
+    ].each do |example|
+      point1, point2, distance = example.values
+      it "should return #{distance} for distance between #{point1} and #{point2}" do
+        klass.distance(point1, point2).round(5).should eq(distance.round(5))
+      end
+    end
+  end
+
+  describe ".normalize" do
+    {
+      {a:2.0, b:1.0, c:0.5} => {a:1.0, b:0.5, c:0.25},
+      {a:-2.0, b:4.0, c:-1.0} => {a:-0.5, b:1.0, c:-0.25}
+    }.each_pair do |input, output|
+      it "should return #{output} for #{input}" do
+        klass.normalize({a:2.0, b:1.0, c:0.5}).should eq({a:1.0, b:0.5, c:0.25})
+      end
+    end
+  end
+end

data/spec/metric_space/euclidean_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe MetricSpace::Euclidean do
+  let(:klass) { MetricSpace::Euclidean }
+  [
+    {
+      point1: {a: 7.25, b: 8.5},
+      point2: {a: 4.25, b: 4.5},
+      distance: 5.0
+    },
+    {
+      point1: {a: 0.5, c: 0.5},
+      point2: {b: 0.4, c: 0.8},
+      distance: 0.5**0.5
+    }
+  ].each do |example|
+    point1, point2, distance = example.values
+    it "should return #{distance} for distance between #{point1} and #{point2}" do
+      klass.distance(point1, point2).round(5).should eq(distance.round(5))
+    end
+  end
+end

data/spec/metric_space/maximum_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe MetricSpace::Maximum do
+  let(:klass) { MetricSpace::Maximum }
+  [
+    {
+      point1: {a: 7.25, b: 8.5, c: 2.0},
+      point2: {a: 4.25, b: 4.5, c: 7.0},
+      distance: 5
+    },
+    {
+      point1: {a: 0.3, c: 0.5},
+      point2: {b: 0.8, c: 0.9},
+      distance: 0.8
+    }
+  ].each do |example|
+    point1, point2, distance = example.values
+    it "should return #{distance} for distance between #{point1} and #{point2}" do
+      klass.distance(point1, point2).round(5).should eq(distance)
+    end
+  end
+end

data/spec/metric_space/taxicab_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe MetricSpace::Taxicab do
+  let(:klass) { MetricSpace::Taxicab }
+  [
+    {
+      point1: {a: -0.25, b: 3.25, c: 0.8},
+      point2: {a: 0.8, b: 1.25, c: 0.5},
+      distance: 3.35
+    },
+    {
+      point1: {a: 0.8, c: 0.5},
+      point2: {b: 0.3, c: 1},
+      distance: 1.6
+    }
+  ].each do |example|
+    point1, point2, distance = example.values
+    it "should return #{distance} for distance between #{point1} and #{point2}" do
+      klass.distance(point1, point2).round(5).should eq(distance)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'metric_space'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: metric_space
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aleksander Malaszkiewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- info@fractalsoft.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/metric_space.rb
+- lib/metric_space/british_rail.rb
+- lib/metric_space/euclidean.rb
+- lib/metric_space/maximum.rb
+- lib/metric_space/metric.rb
+- lib/metric_space/taxicab.rb
+- lib/metric_space/version.rb
+- metric_space.gemspec
+- spec/metric_space/british_rail_spec.rb
+- spec/metric_space/euclidean_spec.rb
+- spec/metric_space/maximum_spec.rb
+- spec/metric_space/taxicab_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fractalsoft/metric_space
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Count distance between points in selected metric space
+test_files:
+- spec/metric_space/british_rail_spec.rb
+- spec/metric_space/euclidean_spec.rb
+- spec/metric_space/maximum_spec.rb
+- spec/metric_space/taxicab_spec.rb
+- spec/spec_helper.rb