permutation 0.1.6 → 0.1.7

data/CHANGES

@@ -1,3 +1,6 @@
+2009-07-19 (0.1.7)
+    * Create a gem spec file.
+    * Some cleanup.
 2008-12-01 (0.1.6)
     * Reuse last value more.
     * Re-indented code.

data/Rakefile

@@ -1,22 +1,15 @@
-require 'rake/gempackagetask'
-require 'rbconfig'
+begin
+  require 'rake/gempackagetask'
+rescue LoadError
+end
 require 'rake/clean'
-
+require 'rbconfig'
 include Config
 
 PKG_NAME = 'permutation'
 PKG_VERSION = File.read('VERSION').chomp
-PKG_FILES = FileList["**/*"].exclude(/(CVS|pkg|doc)/)
-
-desc "Installing library"
-task :install  do
-  ruby 'install.rb'
-end
-
-desc "Creating documentation"
-task :doc do
-  ruby 'make_doc.rb'
-end
+PKG_FILES = FileList['**/*'].exclude(/^(doc|CVS|pkg|coverage)/)
+CLEAN.include 'coverage', 'doc'
 
 desc "Testing library"
 task :test  do
@@ -28,36 +21,59 @@ task :coverage  do
   sh %{rcov -Ilib test/test.rb}
 end
 
-spec = Gem::Specification.new do |s|
-  s.name = 'permutation'
-  s.version = PKG_VERSION
+desc "Installing library"
+task :install  do
+  ruby 'install.rb'
+end
+
+desc "Creating documentation"
+task :doc do
+  ruby 'make_doc.rb'
+end
+
+if defined? Gem
+  spec_src = <<GEM
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = '#{PKG_NAME}'
+  s.version = '#{PKG_VERSION}'
   s.summary = 'Permutation library in pure Ruby'
   s.description = "Library to perform different operations with permutations of sequences (strings, arrays, etc.)"
 
-  s.files = PKG_FILES
+  s.files = #{PKG_FILES.to_a.sort.inspect}
 
   s.require_path = 'lib'
 
   s.has_rdoc = true
-  s.rdoc_options << '--title' <<  'Permutation' << '--line-numbers'
-  s.extra_rdoc_files = Dir['lib/**/*.rb']
+  s.rdoc_options << '--main' <<  'doc-main.txt' << '--line-numbers'
+  s.extra_rdoc_files << 'doc-main.txt'
   s.test_files << 'test/test.rb'
 
   s.author = "Florian Frank"
   s.email = "flori@ping.de"
-  s.homepage = "http://permutation.rubyforge.org"
-  s.rubyforge_project = "permutation"
+  s.homepage = "http://#{PKG_NAME}.rubyforge.org"
+  s.rubyforge_project = "#{PKG_NAME}"
 end
+GEM
 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_tar = true
-  pkg.package_files += PKG_FILES
+  desc 'Create a gemspec file'
+  task :gemspec do
+    File.open("#{PKG_NAME}.gemspec", 'w') do |f|
+      f.puts spec_src
+    end
+  end
+
+  spec = eval(spec_src)
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_tar = true
+    pkg.package_files += PKG_FILES
+  end
 end
 
 desc m = "Writing version information for #{PKG_VERSION}"
 task :version do
   puts m
-  File.open(File.join('lib', 'permutation', 'version.rb'), 'w') do |v|
+  File.open(File.join('lib', PKG_NAME, 'version.rb'), 'w') do |v|
     v.puts <<EOT
 class Permutation
   # Permutation version
@@ -71,7 +87,6 @@ EOT
   end
 end
 
-CLEAN.include 'doc'
+task :default => [ :version, :gemspec, :test ]
 
-task :release => [ :clean, :version, :package ]
-  # vim: set et sw=2 ts=2:
+task :release => [ :clean, :version, :gemspec, :package ]

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/doc-main.txt

@@ -0,0 +1,120 @@
+== Permutation library for Ruby
+
+=== Author
+
+Florian Frank mailto:flori@ping.de
+
+=== License
+
+This is free software; you can redistribute it and/or modify it under the
+terms of the GNU General Public License Version 2 as published by the Free
+Software Foundation: www.gnu.org/copyleft/gpl.html
+
+=== Download
+
+The latest version of <b>permutation</b> can be found at
+
+* http://rubyforge.org/frs/?group_id=291
+
+The homepage of this library is located at
+
+* http://permutation.rubyforge.org
+
+=== Description
+
+The Permutation class has a dual purpose: It can be used to create
+permutations of a given size and to do some simple computations with/on
+permutations. The instances of this class don't require much memory
+because they don't include the permutation as a data structure. They
+only save the information necessary to create the permutation if asked
+to do so.
+
+To generate permutations the ranking/unranking method described in [SS97]
+is used. Because of Ruby's Bignum arithmetic it is useful also
+for permutations of very large size.
+
+=== Examples
+
+In this section some examples show what can be done with this class.
+
+Creating all permutations and project them on data:
+
+ perm = Permutation.new(3)
+ # => #<Permutation:0x57dc94 @last=5, @rank=0, @size=3>
+ perm.map { |p| p.value }
+ # => [[0, 1, 2], [0, 2, 1], [1, 0, 2], [1, 2, 0], [2, 0, 1], [2, 1, 0]]
+ colors = [:r, :g, :b]
+ # => [:r, :g, :b]
+ perm.map { |p| p.project(colors) }
+ # => [[:r, :g, :b], [:r, :b, :g], [:g, :r, :b], [:g, :b, :r], [:b, :r, :g],
+ #  [:b, :g, :r]]
+ string = "abc"# => "abc"
+ perm.map { |p| p.project(string) }
+ # => ["abc", "acb", "bac", "bca", "cab", "cba"]
+
+Or perhaps more convenient to use:
+
+ perm = Permutation.for("abc")
+ perm.map { |p| p.project }
+ # => ["abc", "acb", "bac", "bca", "cab", "cba"]
+
+Finding the successor and predecessor of Permutations or a
+certain Permutation for a given rank:
+
+ perm = Permutation.new(7)
+ # => #<Permutation:0x8453c @rank=0, @size=7, @last=5039>
+ perm.succ!
+ # => #<Permutation:0x8453c @rank=1, @size=7, @last=5039>
+ perm.succ!
+ # => #<Permutation:0x8453c @rank=2, @size=7, @last=5039>
+ perm.succ!
+ # => #<Permutation:0x8453c @rank=3, @size=7, @last=5039>
+ perm.pred!
+ # => #<Permutation:0x8453c @rank=2, @size=7, @last=5039>
+ perm.rank = 3200
+ # => 3200
+ perm
+ # => #<Permutation:0x8453c @rank=3200, @size=7, @last=5039>
+ perm.value
+ # => [4, 2, 5, 1, 3, 0, 6]
+
+Generating random Permutations
+
+ perm = Permutation.new(10)
+ # => #<Permutation:0x59f4c0 @rank=0, @size=10, @last=3628799>
+ perm.random!.value
+ # => [6, 4, 9, 7, 3, 5, 8, 1, 2, 0]
+ perm.random!.value
+ # => [3, 7, 6, 1, 4, 8, 9, 2, 5, 0]
+ perm.random!.value
+ # => [2, 8, 4, 9, 3, 5, 6, 7, 0, 1]
+ perm.random!.project("ABCDEFGHIJ")
+ # => "DFJGAEBCIH"
+ perm.random!.project("ABCDEFGHIJ")
+ # => "BFADEGHJCI"
+
+Performing some mathematical operations on/with Permutations
+
+ p1 = Permutation.from_cycles([[1, 3, 2], [5, 7]], 10)
+ # => #<Permutation:0x593594 @rank=80694, @size=10, @last=3628799>
+ p2 = Permutation.from_value [3, 2, 0, 5, 6, 8, 9, 1, 4, 7]
+ # => #<Permutation:0x5897b0 @rank=1171050, @size=10, @last=3628799>
+ p3 = p1 * p2
+ # => #<Permutation:0x586a88 @rank=769410, @size=10, @last=3628799>
+ p3.value
+ # => [2, 1, 0, 7, 6, 8, 9, 3, 4, 5]
+ p3.cycles
+ # => [[0, 2], [3, 7], [4, 6, 9, 5, 8]]
+ p4 = p1 * -p2
+ # => #<Permutation:0x581a10 @rank=534725, @size=10, @last=3628799>
+ p4.value
+ # => [1, 5, 3, 0, 8, 2, 4, 9, 7, 6]
+ p4.cycles
+ # => [[0, 1, 5, 2, 3], [4, 8, 7, 9, 6]]
+ id = p1 * -p1
+ # => #<Permutation:0x583a7c @rank=0, @size=10, @last=3628799>
+
+=== References
+
+ [SS97] The Algorithm Design Manual, Steven S. Skiena, Telos/Springer, 1997.
+

data/examples/tsp.rb

@@ -7,25 +7,25 @@
 require 'permutation'
 
 def make_matrix(n)
-    dist = Array.new(n) { [] }
-    for i in 0...n
-        for j in 0...n
-            case
-            when i == j then dist[i][j] = 0
-            when i < j then  dist[i][j] = 1 + rand(999)
-            when i > j then  dist[i][j] = dist[j][i]
-            end
-        end
+  dist = Array.new(n) { [] }
+  for i in 0...n
+    for j in 0...n
+      case
+      when i == j then dist[i][j] = 0
+      when i < j then  dist[i][j] = 1 + rand(999)
+      when i > j then  dist[i][j] = dist[j][i]
+      end
     end
-    dist
+  end
+  dist
 end
 
 def pretty_distances(dist)
-    dist.map { |line| line.map { |x| "%3u" % x }.join(' ') }.join("\n")
+  dist.map { |line| line.map { |x| "%3u" % x }.join(' ') }.join("\n")
 end
 
 def solution(p, dist)
-    (0...p.size).map { |i| dist[ p[i - 1] ][ p[i] ] }.join(' + ')
+  (0...p.size).map { |i| dist[ p[i - 1] ][ p[i] ] }.join(' + ')
 end
 
 n = ARGV.empty? ? 7 : ARGV.shift.to_i
@@ -36,21 +36,20 @@ perm = Permutation.new(distances.size - 1)
 puts "Searching through #{perm.last + 1} solutions..."
 projection = (1...distances.size).to_a
 perm.each! do |p|
-    tour = p.project(projection)
-    # Little trick: We always start in city 0:
-    tour.unshift(0)
-    sum = 0
-    0.upto(tour.size - 1) do |i|
-        sum += distances[ tour[i - 1] ][ tour[i] ]
-    end
-    if $DEBUG
-        puts "Computed tour #{tour.inspect} with sum = #{sum} = " +
-            "#{solution(tour, distances)}."
-    end
-    if not minsum or minsum > sum
-        optimum, minsum = tour, sum
-    end
+  tour = p.project(projection)
+  # Little trick: We always start in city 0:
+  tour.unshift(0)
+  sum = 0
+  0.upto(tour.size - 1) do |i|
+    sum += distances[ tour[i - 1] ][ tour[i] ]
+  end
+  if $DEBUG
+    puts "Computed tour #{tour.inspect} with sum = #{sum} = " +
+      "#{solution(tour, distances)}."
+  end
+  if not minsum or minsum > sum
+    optimum, minsum = tour, sum
+  end
 end
 puts "Optimal tour is #{optimum.inspect} with sum = #{minsum} = " +
-     "#{solution(optimum, distances)}."
-    # vim: set et sw=4 ts=4:
+   "#{solution(optimum, distances)}."

data/install.rb

@@ -8,5 +8,6 @@ include Config
 
 dest = CONFIG["sitelibdir"]
 install('lib/permutation.rb', dest)
-install('lib/permutation/version.rb', File.join(dest, 'permutation'))
-    # vim: set et sw=4 ts=4:
+sub_dir = File.join(dest, 'permutation')
+mkdir_p sub_dir
+install('lib/permutation/version.rb', sub_dir)

data/lib/permutation.rb

@@ -1,124 +1,3 @@
-# = permutation.rb - Permutation class for Ruby
-#
-# == Author
-#
-# Florian Frank mailto:flori@ping.de
-#
-# == License
-#
-# This is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License Version 2 as published by the Free
-# Software Foundation: www.gnu.org/copyleft/gpl.html
-#
-# == Download
-#
-# The latest version of <b>permutation</b> can be found at
-#
-# * http://rubyforge.org/frs/?group_id=291
-#
-# The homepage of this library is located at
-#
-# * http://permutation.rubyforge.org
-#
-# == Description
-#
-# This class has a dual purpose: It can be used to create permutations
-# of a given size and to do some simple computations with/on
-# permutations. The instances of this class don't require much memory
-# because they don't include the permutation as a data structure. They
-# only save the information necessary to create the permutation if asked
-# to do so.
-#
-# To generate permutations the ranking/unranking method described in [SS97]
-# is used. Because of Ruby's Bignum arithmetic it is useful also
-# for permutations of very large size.
-# 
-# == Examples
-#
-# In this section some examples show what can be done with this class.
-#
-# Creating all permutations and project them on data:
-#
-#  perm = Permutation.new(3)
-#  # => #<Permutation:0x57dc94 @last=5, @rank=0, @size=3>
-#  perm.map { |p| p.value }
-#  # => [[0, 1, 2], [0, 2, 1], [1, 0, 2], [1, 2, 0], [2, 0, 1], [2, 1, 0]]
-#  colors = [:r, :g, :b]
-#  # => [:r, :g, :b]
-#  perm.map { |p| p.project(colors) }
-#  # => [[:r, :g, :b], [:r, :b, :g], [:g, :r, :b], [:g, :b, :r], [:b, :r, :g],
-#  #  [:b, :g, :r]]
-#  string = "abc"# => "abc"
-#  perm.map { |p| p.project(string) }
-#  # => ["abc", "acb", "bac", "bca", "cab", "cba"]
-#
-# Or perhaps more convenient to use:
-#
-#  perm = Permutation.for("abc")
-#  perm.map { |p| p.project }
-#  # => ["abc", "acb", "bac", "bca", "cab", "cba"]
-#
-# Finding the successor and predecessor of Permutations or a
-# certain Permutation for a given rank:
-#
-#  perm = Permutation.new(7)
-#  # => #<Permutation:0x8453c @rank=0, @size=7, @last=5039>
-#  perm.succ!
-#  # => #<Permutation:0x8453c @rank=1, @size=7, @last=5039>
-#  perm.succ!
-#  # => #<Permutation:0x8453c @rank=2, @size=7, @last=5039>
-#  perm.succ!
-#  # => #<Permutation:0x8453c @rank=3, @size=7, @last=5039>
-#  perm.pred!
-#  # => #<Permutation:0x8453c @rank=2, @size=7, @last=5039>
-#  perm.rank = 3200
-#  # => 3200
-#  perm
-#  # => #<Permutation:0x8453c @rank=3200, @size=7, @last=5039>
-#  perm.value
-#  # => [4, 2, 5, 1, 3, 0, 6]
-#
-# Generating random Permutations
-#
-#  perm = Permutation.new(10)
-#  # => #<Permutation:0x59f4c0 @rank=0, @size=10, @last=3628799>
-#  perm.random!.value
-#  # => [6, 4, 9, 7, 3, 5, 8, 1, 2, 0]
-#  perm.random!.value
-#  # => [3, 7, 6, 1, 4, 8, 9, 2, 5, 0]
-#  perm.random!.value
-#  # => [2, 8, 4, 9, 3, 5, 6, 7, 0, 1]
-#  perm.random!.project("ABCDEFGHIJ")
-#  # => "DFJGAEBCIH"
-#  perm.random!.project("ABCDEFGHIJ")
-#  # => "BFADEGHJCI"
-#
-# Performing some mathematical operations on/with Permutations
-#
-#  p1 = Permutation.from_cycles([[1, 3, 2], [5, 7]], 10)
-#  # => #<Permutation:0x593594 @rank=80694, @size=10, @last=3628799>
-#  p2 = Permutation.from_value [3, 2, 0, 5, 6, 8, 9, 1, 4, 7]
-#  # => #<Permutation:0x5897b0 @rank=1171050, @size=10, @last=3628799>
-#  p3 = p1 * p2
-#  # => #<Permutation:0x586a88 @rank=769410, @size=10, @last=3628799>
-#  p3.value
-#  # => [2, 1, 0, 7, 6, 8, 9, 3, 4, 5]
-#  p3.cycles
-#  # => [[0, 2], [3, 7], [4, 6, 9, 5, 8]]
-#  p4 = p1 * -p2
-#  # => #<Permutation:0x581a10 @rank=534725, @size=10, @last=3628799>
-#  p4.value
-#  # => [1, 5, 3, 0, 8, 2, 4, 9, 7, 6]
-#  p4.cycles
-#  # => [[0, 1, 5, 2, 3], [4, 8, 7, 9, 6]]
-#  id = p1 * -p1
-#  # => #<Permutation:0x583a7c @rank=0, @size=10, @last=3628799>
-#
-# == References
-#
-#  [SS97] The Algorithm Design Manual, Steven S. Skiena, Telos/Springer, 1997.
-# 
-
 class Permutation
   include Enumerable
   include Comparable
@@ -157,15 +36,15 @@ class Permutation
     from_value(indices)
   end
 
-	# A permutation instance of size collection.size is created with
-	# collection as the default Permutation#project data object. A
-	# collection should respond to size, [], and []=. The Permutation
-	# instance will default to rank 0 if none is given.
-	def self.for(collection, rank = 0)
-		perm = new(collection.size, rank)
-		perm.instance_variable_set(:@collection, collection)
-		perm
-	end
+  # A permutation instance of size collection.size is created with
+  # collection as the default Permutation#project data object. A
+  # collection should respond to size, [], and []=. The Permutation
+  # instance will default to rank 0 if none is given.
+  def self.for(collection, rank = 0)
+    perm = new(collection.size, rank)
+    perm.instance_variable_set(:@collection, collection)
+    perm
+  end
 
   # Returns the size of this permutation, a Fixnum.
   attr_reader :size
@@ -217,7 +96,7 @@ class Permutation
     projection
   end
 
-  # Switches this instances to the next ranked Permutation.
+  # Switches this instance to the next ranked Permutation.
   # If this was the Permutation#last permutation it wraps around
   # the first (<code>rank == 0</code>) permutation.
   def next!
@@ -237,7 +116,7 @@ class Permutation
 
   alias succ next
 
-  # Switches this instances to the previously ranked Permutation.
+  # Switches this instance to the previously ranked Permutation.
   # If this was the first permutation it returns the last (<code>rank ==
   # Permutation#last</code>) permutation.
   def pred!
@@ -462,4 +341,3 @@ class Permutation
     result
   end
 end
-  # vim: set et sw=4 ts=4:

data/lib/permutation/version.rb

@@ -1,6 +1,6 @@
 class Permutation
   # Permutation version
-  VERSION         = '0.1.6'
+  VERSION         = '0.1.7'
   VERSION_ARRAY   = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/make_doc.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$outdir = 'doc/'
+puts "Creating documentation in '#$outdir'."
+system "rdoc -d -m doc-main.txt -o #$outdir #{(%w[doc-main.txt] + Dir['lib/**/*.rb']) * ' '}"

data/permutation.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = 'permutation'
+  s.version = '0.1.7'
+  s.summary = 'Permutation library in pure Ruby'
+  s.description = "Library to perform different operations with permutations of sequences (strings, arrays, etc.)"
+
+  s.files = ["CHANGES", "COPYING", "README", "Rakefile", "VERSION", "examples", "examples/tsp.rb", "install.rb", "lib", "lib/permutation", "lib/permutation.rb", "lib/permutation/version.rb", "make_doc.rb", "permutation.gemspec", "test", "test/test.rb"]
+
+  s.require_path = 'lib'
+
+  s.has_rdoc = true
+  s.rdoc_options << '--main' <<  'doc-main.txt' << '--line-numbers'
+  s.extra_rdoc_files << 'doc-main.txt'
+  s.test_files << 'test/test.rb'
+
+  s.author = "Florian Frank"
+  s.email = "flori@ping.de"
+  s.homepage = "http://permutation.rubyforge.org"
+  s.rubyforge_project = "permutation"
+end

data/test/test.rb

@@ -250,4 +250,3 @@ class TC_Permutation < Test::Unit::TestCase
     end
   end
 end
-# vim: set et sw=2 ts=2:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: permutation
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Florian Frank
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-01 00:00:00 +01:00
+date: 2009-07-19 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -20,29 +20,29 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- lib/permutation/version.rb
-- lib/permutation.rb
+- doc-main.txt
 files: 
-- install.rb
-- lib
-- lib/permutation
-- lib/permutation/version.rb
-- lib/permutation.rb
 - CHANGES
-- README.en
-- VERSION
-- test
-- test/test.rb
+- COPYING
+- README
 - Rakefile
-- GPL
-- examples
+- VERSION
 - examples/tsp.rb
+- install.rb
+- lib/permutation.rb
+- lib/permutation/version.rb
+- make_doc.rb
+- permutation.gemspec
+- test/test.rb
+- doc-main.txt
 has_rdoc: true
 homepage: http://permutation.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --title
-- Permutation
+- --main
+- doc-main.txt
 - --line-numbers
 require_paths: 
 - lib
@@ -61,9 +61,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: permutation
-rubygems_version: 1.3.1
+rubygems_version: 1.3.2
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Permutation library in pure Ruby
 test_files: 
 - test/test.rb