hierclust 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,10 @@
+== 0.1.1 2008-02-04
+
+* 1 minor enhancement:
+  * add method for returning flattened list of points in a cluster
+* 1 bugfix:
+  * correct intermittent failure of Clusterer spec
+
 == 0.1.0 2008-02-01
 
 * 1 major enhancement:

data/lib/hierclust/cluster.rb

@@ -29,6 +29,12 @@ module Hierclust
       @items.size
     end
     
+    # Returns a flat list of all the points contained in either this cluster
+    # or any of the clusters it contains.
+    def points
+      @items.map {|item| item.points}.flatten
+    end
+    
     # Returns +true+ if this Cluster includes the given +item+, otherwise
     # returns +false+.
     def include?(item)

data/lib/hierclust/point.rb

@@ -18,6 +18,11 @@ module Hierclust
       1
     end
     
+    # Simplifies code by letting us treat Clusters and Points interchangeably
+    def points #:nodoc:
+      self
+    end
+    
     # Returns a legible representation of this Point.
     def to_s
       "(#{x}, #{y})"

data/lib/hierclust/version.rb

@@ -2,7 +2,7 @@ module Hierclust #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/hierclust/cluster_spec.rb

@@ -39,6 +39,7 @@ module Hierclust
       @p_1 = Point.new(@x_1, @y_1)
       @p_2 = Point.new(@x_2, @y_2)
       @c = Cluster.new([@p_1, @p_2])
+      @points = @c.points
     end
 
     it "should have x-coordinate at average of point's x-coordinates" do
@@ -48,5 +49,13 @@ module Hierclust
     it "should have y-coordinate at average of point's y-coordinates" do
       @c.y.should == 6
     end
+
+    it "should have two points" do
+      @points.size.should == 2
+    end
+
+    it "should include both points" do
+      @points.should include(@p_1, @p_2)
+    end
   end
 end

data/spec/hierclust/clusterer_spec.rb

@@ -1,167 +1,183 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
 
 module Hierclust
-  describe Clusterer, " with no data" do
-    before do
-      @c = Clusterer.new([])
-    end
-
-    it "should return no clusters" do
-      @c.clusters.should == []
-    end
-  end
-
-  describe Clusterer, " with one point" do
-    before do
-      @x = 1
-      @y = 2
-      @p = Point.new(@x, @y)
-      @c = Clusterer.new([@p])
-    end
-
-    it "should return the point" do
-      @c.clusters.should == [@p]
-    end
-  end
-
-  describe Clusterer, " with two points" do
-    before do
-      @x_1, @x_2 = 1, 5
-      @y_1, @y_2 = 2, 8
-      @p_1 = Point.new(@x_1, @y_1)
-      @p_2 = Point.new(@x_2, @y_2)
-      @c = Clusterer.new([@p_1, @p_2])
-    end
-
-    it "should return one cluster" do
-      @c.clusters.size.should == 1
-    end
-
-    it "should have two points in the cluster" do
-      @c.clusters.first.size.should == 2
-    end
-
-    it "should have the first point in the cluster" do
-      @c.clusters.first.should include(@p_1)
-    end
-
-    it "should have the second point in the cluster" do
-      @c.clusters.first.should include(@p_2)
-    end
-  end
-
-  describe Clusterer, " with three points" do
-    before do
-      @x_1, @x_2, @x_3 = 1, 5, 2
-      @y_1, @y_2, @y_3 = 2, 6, 3
-      @p_1 = Point.new(@x_1, @y_1)
-      @p_2 = Point.new(@x_2, @y_2)
-      @p_3 = Point.new(@x_3, @y_3)
-      @c = Clusterer.new([@p_1, @p_2, @p_3])
-      @cluster = @c.clusters.first
-      @clusters = @cluster.items.sort_by{|c|c.size}
-    end
-
-    it "should return one cluster" do
-      @c.clusters.size.should == 1
-    end
-
-    it "containing two items" do
-      @cluster.items.size.should == 2
-    end
-
-    it "should have one Cluster" do
-      @clusters[1].class.should == Cluster
-    end
-
-    it "and one Point" do
-      @clusters[0].class.should == Point
-    end
-
-    it "should have the first and third points in the bigger cluster" do
-      @clusters[1].should include(@p_1, @p_3)
-    end
-
-    it "should have the second point in the smaller cluster" do
-      @clusters[0].should == @p_2
-    end
-  end
-
-  FOUR_P = [
-    Point.new(0, 1),
-    Point.new(1, 0),
-    Point.new(3, 4),
-    Point.new(4, 3),
-  ]
-  
-  describe Clusterer, " with four points and no separation" do
-    before do
-      @c = Clusterer.new(FOUR_P)
-    end
-
-    it "should return one cluster" do
-      @c.clusters.size.should == 1
-    end
-  end
-
-  describe Clusterer, " with four points and separation 1" do
-    before do
-      @c = Clusterer.new(FOUR_P, 1)
-    end
-
-    it "should return all four individual points" do
-      @c.clusters.size.should == 4
-    end
-  end
-
-  describe Clusterer, " with four points and separation 2" do
-    before do
-      @c = Clusterer.new(FOUR_P, 2)
-    end
-
-    it "should return two clusters" do
-      @c.clusters.size.should == 2
-    end
-  end
-
-  EIGHT_P = [
-    Point.new(0, 1),
-    Point.new(1, 0),
-    Point.new(3, 4),
-    Point.new(4, 3),
-    Point.new(7, 8),
-    Point.new(8, 7),
-    Point.new(8, 9),
-    Point.new(9, 8),
-  ]
+  describe Clusterer do
+    describe "with no data" do
+      before do
+        @c = Clusterer.new([])
+      end
+
+      it "should return no clusters" do
+        @c.clusters.should == []
+      end
+    end
+
+    describe "with one point" do
+      before do
+        @x = 1
+        @y = 2
+        @p = Point.new(@x, @y)
+        @c = Clusterer.new([@p])
+      end
+
+      it "should return the point" do
+        @c.clusters.should == [@p]
+      end
+    end
+
+    describe "with two points" do
+      before do
+        @x_1, @x_2 = 1, 5
+        @y_1, @y_2 = 2, 8
+        @p_1 = Point.new(@x_1, @y_1)
+        @p_2 = Point.new(@x_2, @y_2)
+        @c = Clusterer.new([@p_1, @p_2])
+      end
+
+      it "should return one cluster" do
+        @c.clusters.size.should == 1
+      end
+
+      it "should have two points in the cluster" do
+        @c.clusters.first.size.should == 2
+      end
+
+      it "should have the first point in the cluster" do
+        @c.clusters.first.should include(@p_1)
+      end
+
+      it "should have the second point in the cluster" do
+        @c.clusters.first.should include(@p_2)
+      end
+    end
+
+    describe "with three points" do
+      before do
+        @x_1, @x_2, @x_3 = 1, 5, 2
+        @y_1, @y_2, @y_3 = 2, 6, 3
+        @p_1 = Point.new(@x_1, @y_1)
+        @p_2 = Point.new(@x_2, @y_2)
+        @p_3 = Point.new(@x_3, @y_3)
+        @c = Clusterer.new([@p_1, @p_2, @p_3])
+        @cluster = @c.clusters.first
+        @clusters = @cluster.items.sort_by{|c|c.size}
+      end
+
+      it "should return one cluster" do
+        @c.clusters.size.should == 1
+      end
+
+      it "containing two items" do
+        @cluster.items.size.should == 2
+      end
+
+      it "should have one Cluster" do
+        @clusters[1].class.should == Cluster
+      end
+
+      it "and one Point" do
+        @clusters[0].class.should == Point
+      end
+
+      it "should have the first and third points in the bigger cluster" do
+        @clusters[1].should include(@p_1, @p_3)
+      end
+
+      it "should have the second point in the smaller cluster" do
+        @clusters[0].should == @p_2
+      end
+    end
+
+    describe "with four points" do
+      before do
+        @points = [
+          Point.new(0, 1),
+          Point.new(1, 0),
+          Point.new(3, 4),
+          Point.new(4, 3),
+        ]
+      end
+
+      describe "and no separation" do
+        before do
+          @c = Clusterer.new(@points)
+        end
+
+        it "should return one cluster" do
+          @c.clusters.size.should == 1
+        end
+      end
+
+      describe "and separation 1" do
+        before do
+          @c = Clusterer.new(@points, 1)
+        end
+
+        it "should return all four individual points" do
+          @c.clusters.size.should == 4
+        end
+      end
+
+      describe "and separation 2" do
+        before do
+          @c = Clusterer.new(@points, 2)
+        end
+
+        it "should return two clusters" do
+          @c.clusters.size.should == 2
+        end
+      end
+    end
+
+    describe "with eight points" do
+      before do
+        @points = [
+          Point.new(0, 1),
+          Point.new(1, 0),
+          Point.new(3, 4),
+          Point.new(4, 3),
+          Point.new(7, 8),
+          Point.new(8, 7),
+          Point.new(8, 9),
+          Point.new(9, 8),
+        ]
+      end
   
-  describe Clusterer, " with eight points and no separation" do
-    before do
-      @c = Clusterer.new(EIGHT_P)
-    end
-
-    it "should return one cluster when no minimum separation is given" do
-      @c.clusters.size.should == 1
-    end
-  end
-
-  describe Clusterer, " with eight points and separation 1" do
-    before do
-      @c = Clusterer.new(EIGHT_P, 1)
-    end
-
-    it "should return all eight individual points" do
-      @c.clusters.size.should == 8
-    end
-  end
-
-  describe Clusterer, " with eight points and separation 2" do
-    before do
-      @c = Clusterer.new(EIGHT_P, 2)
-    end
-
-    it "should return three clusters" do
-      @c.clusters.size.should == 3
+      describe "and no separation" do
+        before do
+          @clusters = Clusterer.new(@points).clusters.sort
+        end
+
+        it "should return one cluster when no minimum separation is given" do
+          @clusters.size.should == 1
+        end
+      end
+
+      describe "and separation 1" do
+        before do
+          @clusters = Clusterer.new(@points, 1).clusters.sort
+        end
+
+        it "should have all eight points in individual clusters" do
+          @clusters.size.should == 8
+        end
+      end
+
+      describe "and separation 3" do
+        before do
+          @clusters = Clusterer.new(@points, 3).clusters.sort
+        end
+
+        it "should have three clusters" do
+          @clusters.size.should == 3
+        end
+
+        it "should have clusters size 2, 2, and 4 " do
+          @clusters[0].points.size.should == 2
+          @clusters[1].points.size.should == 2
+          @clusters[2].points.size.should == 4
+        end
+      end
     end
   end
 end

data/tasks/rspec.rake

@@ -1,20 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
 begin
   require 'spec/rake/spectask'
 rescue LoadError
-  begin
-    require 'rubygems'
-    require 'spec/rake/spectask'
-  rescue LoadError
-    puts <<-EOS
+  puts <<-EOS
 To use rspec for testing you must install rspec gem:
     gem install rspec
 EOS
-    exit(0)
-  end
+  exit(0)
 end
 
-desc "Run the specs under spec/"
+desc "Run the specs under spec/models"
 Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ['--options', "spec/spec.opts"]
-  t.spec_files = FileList['spec/*_spec.rb']
+  t.spec_files = FileList['spec/**/*_spec.rb']
 end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>Simple Hierarchical Clustering</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/hierclust"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/hierclust" class="numbers">0.1.0</a>
+      <a href="http://rubyforge.org/projects/hierclust" class="numbers">0.1.1</a>
     </div>
     <h1>&#x2192; &#8216;hierclust&#8217;</h1>
 
@@ -110,19 +110,31 @@ to your data:</p>
 <span class="keyword">end</span></pre></p>
 
 
+	<h2>Documentaion</h2>
+
+
+	<p><span class="caps">API</span> documentation: <a href="rdoc/">RDoc</a></p>
+
+
 	<h2>Forum</h2>
 
 
 	<p><a href="http://groups.google.com/group/hierclust">http://groups.google.com/group/hierclust</a></p>
 
 
-	<h2>How to submit patches</h2>
+	<h2>Source code</h2>
 
 
-	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+	<p>The trunk repository is <code>svn://rubyforge.org/var/svn/hierclust/trunk</code> for anonymous access.</p>
 
 
-	<p>The trunk repository is <code>svn://rubyforge.org/var/svn/hierclust/trunk</code> for anonymous access.</p>
+	<p>You can also browse the source online at <a href="http://hierclust.rubyforge.org/svn/trunk/">http://hierclust.rubyforge.org/svn/trunk/</a></p>
+
+
+	<h2>How to submit patches</h2>
+
+
+	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
 
 
 	<h2>License</h2>
@@ -134,9 +146,9 @@ to your data:</p>
 	<h2>Contact</h2>
 
 
-	<p>Comments are welcome. Send an email to <a href="mailto:FIXME"><span class="caps">FIXME</span> full name</a> email via the <a href="http://groups.google.com/group/hierclust">forum</a></p>
+	<p>Comments are welcome. Send an email to <a href="mailto:brandt@kurowski.net">Brandt Kurowski</a> email via the <a href="http://groups.google.com/group/hierclust">forum</a></p>
     <p class="coda">
-      <a href="FIXME email">FIXME full name</a>, 2nd February 2008<br>
+      <a href="http://brandt.kurowski.net/">Brandt Kurowski</a>, 4th February 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -56,21 +56,29 @@ clusters.each do |cluster|
   )
 end</pre>
 
+h2. Documentaion
+
+API documentation: "RDoc":rdoc/
+
 h2. Forum
 
 "http://groups.google.com/group/hierclust":http://groups.google.com/group/hierclust
 
+h2. Source code
+
+The trunk repository is <code>svn://rubyforge.org/var/svn/hierclust/trunk</code> for anonymous access.
+
+You can also browse the source online at "http://hierclust.rubyforge.org/svn/trunk/":http://hierclust.rubyforge.org/svn/trunk/
+
 h2. How to submit patches
 
 Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
 
-The trunk repository is <code>svn://rubyforge.org/var/svn/hierclust/trunk</code> for anonymous access.
-
 h2. License
 
 This code is free to use under the terms of the MIT license. 
 
 h2. Contact
 
-Comments are welcome. Send an email to "FIXME full name":mailto:FIXME email via the "forum":http://groups.google.com/group/hierclust
+Comments are welcome. Send an email to "Brandt Kurowski":mailto:brandt@kurowski.net email via the "forum":http://groups.google.com/group/hierclust
 

data/website/template.rhtml

@@ -37,7 +37,7 @@
     </div>
     <%= body %>
     <p class="coda">
-      <a href="FIXME email">FIXME full name</a>, <%= modified.pretty %><br>
+      <a href="http://brandt.kurowski.net/">Brandt Kurowski</a>, <%= modified.pretty %><br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: hierclust
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-platform: ""
+  version: 0.1.1
+platform: ruby
 authors: 
 - Brandt Kurowski
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-02-02 00:00:00 -05:00
+date: 2008-02-04 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: hierclust
-rubygems_version: 0.9.5
+rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
 summary: performs hierarchical clustering on geometric points