more_math 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72c52f7fecd9e87621f806bf86d7063f7aae2aef24e539d1d20182d5513bbd8f
-  data.tar.gz: 84a63a576ca178c7cefc591ba8373260259dfed4a83ec1c536817afce466c2b7
+  metadata.gz: d25fc8ea948e2f09f3ef35f3f7a583d113d17e3583502b2a4ad557761b32724d
+  data.tar.gz: bf6aab31d4d12fdc44772c2ee55deee97b4e8b84f7843358e56ca56660f9b58b
 SHA512:
-  metadata.gz: 56ba92f6abcdc5b305f8069ce562418d799b9eeeab777e7b47b1c9b69a9cb1a61c69403750da8ecc59bb1d69a11b8ddca3fa40b18031e63d401550b2690acf67
-  data.tar.gz: 0cf1a0cab01791ff617910f4840ba58f1b14257b3bc611ece8085880ee1164abf20d2c8f3394108052c51a4ef00868d6d0b613146565dcd71ebbec2b08edca07
+  metadata.gz: dbfe1ea14d17e3726f9f72db9c14951aca55469856b09ba6181ae03629d8f02b175e244b4cda741bee3b8db9484a1ca8e6c4f6b6d1f9dfe5eea34aab33c9f815
+  data.tar.gz: e5b7f1d6746cfd26c1842e8a849ae4c4f73b7d8a139e6c7543e3b6f3620a5ecc4e49098a5ea1f870a5c4b305ec8a0959553add44e893860755e7677321b3cc04

data/CHANGES.md

@@ -1,49 +1,59 @@
 # Changes
 
+## 2025-07-12 v1.4.0
+
+* Updated `project` method in Subset class with associated tests
+  + Maps dataset elements based on subset indices
+  + Ensures data size validation
+  + Comprehensive test cases for `project` functionality
+* Added a list of features and example usage of the library in README
+* Updated bundler behavior to clean up Gemfile.lock before installing gems
+* Removed obsolete `binary` option from discover block in utility functions
+
 ## 2024-09-30 v1.3.0
 
 * **Added support for displaying histograms based on percentage of terminal width**
-	+ Added `terminal_width` method to `Histogram` class
-	+ Updated `display` method to take interpret the `width` parameter as a percentage string, e.g. `75%`
-	+ Updated test cases to use the new `display` method with different widths
-	+ Added a new test case for displaying histograms with counts and `75%` width
+  + Added `terminal_width` method to `Histogram` class
+  + Updated `display` method to take interpret the `width` parameter as a percentage string, e.g. `75%`
+  + Updated test cases to use the new `display` method with different widths
+  + Added a new test case for displaying histograms with counts and `75%` width
 
 ## 2024-09-30 v1.2.2
 
 ### Improvements
 * Refactor Histogram display logic for better UTF-8 support:
-	+ Extracted `output_row_with_count` and `output_row_without_count` methods
-	+ Updated test cases for histogram display with counts and UTF-8 support
+  + Extracted `output_row_with_count` and `output_row_without_count` methods
+  + Updated test cases for histogram display with counts and UTF-8 support
 * Update Rakefile to ignore `.utilsrc` file:
-	- Add `.utilsrc` to `package_ignore` list in Rakefile
+  - Add `.utilsrc` to `package_ignore` list in Rakefile
 
 ## 2024-09-30 v1.2.1
 
 * Refactor histogram display logic for utf8 and ascii bars
-	+ *Improved `utf8_bar` method to handle fractional bar widths.*
-	+ *Updated test case in `histogram_test.rb` to reflect changes.*
+  + *Improved `utf8_bar` method to handle fractional bar widths.*
+  + *Updated test case in `histogram_test.rb` to reflect changes.*
 
 ## 2024-09-30 v1.2.0
 
 #### Significant Changes
 
 * Bumped version to **1.2.0**
-	+ Updated `VERSION` in `lib/more_math/version.rb`
-	+ Updated gemspec version and date
-	+ Bumped `gem_hadar` development dependency to **1.18.0**
+  + Updated `VERSION` in `lib/more_math/version.rb`
+  + Updated gemspec version and date
+  + Bumped `gem_hadar` development dependency to **1.18.0**
 * Update Ruby version check in `.all_images.yml`
-	+ Added `--full-index` to `bundle` command
+  + Added `--full-index` to `bundle` command
 * Add UTF-8 support to histogram display
-	+ Added `utf8?` method to Histogram class
-	+ Modified `output_row` method to use UTF-8 bars with braille when possible
-	+ Added tests for UTF-8 histogram display with and without counts
+  + Added `utf8?` method to Histogram class
+  + Modified `output_row` method to use UTF-8 bars with braille when possible
+  + Added tests for UTF-8 histogram display with and without counts
 
 ## 2024-08-28 v1.1.0
 
 * **Added** `interquartile_range` method to `MoreMath::Sequence`
-	+ Significant changes:
-		- Added `interquartile_range` method to `MoreMath::Sequence`
-		- Updated test cases for `sequence_test.rb`
+  + Significant changes:
+    - Added `interquartile_range` method to `MoreMath::Sequence`
+    - Updated test cases for `sequence_test.rb`
 * **Updated** all_images.yml to include Ruby **3.3**
 
 ## 2024-07-03 v1.0.2
@@ -51,16 +61,16 @@
 * Use github as homepage for rubygems
 * Only test newer ruby versions
 * Fine tune width settings a bit, and raise error when invalid arguments are provided:
-	+ Method: `code`**width_settings**
-	+ Variable: `code`**github_url**
+  + Method: `code`**width_settings**
+  + Variable: `code`**github_url**
 
 ## 2023-05-29 v1.0.1
 
 * **Fine-tuned** the width settings:
-	+ Raised an error when invalid arguments were provided
+  + Raised an error when invalid arguments were provided
 * Significant changes:
-	* Raised error when `stupid` arguments are given to width settings
-	* Updated width settings (no specific details available)
+  * Raised error when `stupid` arguments are given to width settings
+  * Updated width settings (no specific details available)
 
 ## 2023-05-26 v1.0.0
 
@@ -76,8 +86,8 @@
 * Use all_images instead of travis
 * Be compatible to older rubies
 * Adds predicate to check if ContinuedFraction is `#simple?` and add the standard […;…,…] notation for these.
-	+ Adds ContinuedFraction#reciprocal method.
-	+ Use keyword arguments for ContinuedFraction approximations instead of positional arguments.
+  + Adds ContinuedFraction#reciprocal method.
+  + Use keyword arguments for ContinuedFraction approximations instead of positional arguments.
 * Add exp log functions as well
 * Add erfc unless mixed in from Math already
 * Convert number to float b4 calculation
@@ -93,8 +103,8 @@
 ## 2017-07-04 v0.3.3
 
 * Added **1.0** version of the gem with a new feature:
-	+ Added `code`LICENSE = "MIT"` to Gemfile
-	+ Updated `code`gemspec.rb` with `code`SPDX-License-Identifier: MIT`
+  + Added `code`LICENSE = "MIT"` to Gemfile
+  + Updated `code`gemspec.rb` with `code`SPDX-License-Identifier: MIT`
 * No significant changes in this commit
 
 ## 2017-03-09 v0.3.2
@@ -111,20 +121,20 @@
 ## 2016-10-20 v0.3.1
 
 * **Corrected method name**
-	+ Changed `code`**_method_name_** to `code`**_correct_method_name_**
+  + Changed `code`**_method_name_** to `code`**_correct_method_name_**
 
 ## 2016-10-20 v0.3.0
 
 * **Significant Changes**
-	+ Bump version to **1.0** (commit)
-	+ Implement n-element moving average for Sequence in `Sequence` class
-	+ Add functions to compute entropy of texts in `EntropyCalculator` class
-	+ Refactor some methods in `continued_fraction.rb`
-	+ Ignore `.DS_Store` files
+  + Bump version to **1.0** (commit)
+  + Implement n-element moving average for Sequence in `Sequence` class
+  + Add functions to compute entropy of texts in `EntropyCalculator` class
+  + Refactor some methods in `continued_fraction.rb`
+  + Ignore `.DS_Store` files
 * Other changes:
-	+ Test ruby **2.3.1**
-	+ Add codeclimate configuration files
-	+ Add code climate coverage token
+  + Test ruby **2.3.1**
+  + Add codeclimate configuration files
+  + Add code climate coverage token
 
 ## 2015-05-21 v0.2.1
 
@@ -141,10 +151,10 @@
 #### New Features
 
 * Added Permutation features:
-	+ `identity`: Returns a permutation that leaves all elements unchanged.
-	+ `power`: Raises a permutation to a given power.
-	+ `from_mapping`: Creates a permutation from a given mapping.
-	Contributed by Pramukta Kumar <prak@mac.com>.
+  + `identity`: Returns a permutation that leaves all elements unchanged.
+  + `power`: Raises a permutation to a given power.
+  + `from_mapping`: Creates a permutation from a given mapping.
+  Contributed by Pramukta Kumar <prak@mac.com>.
 
 #### Configuration Changes
 
@@ -155,24 +165,24 @@
 ## 2011-12-25 v0.0.4
 
 * **Changes for Ruby 1.9.3 and 1.8**
-	+ Added support for `ruby 1.9.3` as a test target
-	+ Implemented `to_int` method for symbols in Ruby 1.8
+  + Added support for `ruby 1.9.3` as a test target
+  + Implemented `to_int` method for symbols in Ruby 1.8
 * Renamed test files
 
 ## 2011-10-28 v0.0.3
 
 * **Changes in version **bold**0.2.3**bold**:*
-	+ Added permutation class to more_math
-	+ Started power set implementation
-	+ Shared code between subset and permutation
-	+ Fixed small subset issues
-	+ Merged branch 'power_set' into power_set
-	+ Resolved conflicts in lib/more_math.rb, lib/more_math/ranking_common.rb, lib/more_math/subset.rb, and more_math.gemspec
+  + Added permutation class to more_math
+  + Started power set implementation
+  + Shared code between subset and permutation
+  + Fixed small subset issues
+  + Merged branch 'power_set' into power_set
+  + Resolved conflicts in lib/more_math.rb, lib/more_math/ranking_common.rb, lib/more_math/subset.rb, and more_math.gemspec
 
 ## 2011-09-26 v0.0.2
 
 * **Depend on tins library**
-	+ Added dependency on `tins` library.
+  + Added dependency on `tins` library.
 
 ## 2011-07-17 v0.0.1
 

data/README.md

@@ -2,20 +2,108 @@
 
 ## Description
 
-Ruby library that contains various mathematical functions and algorithms.
+Ruby library that contains various mathematical functions and algorithms,
+extending Ruby's capabilities in domains such as statistics, numerical
+analysis, and combinatorics.
 
-## Download
+### Core Features
 
-The homepage of this library is located at
+1. **Mathematical Functions**
+   - **Gamma Function**: Computes the gamma function for real numbers.
+   - **Beta Function**: Calculates the beta function and its regularized form.
+   - **Error Function (erf)**: Provides the error function used in probability
+     and statistics.
 
-*   http://github.com/flori/more_math
+2. **Special Functions**
+   - **Lambert W Function**: Solves equations of the form `x = a * exp(x)`.
+   - **Continued Fractions**: Evaluates continued fractions for various
+     mathematical expressions.
 
+3. **Statistical Tools**
+   - **Probability Distributions**: Implements distributions like Student's t,
+     chi-squared, and Fisher's z.
+   - **Random Number Generation**: Generates random numbers following specific
+     distributions.
+   - **Hypothesis Testing**: Performs tests like the Kolmogorov-Smirnov test
+     for distribution comparison.
+
+4. **Sequence Analysis**
+   - **Moving Averages**: Computes simple moving averages for time series data.
+   - **Autocorrelation and Autovariance**: Analyzes the correlation structure
+     of sequences.
+   - **Histograms**: Visualizes data distributions with customizable bins.
+
+5. **Combinatorics and Algorithms**
+   - **Permutations and Combinations**: Generates permutations, combinations,
+     and Cartesian products.
+   - **Graph Theory**: Includes algorithms for shortest paths (Dijkstra,
+     Floyd-Warshall) and minimum spanning trees.
+   - **Root Finding**: Uses Newton-Raphson and bisection methods to find roots
+     of functions.
+
+### Specialized Modules
+
+1. **String Numeral Conversion**
+   - Converts strings to Gödel numbers and vice versa using a specified
+   alphabet.
+
+2. **Cantor Pairing Function**
+   - Encodes tuples into a single integer and decodes them back, useful in set
+   theory and combinatorics.
+
+3. **Histograms**
+   - Creates histograms for data visualization with support for different
+   binning strategies.
+
+## Example Usage
+
+```ruby
+include MoreMath::Functions # include like you would ::Math
+
+# Compute the gamma function at 0.5
+puts gamma(0.5) # => 1.77245385091
+
+# Define a continued fraction representation of the arctangent function (atan)
+atan = ContinuedFraction.for_a do |n, x|
+  n == 0 ? 0 : 2 * n - 1
+end.for_b do |n, x|
+  n <= 1 ? x : ((n - 1) * x) ** 2
+end
+pi = -> (epsilon: 1E-16) { 4 * atan.(1, epsilon:) }
+puts pi.() # => 3.1415926535897936
+
+# Compute the moving average of an array
+sequence = [1, 2, 3, 4, 5]
+ma = Sequence.new(sequence).simple_moving_average(2)
+puts ma.inspect # => [1.5, 2.5, 3.5, 4.5]
+
+# Create a histogram with 3 bins, display it in on STDOUT with a width of 80 characters
+Histogram.new([1, 2, 3, 4, 5, 1], bins: 3).display(STDOUT, 80) ; nil
+#   4.33333 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+#   3.00000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡇
+#   1.66667 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+```
+
+## Installation
+
+To install `more_math`, run:
+
+```bash
+gem install more_math
+```
 
 ## Author
 
-Florian Frank mailto:flori@ping.de
+Florian Frank  
+mailto:flori@ping.de
 
 ## License
 
 This software is licensed under the X11 (or MIT) license:
 http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3
+
+## Homepage
+
+The homepage of this library is located at:
+
+* http://github.com/flori/more_math

data/lib/more_math/subset.rb

@@ -41,6 +41,13 @@ module MoreMath
       result
     end
 
-    # TODO project
+    # This method maps elements from a given dataset based on the
+    # subset's indices determined by its rank and returns the result, while
+    # ensuring the input data size matches the subset's size.
+    def project(data = nil)
+      data ||= @collection || (0...size).to_a
+      raise ArgumentError, "data size is != #{size}!" if data.size != size
+      value.map { |i| data[i] }
+    end
   end
 end

data/lib/more_math/version.rb

@@ -1,6 +1,6 @@
 module MoreMath
   # MoreMath version
-  VERSION         = '1.3.0'
+  VERSION         = '1.4.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/more_math.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: more_math 1.3.0 ruby lib
+# stub: more_math 1.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "more_math".freeze
-  s.version = "1.3.0".freeze
+  s.version = "1.4.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2024-09-30"
+  s.date = "1980-01-02"
   s.description = "Library that provides more mathematical functions/algorithms than standard Ruby.".freeze
   s.email = "flori@ping.de".freeze
   s.extra_rdoc_files = ["README.md".freeze, "lib/more_math.rb".freeze, "lib/more_math/cantor_pairing_function.rb".freeze, "lib/more_math/constants/functions_constants.rb".freeze, "lib/more_math/continued_fraction.rb".freeze, "lib/more_math/distributions.rb".freeze, "lib/more_math/entropy.rb".freeze, "lib/more_math/exceptions.rb".freeze, "lib/more_math/functions.rb".freeze, "lib/more_math/histogram.rb".freeze, "lib/more_math/linear_regression.rb".freeze, "lib/more_math/newton_bisection.rb".freeze, "lib/more_math/numberify_string_function.rb".freeze, "lib/more_math/permutation.rb".freeze, "lib/more_math/ranking_common.rb".freeze, "lib/more_math/sequence.rb".freeze, "lib/more_math/sequence/moving_average.rb".freeze, "lib/more_math/sequence/refinement.rb".freeze, "lib/more_math/string_numeral.rb".freeze, "lib/more_math/subset.rb".freeze, "lib/more_math/version.rb".freeze]
@@ -17,13 +17,13 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "MoreMath -- More Math in Ruby".freeze, "--main".freeze, "README.md".freeze]
   s.required_ruby_version = Gem::Requirement.new(">= 2.0".freeze)
-  s.rubygems_version = "3.5.18".freeze
+  s.rubygems_version = "3.6.9".freeze
   s.summary = "Library that provides more mathematics.".freeze
   s.test_files = ["tests/cantor_pairing_function_test.rb".freeze, "tests/continued_fraction_test.rb".freeze, "tests/distribution_test.rb".freeze, "tests/entropy_test.rb".freeze, "tests/functions_test.rb".freeze, "tests/histogram_test.rb".freeze, "tests/newton_bisection_test.rb".freeze, "tests/numberify_string_function_test.rb".freeze, "tests/permutation_test.rb".freeze, "tests/sequence/refinement_test.rb".freeze, "tests/sequence_moving_average_test.rb".freeze, "tests/sequence_test.rb".freeze, "tests/string_numeral_test.rb".freeze, "tests/subset_test.rb".freeze, "tests/test_helper.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.18.0".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.20".freeze])
   s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<test-unit>.freeze, [">= 0".freeze])

data/tests/subset_test.rb

@@ -19,4 +19,15 @@ class SubsetTest < Test::Unit::TestCase
     assert_equal expected, Subset.for([1, 2, 3]).map(&:value)
     assert_equal expected, Subset.power_set([1, 2, 3])
   end
+
+  def test_project
+    a      = %i[ a b c d e ]
+    subset = Subset.new(a.size, 23)
+    assert_raises(ArgumentError) { subset.project a + %i[ f ] }
+    (2 ** a.size).times do |i|
+      subset  = Subset.new(a.size, i)
+      projected = subset.project(a)
+      assert_equal(projected, Subset.power_set(a)[i])
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: more_math
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Florian Frank
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -195,7 +194,6 @@ homepage: https://github.com/flori/more_math
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--title"
 - MoreMath -- More Math in Ruby
@@ -214,8 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Library that provides more mathematics.
 test_files: