ruby-nuggets 0.0.4.171 → 0.0.5.179

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to ruby-nuggets version 0.0.4
+This documentation refers to ruby-nuggets version 0.0.5
 
 
 == DESCRIPTION

data/lib/nuggets/array/shuffle.rb

@@ -30,11 +30,28 @@ class Array
   # call-seq:
   #   array.shuffle => new_array
   #
-  # Shuffles _array_ in random order.
+  # Shuffles _array_ in random order. Select a different shuffling algorithm:
+  # <tt>Array.send(:alias_method, :shuffle, :shuffle_kfy)</tt>.
   def shuffle
     sort_by { Kernel.rand }
   end
 
+  # call-seq:
+  #   array.shuffle_knuth => new_array
+  #
+  # Non-destructive version of #shuffle_knuth!.
+  def shuffle_knuth
+    dup.shuffle_knuth!
+  end
+
+  # call-seq:
+  #   array.shuffle_kfy => new_array
+  #
+  # Non-destructive version of #shuffle_kfy!.
+  def shuffle_kfy
+    dup.shuffle_kfy!
+  end
+
   # call-seq:
   #   array.shuffle! => array
   #
@@ -43,6 +60,32 @@ class Array
     replace shuffle
   end
 
+  # call-seq:
+  #   array.shuffle_knuth! => array
+  #
+  # Shuffles _array_ in random order using Knuth's algorithm.
+  def shuffle_knuth!
+    0.upto(length - 2) { |i|
+      n = i + rand(length - i)
+      self[i], self[n] = self[n], self[i]
+    }
+
+    self
+  end
+
+  # call-seq:
+  #   array.shuffle_kfy! => array
+  #
+  # Shuffles _array_ in random order using the Knuth-Fisher-Yates algorithm.
+  def shuffle_kfy!
+    (length - 1).downto(0) { |i|
+      n = rand(i + 1)
+      self[n], self[i] = self[i], self[n]
+    }
+
+    self
+  end
+
 end
 
 if $0 == __FILE__
@@ -52,6 +95,39 @@ if $0 == __FILE__
   p a.shuffle
   p a.shuffle
 
+  p a.shuffle_knuth
+  p a.shuffle_kfy
+
   a.shuffle!
   p a
+
+  require File.join(File.dirname(__FILE__), '..', 'integer', 'factorial')
+  require File.join(File.dirname(__FILE__), '..', 'enumerable', 'minmax')
+
+  a = %w[a b c]
+  n = 100_000
+  m = a.length.f!
+  e = n / m.to_f
+  puts '%d / %d / %d / %.2f' % [a.length, n, m, e]
+
+  algorithms = %w[shuffle shuffle_knuth shuffle_kfy]
+  max = algorithms.max(:length)
+
+  algorithms.each { |algorithm|
+    score = Hash.new { |h, k| h[k] = 0 }
+
+    n.times {
+      score[a.send(algorithm)] += 1
+    }
+
+    x2 = 0
+    score.sort.each { |key, value|
+      x = value - e
+      y = x**2 / e
+      #puts '%s: %d (% .2f/%.2f)' % [key, value, x, y]
+
+      x2 += y
+    }
+    puts "%-#{max}s = %.2f (%.2f)" % [algorithm, x2, x2 / m]
+  }
 end

data/lib/nuggets/array/to_hash.rb

@@ -4,7 +4,7 @@
 # A component of ruby-nuggets, some extensions to the Ruby programming        #
 # language.                                                                   #
 #                                                                             #
-# Copyright (C) 2007 Jens Wille                                               #
+# Copyright (C) 2007-2008 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@uni-koeln.de>                                    #
@@ -32,25 +32,63 @@ class Array
   # call-seq:
   #   array.to_h => aHash
   #   array.to_h(value) => aHash
+  #   array.to_h { |element| ... } => aHash
   #
-  # If no +value+ is given, converts _array_, being an array of two-element
-  # arrays, into a hash, preserving sub-arrays. Otherwise, maps each element
-  # of _array_ to +value+.
+  # If neither +value+ nor block is given, converts _array_, taken as an
+  # array of key/value pairs, into a hash, preserving sub-arrays (Thus:
+  # <tt>hash.to_a.to_h == hash</tt>). Otherwise, maps each element of
+  # _array_ to +value+ or the result of the block.
+  #
+  # NOTE: This is the "nice" version. For a more speed-optimized one,
+  # use #to_hash_opt.
   #
   # Examples:
-  #   %w[a b c d].to_h     # => { "a" => "b", "c" => "d" }
-  #   %w[a b c d].to_h(1)  # => { "a" => 1, "b" => 1, "c" => 1, "d" => 1 }
-  def to_hash(value = default = Object.new)
-    if value == default
-      Hash[*flatten_once]
-    else
+  #   [[0, 0], [1, [2, 3]]].to_h  #=> { 0 => 0, 1 => [2, 3] }
+  #   %w[a b c d].to_h            #=> { "a" => "b", "c" => "d" }
+  #   %w[a b c d].to_h(1)         #=> { "a" => 1, "b" => 1, "c" => 1, "d" => 1 }
+  #   %w[a b].to_h { |e| e * 2 }  #=> { "a" => "aa", "b" => "bb" }
+  def to_hash(value = default = Object.new, &block)
+    if block ||= value != default && lambda { value }
       inject({}) { |hash, element|
-        hash.update(element => value)
+        hash.update(element => block[element])
       }
+    else
+      Hash[*flatten_once]
     end
   end
   alias_method :to_h, :to_hash
 
+  # call-seq:
+  #   array.to_h => aHash
+  #   array.to_h(value) => aHash
+  #   array.to_h { |element| ... } => aHash
+  #
+  # Same as #to_hash, but slightly optimized for speed. To use this one instead
+  # of #to_hash: <tt>Array.send(:alias_method, :to_h, :to_hash_opt)</tt>.
+  #
+  # Benchmark (array = (1..20).to_a, N = 100_000):
+  #                            user     system      total        real
+  #   to_hash: plain       4.820000   0.560000   5.380000 (  5.600390)
+  #   to_hash: value      12.910000   0.930000  13.840000 ( 13.938352)
+  #   to_hash: block      13.590000   1.180000  14.770000 ( 14.810804)
+  #   to_hash_opt: plain   4.910000   0.470000   5.380000 (  5.416949)
+  #   to_hash_opt: value   2.170000   0.390000   2.560000 (  2.609034)
+  #   to_hash_opt: block   7.090000   0.880000   7.970000 (  8.109180)
+  def to_hash_opt(value = default = Object.new, &block)
+    if block
+      hash = {}
+      each { |element| hash[element] = block[element] }
+      hash
+    elsif value != default
+      hash = {}
+      each { |element| hash[element] = value }
+      hash
+    else
+      Hash[*flatten_once]
+    end
+  end
+  #alias_method :to_h, :to_hash_opt
+
 end
 
 if $0 == __FILE__
@@ -64,5 +102,13 @@ if $0 == __FILE__
 
   c = %w[a b c d]
   p c
+  p c.to_h
   p c.to_h(1)
+  p c.to_h { nil }
+
+  h = { :a => 1, :b => [2, 3], :c => { :d => 4}}
+  p h
+  p h.to_a
+  p h.to_a.to_h
+  p h.to_a.to_h == h
 end

data/lib/nuggets/integer/factorial.rb

@@ -0,0 +1,47 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class Integer
+
+  # call-seq:
+  #   int.factorial => anInteger
+  #
+  # Calculate the factorial of +int+.
+  def factorial
+    (1..self).inject { |f, i| f * i }
+  end
+
+  alias_method :fac, :factorial
+  alias_method :f!,  :factorial
+
+end
+
+if $0 == __FILE__
+  1.upto(8) { |i|
+    puts "#{i}: #{i.factorial}"
+  }
+end

data/lib/nuggets/object/blank.rb

@@ -72,7 +72,7 @@ class Array
   # call-seq:
   #   array.vain? => true or false
   #
-  # Returns true if any of _array_'s elements are themselves vain.
+  # Returns true if all of _array_'s elements are themselves vain.
   def vain?
     blank? { |a| a.delete_if { |i| i.vain? } }
   end
@@ -84,7 +84,7 @@ class Hash
   # call-seq:
   #   hash.vain? => true or false
   #
-  # Returns true if any of _hash_'s values are themselves vain.
+  # Returns true if all of _hash_'s values are themselves vain.
   def vain?
     blank? { |h| h.delete_if { |k, v| v.vain? } }
   end

data/lib/nuggets/proc/bind.rb

@@ -29,7 +29,7 @@ require File.join(File.dirname(__FILE__), '..', 'object', 'singleton_class')
 
 class Proc
 
-  # call.seq:
+  # call-seq:
   #   proc.bind(object) => aMethod
   #
   # Straight from Rails' ActiveSupport -- effectively binds _proc_ to +object+.

data/lib/nuggets/version.rb

@@ -4,7 +4,7 @@ module Nuggets
 
     MAJOR = 0
     MINOR = 0
-    TINY  = 4
+    TINY  = 5
 
     class << self
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-nuggets
 version: !ruby/object:Gem::Version 
-  version: 0.0.4.171
+  version: 0.0.5.179
 platform: ruby
 authors: 
 - Jens Wille
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-10 00:00:00 +01:00
+date: 2008-01-18 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -24,6 +24,7 @@ extra_rdoc_files:
 - COPYING
 - ChangeLog
 files: 
+- lib/nuggets/integer/factorial.rb
 - lib/nuggets/version.rb
 - lib/nuggets/object/singleton_class.rb
 - lib/nuggets/object/blank.rb
@@ -55,15 +56,15 @@ has_rdoc: true
 homepage: http://prometheus.rubyforge.org/ruby-nuggets
 post_install_message: 
 rdoc_options: 
-- --charset
-- UTF-8
 - --all
 - --title
 - ruby-nuggets Application documentation
+- --line-numbers
 - --main
 - README
-- --line-numbers
 - --inline-source
+- --charset
+- UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement