permutation 0.1.7 → 0.1.8

data/CHANGES

@@ -1,3 +1,7 @@
+2010-03-16 (0.1.8)
+    * Disabled building of gem spec file.
+    * Reorganised documentation.
+    * Fixed an unncessary check.
 2009-07-19 (0.1.7)
     * Create a gem spec file.
     * Some cleanup.

data/README

@@ -1,35 +1,144 @@
-Installation
-============
+=== 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.
+
+=== Download
+
+The latest version of <b>permutation</b> can be found at
+
+* http://www.ping.de/~flori/
+
+The homepage of this library is located at
+
+* http://flori.github.com/permutation
+
+== Installation
 
 Just type into the command line as root:
 
 # ruby install.rb
 
-Or if you already use rubygems (you should!) just type and rubygems fetches
-the gem and installs it for you:
+Or if you use rubygems just type and rubygems fetches the gem and installs it
+for you:
 
 # gem install permutation
 
-Documentation
-=============
+== Creating Documentation
 
-To create the documentation of this module, type
+To create the documentation of this module, type either
 
 $ ruby make_doc.rb
 
+or with rake installed
+
+$ rake doc
+
 and the API documentation is generated by your rdoc command in
 the doc/ sub-directory.
 
-In the examples direcotry is a small example that solves the
+The examples direcotry also contains a small demonstration that solves the
 Traveling Salesman Problem (TSP) with this library.
 
-Author
-======
+=== 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.
 
-Florian Frank <flori@ping.de>
+=== Author
 
-License
-=======
+Florian Frank mailto:flori@ping.de
 
-GNU General Public License (GPL)
+=== 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

data/Rakefile

@@ -32,38 +32,27 @@ task :doc do
 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.)"
+  spec = 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.to_a.sort.inspect}
+    s.files = PKG_FILES.to_a.sort
 
-  s.require_path = 'lib'
+    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.has_rdoc = true
+    s.rdoc_options << '--main' <<  'README' << '--line-numbers'
+    s.extra_rdoc_files << 'README'
+    s.test_files << 'test/test.rb'
 
-  s.author = "Florian Frank"
-  s.email = "flori@ping.de"
-  s.homepage = "http://#{PKG_NAME}.rubyforge.org"
-  s.rubyforge_project = "#{PKG_NAME}"
-end
-GEM
-
-  desc 'Create a gemspec file'
-  task :gemspec do
-    File.open("#{PKG_NAME}.gemspec", 'w') do |f|
-      f.puts spec_src
-    end
+    s.author = "Florian Frank"
+    s.email = "flori@ping.de"
+    s.homepage = "http://flori.github.com/#{PKG_NAME}"
+    s.rubyforge_project = "#{PKG_NAME}"
   end
 
-  spec = eval(spec_src)
   Rake::GemPackageTask.new(spec) do |pkg|
     pkg.need_tar = true
     pkg.package_files += PKG_FILES
@@ -87,6 +76,6 @@ EOT
   end
 end
 
-task :default => [ :version, :gemspec, :test ]
+task :default => [ :version, :test ]
 
-task :release => [ :clean, :version, :gemspec, :package ]
+task :release => [ :clean, :version, :package ]

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.1.8

data/lib/permutation.rb

@@ -259,7 +259,7 @@ class Permutation
     result = [[]]
     seen = {}
     current = nil
-    until seen == perm.size
+    loop do
       current or current = perm.find { |x| !seen[x] }
       break unless current
       if seen[current]

data/lib/permutation/version.rb

@@ -1,6 +1,6 @@
 class Permutation
   # Permutation version
-  VERSION         = '0.1.7'
+  VERSION         = '0.1.8'
   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

@@ -2,4 +2,4 @@
 
 $outdir = 'doc/'
 puts "Creating documentation in '#$outdir'."
-system "rdoc -d -m doc-main.txt -o #$outdir #{(%w[doc-main.txt] + Dir['lib/**/*.rb']) * ' '}"
+system "rdoc -d -m README -t 'Permutation library for Ruby' -o #$outdir #{(%w[README] + Dir['lib/**/*.rb']) * ' '}"

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: permutation
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Florian Frank
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-19 00:00:00 +02:00
+date: 2010-03-16 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -20,7 +25,7 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- doc-main.txt
+- README
 files: 
 - CHANGES
 - COPYING
@@ -32,17 +37,15 @@ files:
 - 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
+homepage: http://flori.github.com/permutation
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - --main
-- doc-main.txt
+- README
 - --line-numbers
 require_paths: 
 - lib
@@ -50,18 +53,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: permutation
-rubygems_version: 1.3.2
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Permutation library in pure Ruby

data/doc-main.txt

@@ -1,120 +0,0 @@
-== 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/permutation.gemspec

@@ -1,21 +0,0 @@
-# -*- 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