Integer#frugal?: Document

runpaint · Aug 17, 2009 · d6ceb8d · d6ceb8d
1 parent 97f9ac7
commit d6ceb8d
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/lib/numb/frugal.rb b/lib/numb/frugal.rb
@@ -1,5 +1,15 @@
 # coding: utf-8
 class Integer
+
+  # A frugal number has more digits than the number of digits in its prime
+  # factorization (including exponents).
+  #
+  # Returns true if self is frugal; false otherwise.
+  #
+  #     128.frugal?  #=> true
+  #     256.frugal?  #=> true
+  #     300.frugal?  #=> false
+  #
   def frugal?
     digits.size > prime_division.flatten.reject{|d|d==1}.join.to_i.digits.size
   end