clusto 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Conor Mulligan, Solas.ca
+
+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,16 @@
+Clusto
+======
+
+*Simple Ruby point clustering*
+
+If you're familiar with the [k-means][1] algorithm then Clusto's clustering process will probably be broadly recognisable, although it does take some liberties in the name of performance.
+
+Usage
+-----
+
+```ruby
+points = data.map { |p| Clusto::Point.new(p.x, p.y) }
+clusters = Clusto.cluster(points)
+```
+
+[1]: http://en.wikipedia.org/wiki/K-means_clustering

data/clusto.gemspec

@@ -0,0 +1,9 @@
+Gem::Specification.new do |s|
+  s.name    = 'clusto'
+  s.version = '0.1.0'
+  s.author  = 'Conor Mulligan'
+  s.email   = 'conmulligan@gmail.com'
+  s.summary = 'Simple Ruby point clustering'
+
+  s.files = Dir["#{File.dirname(__FILE__)}/**/*"]
+end

data/lib/clusto.rb

@@ -0,0 +1,81 @@
+require 'clusto/point'
+require 'clusto/cluster'
+require 'clusto/distance'
+
+module Clusto
+  extend self
+
+  INFINITY = +1.0/0
+  RADIANS_PER_DEGREES = Math::PI / 180
+  GREAT_CIRCLE_RADIUS = 6371
+  
+  GRID_SIZE = 8
+
+  def minimum_bounding_rectangle(points)
+    xs = points.collect { |p| p.x }.minmax
+    ys = points.collect { |p| p.y }.minmax
+    
+    [xs[0], ys[0], xs[1], ys[1]]
+  end
+  
+  def cluster(points, options={})
+    bounds = options[:bounds] || Clusto.minimum_bounding_rectangle(points)
+    distance_method = options[:distance_method] || :haversine
+
+    # Create clusters
+    
+    clusters = []
+    
+    x = bounds[0]
+    y = bounds[3]
+    w = bounds[2] - bounds[0]
+    h = bounds[3] - bounds[1]
+    grid_w = w / GRID_SIZE
+    grid_h = h / GRID_SIZE
+    
+    column = 0
+    row = 0
+    
+    (GRID_SIZE ** 2).times do |i|
+      offset_x = x + (column * grid_w)
+      offset_y = y - (row * grid_h)
+      
+      center = Clusto::Point.new(offset_x + (grid_w / 2), offset_y - (grid_h / 2))
+      clusters.push(Clusto::Cluster.new(center))
+      
+      column = column+1
+      if column == GRID_SIZE
+        column = 0
+        row = row+1
+      end
+    end
+    
+    # Assign points to clusters
+    
+    points.each do |point|
+      distance = INFINITY
+      nearest = nil
+
+      clusters.each do |cluster|
+        begin
+          d = Clusto::Distance.send(distance_method, cluster.location, point)
+        rescue NoMethodError
+          raise "Unknown distance method '#{distance_method}."
+        end
+        
+        if d < distance
+          distance = d
+          nearest = cluster
+        end
+      end
+
+      nearest.points.push(point)
+    end
+
+    # Reposition clusters
+    
+    clusters.each do |cluster|
+      cluster.reposition
+    end
+  end
+end

data/lib/clusto/cluster.rb

@@ -0,0 +1,28 @@
+module Clusto
+  class Cluster
+    attr_accessor :location, :points
+  
+    def initialize(location)
+      @location = location
+      @points = []
+    end
+  
+    def reposition
+      return if @points.empty?
+      
+      x = 0
+      y = 0
+      center = @location
+      
+      @points.each do |point|
+        x += point.x
+        y += point.y
+      end
+
+      x /= points.length
+      y /= points.length
+  
+      @location = Clusto::Point.new(x, y)
+    end
+  end
+end

data/lib/clusto/distance.rb

@@ -0,0 +1,19 @@
+module Clusto
+  class Distance
+    def self.euclidian(pa, pb)
+      Math::sqrt((pa.x - pb.x) ** 2 + (pa.y - pb.y) ** 2)
+    end
+    
+    def self.haversine(pa, pb)
+      x = (pb.x - pa.x) * RADIANS_PER_DEGREES
+      y = (pb.y - pa.y) * RADIANS_PER_DEGREES
+      
+      ar = pa.x * RADIANS_PER_DEGREES
+      br = pb.x * RADIANS_PER_DEGREES
+      
+      a = Math.sin(x / 2) ** 2 + Math.cos(ar) * Math.cos(br) * Math.sin(y / 2) ** 2
+      c = 2 * Math.atan2(Math::sqrt(a), Math::sqrt(1 - a))
+      GREAT_CIRCLE_RADIUS * c;
+    end
+  end
+end

data/lib/clusto/point.rb

@@ -0,0 +1,15 @@
+module Clusto
+  class Point
+    attr_accessor :x, :y, :tag
+
+    def initialize(x, y, tag=0)
+      @x = x
+      @y = y
+      @tag = tag
+    end
+    
+    def to_s
+      return "(#{@x}, #{@y})"
+    end
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: clusto
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Conor Mulligan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-13 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: conmulligan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./clusto.gemspec
+- ./lib/clusto/cluster.rb
+- ./lib/clusto/distance.rb
+- ./lib/clusto/point.rb
+- ./lib/clusto.rb
+- ./LICENSE
+- ./README.md
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Simple Ruby point clustering
+test_files: []