rubylabs 0.9.0 → 0.9.1

data/lib/sievelab.rb

@@ -1,35 +1,43 @@
-
+module RubyLabs
+  
 =begin rdoc
   
 == Sieve of Eratosthenes
 
-Use the Sieve of Eratosthenes algorithm to generate a list of prime
-numbers.  The method is an introduction to iteration, using iterators
-to make and filter lists of numbers, and a while loop to repeat the
-filtering step until no more composite numbers are left in the worksheet.
-
-=end
+The SieveLab module contains the Ruby code described in Chapter 3
+of <em>Explorations in Computing</em>.
 
-module RubyLabs
-	
-module SieveLab
+The module has only one method, +sieve+, which uses the Sieve of Eratosthenes
+to generate a list of prime number up to a specified maximum value.
+The method is an introduction to iteration, using iterators
+to make and filter lists of numbers.
 
-=begin rdoc
-  Call +sieve(n)+ to create an array of prime numbers between +2+ and +n+  
 =end
+  
+module SieveLab
 
-# :begin :sieve
-	def sieve(n)
-	  worksheet = Array(2..n)
-		primes = []
-	
-	  while worksheet.first < sqrt(n)
-	    primes << worksheet.first
-	    worksheet.delete_if { |x| x % primes.last == 0 }
-	  end
-
-		return primes + worksheet
-	end
+# Create a list of all prime numbers between 2 and +n+.
+#
+# Example:
+#   >> sieve(1000)
+#   => [2, 3, 5, 7, ... 983, 991, 997]
+#
+# :call-seq:
+#   sieve(n) => Array
+#
+#-- 
+# :begin :sieve 
+  def sieve(n)
+    worksheet = Array(2..n)
+    primes = []
+
+    while worksheet.first < sqrt(n)
+      primes << worksheet.first
+      worksheet.delete_if { |x| x % primes.last == 0 }
+    end
+
+    return primes + worksheet
+  end
 # :end :sieve
 
 end # SieveLab