combinatorics 0.4.3 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2e5a4e1e77069bf882a67e27933b8640723ee43a209b3a7d4b442238a4d7e45
+  data.tar.gz: 595e89e295c7f9dae763f890f460f745edd743ac12340c5f8785677caa6a56b6
+SHA512:
+  metadata.gz: 7eaec1f50156aa63c48212782b2cddd9a18b7dab7ba5986201f97c16b1ca9d01311b675c503b1cbe19ecb9ad63cef946a47f0eeef58742b62a8deb53b228ff30
+  data.tar.gz: af34206cde9e21f8637ac54449563456c81f939a3ca032c64e0a98fe5220918d5f9c03b6eefe3cf8c5b8c44280701c1121b7770ae1b4d6c8323eed0091cb2eb0

data/.github/workflows/ruby.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - jruby
+          - truffleruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -1,8 +1,8 @@
-pkg
-doc
-web
-tmp
+/Gemfile.lock
+/coverage
+/doc
+/pkg
+/.yardoc
 .DS_Store
-.yardoc
 *.swp
 *~

data/ChangeLog.md

@@ -1,3 +1,14 @@
+### 0.5.0 / 2024-01-25
+
+* Require [ruby](http://www.ruby-lang.org/) >= 2.0.0.
+* Switched to using `require_relative` to improve load-times.
+* Added `# frozen_string_literal: true` to all files.
+
+### 0.4.4 / 2022-01-16
+
+* Fixed a bug in {Combinatorics::Choose.cardinality} for when `0`
+  is given and `0` was returned instead of `1`.
+
 ### 0.4.3 / 2012-05-28
 
 * Fixed a typo in the gemspec, which incorrectly set

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks', '~> 0.2'
+
+  gem 'rspec',          '~> 3.0'
+  gem 'simplecov',      '~> 0.20', require: false
+
+  gem 'kramdown'
+  gem 'redcarpet',       platform: :mri
+  gem 'yard',           '~> 0.9'
+  gem 'yard-spellcheck', require: false
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2012 Hal Brodigan
+Copyright (c) 2010-2024 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,15 +1,17 @@
 # Combinatorics
 
+[![CI](https://github.com/postmodern/combinatorics/actions/workflows/ruby.yml/badge.svg)](https://github.com/postmodern/combinatorics/actions/workflows/ruby.yml)
+[![Code Climate](https://codeclimate.com/github/postmodern/combinatorics.svg)](https://codeclimate.com/github/postmodern/combinatorics)
+
 * [Source](https://github.com/postmodern/combinatorics)
 * [Issues](https://github.com/postmodern/combinatorics/issues)
 * [Documentation](http://rubydoc.info/gems/combinatorics)
-* [Email](mailto:postmodern.mod3 at gmail.com)
 
 ## Description
 
 A collection of modules and methods for performing
 [Combinatoric](http://en.wikipedia.org/wiki/Combinatoric) calculations.
-Methods are defined to compute power sets, cartesian products, permutations, 
+Methods are defined to compute power sets, Cartesian products, permutations, 
 combinations, and derangements.
 
 Note: this includes k-combinations and k-permutations, i.e. only generating
@@ -22,145 +24,180 @@ never complete due to exponential computational complexity.)
 
 ## Features
 
-* Adds Haskell/Python style list comprehensions via {Array#comprehension}.
+* Adds Haskell/Python style list comprehensions via [Array#comprehension].
 * Provides reusable Combinatorics Mixins:
-  * {Combinatorics::CartesianProduct}
-  * {Combinatorics::Choose}
-  * {Combinatorics::Derange}
-  * {Combinatorics::Permute}
-  * {Combinatorics::PowerSet}
-* Adds Combinatorics conveniance methods to {Array} and {Set}:
-  * `cartesian_product`
-  * `choose`
-  * `derange`
-  * `permute`
-  * `powerset`
-* Adds conveniance methods:
-  * {Range#&}
-  * {Range#upto}
-  * {Range#downto}
-  * {Math.sigma}
-  * {Math.pi}
-  * {Math.factorial}
-  * {Math.subfactorial}
+  * [Combinatorics::CartesianProduct]
+  * [Combinatorics::Choose]
+  * [Combinatorics::Derange]
+  * [Combinatorics::Permute]
+  * [Combinatorics::PowerSet]
+* Adds Combinatorics core extension methods to {Array} and {Set}:
+  * [cartesian_product]
+  * [choose]
+  * [derange]
+  * [permute]
+  * [powerset]
+* Adds additional core extension methods:
+  * [Range#&]
+  * [Range#upto]
+  * [Range#downto]
+  * [Math.sigma]
+  * [Math.pi]
+  * [Math.factorial]
+  * [Math.subfactorial]
+
+[Array#comprehension]: https://rubydoc.info/gems/combinatorics/Array#comprehension-instance_method
+[Combinatorics::CartesianProduct]: https://rubydoc.info/gems/combinatorics/Combinatorics/CartesianProduct
+[Combinatorics::Choose]: https://rubydoc.info/gems/combinatorics/Combinatorics/Choose
+[Combinatorics::Derange]: https://rubydoc.info/gems/combinatorics/Combinatorics/Derange
+[Combinatorics::Permute]: https://rubydoc.info/gems/combinatorics/Combinatorics/Permute
+[Combinatorics::PowerSet]: https://rubydoc.info/gems/combinatorics/Combinatorics/PowerSet
+[cartesian_product]: https://rubydoc.info/gems/combinatorics/Combinatorics/CartesianProduct/Mixin#cartesian_product-instance_method
+[choose]: https://rubydoc.info/gems/combinatorics/Combinatorics/Choose/Mixin#choose-instance_method
+[derange]: https://rubydoc.info/gems/combinatorics/Combinatorics/Derange/Mixin#derange-instance_method
+[permute]: https://rubydoc.info/gems/combinatorics/Combinatorics/Permute/Mixin#permute-instance_method
+[powerset]: https://rubydoc.info/gems/combinatorics/Combinatorics/PowerSet/Mixin#powerset-instance_method
+[Range#&]: https://rubydoc.info/gems/combinatorics/Range#&-instance_method
+[Range#upto]: https://rubydoc.info/gems/combinatorics/Range#upto-instance_method
+[Range#downto]: https://rubydoc.info/gems/combinatorics/Range#downto-instance_method
+[Math.sigma]: https://rubydoc.info/gems/combinatorics/Math#sigma-class_method
+[Math.pi]: https://rubydoc.info/gems/combinatorics/Math#pi-class_method
+[Math.factorial]: https://rubydoc.info/gems/combinatorics/Math#factorial-class_method
+[Math.subfactorial]: https://rubydoc.info/gems/combinatorics/Math#subfactorial-class_method
 
 ## Examples
 
 Power-set:
 
-    Set['ab', 'cd', 'ef'].powerset
-    # => [#<Set: {}>,
-          #<Set: {"ef"}>,
-          #<Set: {"cd"}>,
-          #<Set: {"cd", "ef"}>,
-          #<Set: {"ab"}>,
-          #<Set: {"ab", "ef"}>,
-          #<Set: {"ab", "cd"}>,
-          #<Set: {"ab", "cd", "ef"}>]
+```ruby
+Set['ab', 'cd', 'ef'].powerset
+# => [#<Set: {}>,
+      #<Set: {"ef"}>,
+      #<Set: {"cd"}>,
+      #<Set: {"cd", "ef"}>,
+      #<Set: {"ab"}>,
+      #<Set: {"ab", "ef"}>,
+      #<Set: {"ab", "cd"}>,
+      #<Set: {"ab", "cd", "ef"}>]
+```
 
 Cartesian products:
 
-    require 'combinatorics/cartesian_product'
-    
-    ['a', 'b', 'c'].cartesian_product([0, 1, 2]).to_a
-    # => [["a", 0], 
-          ["b", 0], 
-          ["c", 0], 
-          ["a", 1], 
-          ["b", 1], 
-          ["c", 1], 
-          ["a", 2], 
-          ["b", 2], 
-          ["c", 2]]
+```ruby
+require 'combinatorics/cartesian_product'
+
+['a', 'b', 'c'].cartesian_product([0, 1, 2]).to_a
+# => [["a", 0], 
+      ["b", 0], 
+      ["c", 0], 
+      ["a", 1], 
+      ["b", 1], 
+      ["c", 1], 
+      ["a", 2], 
+      ["b", 2], 
+      ["c", 2]]
+```
 
 k-combinations:
 
-    require 'combinatorics/choose'
-
-    ('a'..'f').to_a.choose(2).to_a
-    # => [["a", "b"], 
-          ["a", "c"], 
-          ["a", "d"], 
-          ["a", "e"], 
-          ["a", "f"], 
-          ["b", "c"], 
-          ["b", "d"], 
-          ["b", "e"], 
-          ["b", "f"], 
-          ["c", "d"], 
-          ["c", "e"], 
-          ["c", "f"], 
-          ["d", "e"], 
-          ["d", "f"], 
-          ["e", "f"]]
+```ruby
+require 'combinatorics/choose'
+
+('a'..'f').to_a.choose(2).to_a
+# => [["a", "b"], 
+      ["a", "c"], 
+      ["a", "d"], 
+      ["a", "e"], 
+      ["a", "f"], 
+      ["b", "c"], 
+      ["b", "d"], 
+      ["b", "e"], 
+      ["b", "f"], 
+      ["c", "d"], 
+      ["c", "e"], 
+      ["c", "f"], 
+      ["d", "e"], 
+      ["d", "f"], 
+      ["e", "f"]]
+```
 
 Derangements:
 
-    require 'combinatorics/derange'
-    
-    [:_, :q, :z, :x].derange.to_a
-    # => [[:q, :_, :x, :z], 
-          [:q, :z, :x, :_], 
-          [:q, :x, :_, :z], 
-          [:z, :_, :x, :q], 
-          [:z, :x, :_, :q], 
-          [:z, :x, :q, :_], 
-          [:x, :_, :q, :z], 
-          [:x, :z, :_, :q], 
-          [:x, :z, :q, :_]]
+```ruby
+require 'combinatorics/derange'
+
+[:_, :q, :z, :x].derange.to_a
+# => [[:q, :_, :x, :z], 
+      [:q, :z, :x, :_], 
+      [:q, :x, :_, :z], 
+      [:z, :_, :x, :q], 
+      [:z, :x, :_, :q], 
+      [:z, :x, :q, :_], 
+      [:x, :_, :q, :z], 
+      [:x, :z, :_, :q], 
+      [:x, :z, :q, :_]]
+```
 
 Permutation cardinality:
 
-    require 'combinatorics/permutation'
-    
-    Combinatorics::Permute.cardinality(128)
-    # => 8256
+```ruby
+require 'combinatorics/permutation'
+
+Combinatorics::Permute.cardinality(128)
+# => 8256
+```
 
 List comprehensions:
 
-    require 'combinatorics/list_comprehension'
-
-    [(0..10).step(2),('a'..'c')].comprehension.to_a
-    # => [[0, "a"],
-          [0, "b"],
-          [0, "c"],
-          [2, "a"],
-          [2, "b"],
-          [2, "c"],
-          [4, "a"],
-          [4, "b"],
-          [4, "c"],
-          [6, "a"],
-          [6, "b"],
-          [6, "c"],
-          [8, "a"],
-          [8, "b"],
-          [8, "c"],
-          [10, "a"],
-          [10, "b"],
-          [10, "c"]]
+```ruby
+require 'combinatorics/list_comprehension'
+
+[(0..10).step(2),('a'..'c')].comprehension.to_a
+# => [[0, "a"],
+      [0, "b"],
+      [0, "c"],
+      [2, "a"],
+      [2, "b"],
+      [2, "c"],
+      [4, "a"],
+      [4, "b"],
+      [4, "c"],
+      [6, "a"],
+      [6, "b"],
+      [6, "c"],
+      [8, "a"],
+      [8, "b"],
+      [8, "c"],
+      [10, "a"],
+      [10, "b"],
+      [10, "c"]]
+```
 
 Find the intersecting sub-range between two ranges:
 
-    (1..50) & (20..100)
-    # => (20..50)
+```ruby
+(1..50) & (20..100)
+# => (20..50)
+```
 
 Enumerate over every sub-range between two ranges:
 
-    (1..5).upto(2..10).to_a
-    # => [1..5, 1..6, 1..7, 1..8, 1..9, 1..10,
-          2..5, 2..6, 2..7, 2..8, 2..9, 2..10]
+```ruby
+(1..5).upto(2..10).to_a
+# => [1..5, 1..6, 1..7, 1..8, 1..9, 1..10,
+      2..5, 2..6, 2..7, 2..8, 2..9, 2..10]
+```
 
 ## Requirements
 
-* [ruby](http://www.ruby-lang.org/) >= 1.8.7
+* [ruby](http://www.ruby-lang.org/) >= 2.0.0
 
 ## Install
 
-    $ gem install combinatorics
+```shell
+$ gem install combinatorics
+```
 
 ## Copyright
 
-Copyright (c) 2010-2012 Hal Brodigan
-
 See {file:LICENSE.txt} for license information.

data/Rakefile

@@ -1,39 +1,13 @@
-require 'rubygems'
-require 'rake'
+require 'rubygems/tasks'
+Gem::Tasks.new
 
-begin
-  gem 'rubygems-tasks', '~> 0.1'
-  require 'rubygems/tasks'
-
-  Gem::Tasks.new
-rescue LoadError => e
-  warn e.message
-  warn "Run `gem install rubygems-tasks` to install 'rubygems/tasks'."
-end
-
-begin
-  gem 'rspec', '~> 2.4'
-  require 'rspec/core/rake_task'
-
-  RSpec::Core::RakeTask.new
-rescue LoadError => e
-  task :spec do
-    abort "Please run `gem install rspec` to install RSpec."
-  end
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 task :test => :spec
 task :default => :spec
 
-begin
-  gem 'yard', '~> 0.7'
-  require 'yard'
-
-  YARD::Rake::YardocTask.new  
-rescue LoadError => e
-  task :yard do
-    abort "Please run `gem install yard` to install YARD."
-  end
-end
+require 'yard'
+YARD::Rake::YardocTask.new
 
 task :benchmark do
   Dir.glob('benchmarks/*.rb') { |script| ruby(script) }

data/combinatorics.gemspec

@@ -7,10 +7,7 @@ Gem::Specification.new do |gem|
 
   gem.name    = gemspec.fetch('name')
   gem.version = gemspec.fetch('version') do
-                  lib_dir = File.join(File.dirname(__FILE__),'lib')
-                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
-
-                  require 'combinatorics/version'
+                  require_relative 'lib/combinatorics/version'
                   Combinatorics::VERSION
                 end
 
@@ -20,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.authors     = Array(gemspec['authors'])
   gem.email       = gemspec['email']
   gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
 
   glob = lambda { |patterns| gem.files & Dir[*patterns] }
 

data/gemspec.yml

@@ -13,9 +13,13 @@ email:
 homepage: https://github.com/postmodern/combinatorics#readme
 has_yard: true
 
-required_ruby_version: ">= 1.8.7"
+metadata:
+  documentation_uri: https://rubydoc.info/gems/combinatorics
+  source_code_uri:   https://github.com/postmodern/combinatorics.rb
+  bug_tracker_uri:   https://github.com/postmodern/combinatorics.rb/issues
+  changelog_uri:     https://github.com/postmodern/combinatorics.rb/blob/master/ChangeLog.md
+
+required_ruby_version: ">= 2.0.0"
 
 development_dependencies:
-  rubygems-tasks: ~> 0.1
-  rspec: ~> 2.4
-  yard: ~> 0.7
+  bundler: ~> 2.0

data/lib/combinatorics/cartesian_product/cardinality.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Combinatorics
   #
   # @author duper <super@manson.vistech.net>

data/lib/combinatorics/cartesian_product/extensions/array.rb

@@ -1,4 +1,6 @@
-require 'combinatorics/cartesian_product/mixin'
+# frozen_string_literal: true
+
+require_relative '../mixin'
 
 class Array
 

data/lib/combinatorics/cartesian_product/extensions/set.rb

@@ -1,4 +1,6 @@
-require 'combinatorics/cartesian_product/mixin'
+# frozen_string_literal: true
+
+require_relative '../mixin'
 
 require 'set'
 

data/lib/combinatorics/cartesian_product/extensions.rb

@@ -1,2 +1,4 @@
-require 'combinatorics/cartesian_product/extensions/array'
-require 'combinatorics/cartesian_product/extensions/set'
+# frozen_string_literal: true
+
+require_relative 'extensions/array'
+require_relative 'extensions/set'

data/lib/combinatorics/cartesian_product/mixin.rb

@@ -1,4 +1,6 @@
-require 'combinatorics/list_comprehension'
+# frozen_string_literal: true
+
+require_relative '../list_comprehension'
 
 module Combinatorics
   module CartesianProduct

data/lib/combinatorics/cartesian_product.rb

@@ -1,3 +1,5 @@
-require 'combinatorics/cartesian_product/mixin'
-require 'combinatorics/cartesian_product/extensions'
-require 'combinatorics/cartesian_product/cardinality'
+# frozen_string_literal: true
+
+require_relative 'cartesian_product/mixin'
+require_relative 'cartesian_product/extensions'
+require_relative 'cartesian_product/cardinality'

data/lib/combinatorics/choose/cardinality.rb

@@ -1,4 +1,6 @@
-require 'combinatorics/extensions/math'
+# frozen_string_literal: true
+
+require_relative '../extensions/math'
 
 module Combinatorics
   #
@@ -38,7 +40,7 @@ module Combinatorics
       raise(RangeError,"n must be non-negative") if n < 0
 
       case r
-      when 0   then 0
+      when 0   then 1
       when nil then Math.factorial(n)
       else
         Math.factorial(n) / (Math.factorial(r) * Math.factorial(n - r))

data/lib/combinatorics/choose/extensions/array.rb

@@ -1,4 +1,6 @@
-require 'combinatorics/choose/mixin'
+# frozen_string_literal: true
+
+require_relative '../mixin'
 
 class Array
   include Combinatorics::Choose::Mixin

data/lib/combinatorics/choose/extensions/set.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
+require_relative '../mixin'
+
 require 'set'
-require 'combinatorics/choose/mixin'
 
 class Set
   include Combinatorics::Choose::Mixin

data/lib/combinatorics/choose/extensions.rb

@@ -1,2 +1,4 @@
-require 'combinatorics/choose/extensions/array'
-require 'combinatorics/choose/extensions/set'
+# frozen_string_literal: true
+
+require_relative 'extensions/array'
+require_relative 'extensions/set'

data/lib/combinatorics/choose/mixin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Combinatorics

data/lib/combinatorics/choose.rb

@@ -1,3 +1,5 @@
-require 'combinatorics/choose/mixin'
-require 'combinatorics/choose/extensions'
-require 'combinatorics/choose/cardinality'
+# frozen_string_literal: true
+
+require_relative 'choose/mixin'
+require_relative 'choose/extensions'
+require_relative 'choose/cardinality'

data/lib/combinatorics/derange/cardinality.rb

@@ -1,4 +1,6 @@
-require 'combinatorics/extensions/math'
+# frozen_string_literal: true
+
+require_relative '../extensions/math'
 
 module Combinatorics
   module Derange

data/lib/combinatorics/derange/extensions/array.rb

@@ -1,4 +1,6 @@
-require 'combinatorics/derange/mixin'
+# frozen_string_literal: true
+
+require_relative '../mixin'
 
 class Array
   include Combinatorics::Derange::Mixin

data/lib/combinatorics/derange/extensions.rb

@@ -1 +1,3 @@
-require 'combinatorics/derange/extensions/array'
+# frozen_string_literal: true
+
+require_relative 'extensions/array'

data/lib/combinatorics/derange/mixin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Combinatorics
   module Derange
     #

data/lib/combinatorics/derange.rb

@@ -1,3 +1,5 @@
-require 'combinatorics/derange/mixin'
-require 'combinatorics/derange/extensions'
-require 'combinatorics/derange/cardinality'
+# frozen_string_literal: true
+
+require_relative 'derange/mixin'
+require_relative 'derange/extensions'
+require_relative 'derange/cardinality'

data/lib/combinatorics/enumerator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'enumerator'
 
 module Combinatorics