kmeans 0.0.1

data/doc/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/doc/ChangeLog

@@ -0,0 +1,5 @@
+=== 0.0.1 / 2012-10-08
+
+* First release.
+
+

data/doc/LICENSE

@@ -0,0 +1,8 @@
+You can redistribute it and/or modify it under either the terms of the GPL
+version 3, or LGPL version 3 (Dual License).
+
+See the file doc/COPYING or doc/COPYING.LESSER.
+
+Copyright (c) 774 All Rights Reserved.
+Web: http://id774.net
+E-Mail: 774@id774.net

data/doc/README

@@ -0,0 +1,19 @@
+kmeans
+
+Name
+ k-means clustering
+
+Syntax
+ require 'kmeans'
+
+Description
+ http://en.wikipedia.org/wiki/K-means_clustering
+
+
+============
+Installation
+============
+
+$ gem install kmeans
+
+

data/kmeans.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "kmeans"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["id774"]
+  s.date = "2012-10-07"
+  s.description = "K-means clustering"
+  s.email = "idnanashi@gmail.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "doc/AUTHORS",
+    "doc/COPYING",
+    "doc/COPYING.LESSER",
+    "doc/ChangeLog",
+    "doc/LICENSE",
+    "doc/README",
+    "kmeans.gemspec",
+    "lib/kmeans.rb",
+    "lib/kmeans/cluster.rb",
+    "lib/kmeans/pair.rb",
+    "lib/kmeans/pearson.rb",
+    "script/.gitkeep",
+    "spec/lib/kmeans/cluster_spec.rb",
+    "spec/lib/kmeans/pair_spec.rb",
+    "spec/lib/kmeans/pearson_spec.rb",
+    "spec/lib/kmeans_spec.rb",
+    "spec/spec_helper.rb",
+    "vendor/.gitkeep"
+  ]
+  s.homepage = "http://github.com/id774/kmeans"
+  s.licenses = ["GPL"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "kmeans"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/lib/kmeans.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+module Kmeans
+  VERSION = "0.0.1"
+  ROOT_DIR = File.expand_path("..", File.dirname(__FILE__))
+  $:.unshift ROOT_DIR
+  $:.unshift ROOT_DIR + '/lib'
+  $:.unshift ROOT_DIR + '/lib/kmeans'
+
+  require 'cluster'
+end

data/lib/kmeans/cluster.rb

@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+
+require 'pair'
+require 'pearson'
+
+module Kmeans
+  class Cluster
+    def initialize(word_counts, user_options = {})
+      @word_counts = word_counts
+      @min_and_max = {}
+      @centroids = {}
+      @cluster = Hash.new {|hash, key| hash[key] = []}
+      @options = {
+        :centroids => 4,
+        :loop_max => 100
+      }.merge(user_options)
+    end
+
+    attr_reader :cluster
+
+    def make_cluster
+      @min_and_max = min_and_max_in_word_counts
+      @centroids = random_centroids
+
+      loop_counter = 0
+      old_centroids = nil
+      until (@centroids == old_centroids) or (@options[:loop_max] < loop_counter)
+        loop_counter += 1
+        attach_urls_to_nearest_centroid
+        old_centroids = Marshal.load(Marshal.dump(@centroids))
+
+        @centroids.each_key {|centroid|
+          @centroids[centroid] = average_attached(centroid) if @cluster[centroid].any?
+        }
+      end
+    end
+
+    private
+    def min_and_max_in_word_counts
+      all_counts = Hash.new {|hash, key| hash[key] = []}
+      min_and_max = {}
+
+      @word_counts.each {|url, counts|
+        counts.each {|word, count|
+          all_counts[word] << count
+        }
+      }
+
+      all_counts.each {|word, counts|
+        min_and_max[word] = Pair.new [counts.min, counts.max]
+      }
+      min_and_max
+    end
+
+    def random_centroids
+      centroids = {}
+
+      @options[:centroids].times {|centroid|
+        random_counts = {}
+        @min_and_max.each {|word, counts|
+          random_counts[word] = rand(counts.max - counts.min) + counts.min
+        }
+        centroids[centroid] = random_counts
+      }
+      centroids
+    end
+
+    def attach_urls_to_nearest_centroid
+      @cluster.clear
+
+      @word_counts.each_key {|url|
+        @cluster[nearest_centroid(url)] << url
+      }
+    end
+
+    def nearest_centroid(url)
+      correlations = @centroids.map {|centroid, centroid_word_count|
+        web_counts = []
+        centroid_counts = []
+
+        @word_counts[url].each {|word, count|
+          web_counts << count
+          centroid_counts << centroid_word_count[word]
+        }
+        1 - Pearson.calc(web_counts, centroid_counts)
+      }
+      correlations.rindex(correlations.min { |x, y| x.abs <=> y.abs })
+    end
+
+    def average_attached(centroid)
+      average_word_counts = @cluster[centroid].map {|url|
+        @centroids[centroid].keys.map {|word| @word_counts[url][word]}
+      }.transpose.map {|all_counts|
+        all_counts.inject(0) { |sum, count| sum + count }.quo(all_counts.size)
+      }
+      Hash[*@centroids[centroid].keys.zip(average_word_counts).flatten]
+    end
+  end
+end

data/lib/kmeans/pair.rb

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+module Kmeans
+  class Pair < Array
+    def initialize(*args)
+      super
+      slice!(2, (size - 2))
+    end
+
+    alias_method :original_eql?, :eql?
+    alias_method :original_hash, :hash
+
+    def eql?(other)
+      sort.original_eql?(other.sort)
+    end
+
+    def hash
+      sort.original_hash
+    end
+
+    alias == eql?
+    alias left first
+    alias right last
+  end
+end

data/lib/kmeans/pearson.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+
+module Kmeans
+  class Pearson
+    def self.calc(v1,v2)
+      v1 = [v1] if v1.class != Array
+      v2 = [v2] if v2.class != Array
+
+      sum1 = 0
+      v1.each{|n|
+        sum1 += n
+      }
+      sum2 = 0
+      v2.each{|n|
+        sum2 += n
+      }
+
+      sum1Sq = 0
+      v1.each{|n|
+        sum1Sq += n*n
+      }
+      sum2Sq = 0
+      v2.each{|n|
+        sum2Sq += n*n
+      }
+
+      pSum = 0
+      for i in 0...v1.length
+        pSum += v1[i]*v2[i]
+      end
+
+      num = pSum - (sum1*sum2/v1.length)
+      den = Math::sqrt((sum1Sq-sum1*sum1/v1.length)*(sum2Sq-sum2*sum2/v1.length))
+      return 0 if den == 0
+      return num/den
+    end
+  end
+end