more_math 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 347b633c7b95cb4728828e2dcad06f04f824e340d72dc4192b0d81b7e3a2df6e
-  data.tar.gz: 5e1bd55c18723aa18ccab2b7c916811ba8c84f2fb251bcaeb323575da045f7d3
+  metadata.gz: c42927d3e4f06cdd3b537401bf26422447248d56e554781750353aafa76c666b
+  data.tar.gz: fbaa4f37db092645de5094a459fff9b481ad9ac08587a74c5508cabf37a6766c
 SHA512:
-  metadata.gz: 41d4ce4dff93f65ef91cd5b414f205b8a64567d148586d2dd7d09f0327aafc802fb655ccdbe6e44da29241cb86f863ffa38104b0d13aa3cc34b2061049db18fe
-  data.tar.gz: bbd8bcfcb4fb17b3ad5ada2e069e1d969429de1f39c2d21305a4e8d7e56dbe3f96ec3d00411428711f82aa89293c2d15d5c028947250bc7f1670408971b1494d
+  metadata.gz: e82bf4a9ca64b19cfc849a63432616034443288a88902bbd71b54ec14775a1d7160c980029cd164faa98af98d55a51f02bb519dae3dfb69ff62ab9ab97e74016
+  data.tar.gz: 2cd4622f364dd5fadbf3160f2ce8548a8cbe180526fe20c21f9a804475c58f3e2423a58131febdf844fd2a1eb585b477ecf914a4e8cf0a884f6934afd0a54097

data/CHANGES.md

@@ -1,5 +1,31 @@
 # Changes
 
+## 2025-12-19 v1.7.0
+
+- Updated `bundle update` command to `bundle update --all` in `.all_images.yml`
+- Added `ruby:4.0-rc-alpine` image configuration to `.all_images.yml`
+- Added `lib/more_math/lambert.rb` to `s.extra_rdoc_files` and `s.files` in
+  `more_math.gemspec`
+- Added `tests/lambert_test.rb` to `s.test_files` in `more_math.gemspec`
+- Updated `s.rubygems_version` from **3.6.9** to **4.0.2** in
+  `more_math.gemspec`
+- Updated `s.add_development_dependency` for `gem_hadar` from "~> 2.7" to "~>
+  2.10" in `more_math.gemspec`
+- Added `openssl-dev` to the list of packages installed by `apk add` in
+  `.all_images.yml`
+- Rely on `test_helper` requiring `more_math`
+- Added `MoreMath::Lambert` module with `lambert_w` method for principal branch
+- Integrated `MoreMath::Lambert` into `MoreMath::Functions` module
+- Included comprehensive test suite in `TestLambertW` class
+- Added YARD documentation with examples and parameter descriptions
+- Required `more_math/lambert` in `more_math/functions.rb`
+- Supported special cases: W(0)=0, W(∞)=∞, W(-1/e)=-1
+- Verified solution property: W(y)·e^(W(y)) = y
+- Handled domain error for y < -1/e with NaN return
+- Used `MoreMath::NewtonBisection` for robust numerical root finding
+- Tests cover values: 0, 1, 100, 0.1, 1000 with expected results
+- Tested convergence verification and edge cases
+
 ## 2025-09-30 v1.6.0
 
 - Replaced detailed feature sections in README with a concise bullet list of

data/lib/more_math/functions.rb

@@ -1,4 +1,5 @@
 require 'more_math/entropy'
+require 'more_math/lambert'
 
 module MoreMath
   # Provides mathematical functions and special functions for scientific computing.
@@ -345,5 +346,7 @@ module MoreMath
 
     # Includes entropy calculations functionality
     include Entropy
+    # Include lambert W function
+    include Lambert
   end
 end

data/lib/more_math/lambert.rb

@@ -0,0 +1,44 @@
+module MoreMath
+  # Provides the Lambert W function implementation for solving equations of the
+  # form x * e^x = y
+  #
+  # The Lambert W function is a special function that solves the implicit
+  # equation x * e^x = y for x in terms of y. It has applications in various
+  # fields including combinatorics, physics, and engineering problems involving
+  # exponential growth and decay.
+  module Lambert
+    # Calculates the principal branch of the Lambert W function (W₀).
+    #
+    # The Lambert W function solves the equation: x * e^x = y
+    #
+    # @param y [Numeric] The input value for which to calculate W(y)
+    # @param epsilon [Float] Convergence threshold for the root finding algorithm
+    # @return [Float] The principal branch of the Lambert W function W(y)
+    # @raise [Math::DomainError] When y < -1/e (function is undefined for real numbers)
+    #
+    # @example Calculate W(1)
+    #   MoreMath::Lambert.lambert_w(1)  # => 0.5671432904097838
+    #
+    # @example Calculate W(0)
+    #   MoreMath::Lambert.lambert_w(0)  # => 0.0
+    #
+    # @example Calculate W(-1/e)
+    #   MoreMath::Lambert.lambert_w(-1.0 / Math::E)  # => -1.0
+    #
+    # @example Calculate W(100)
+    #   MoreMath::Lambert.lambert_w(100)  # => 3.432480170522278
+    def lambert_w(y, epsilon = 1E-16)
+      # Handle special cases
+      return 0.0 if y.zero?
+      return Float::INFINITY if y.infinite?
+      return -1.0 if (y - -1.0 / Math::E).abs < epsilon
+      return 0 / 0.0 if y <= -1.0 / Math::E
+
+      # Define the function f(x) = x * e^x - y
+      func = ->(x) { x * Math.exp(x) - y }
+
+      solver = MoreMath::NewtonBisection.new(&func)
+      solver.solve(nil, 1 << 16, epsilon)
+    end
+  end
+end

data/lib/more_math/version.rb

@@ -1,6 +1,6 @@
 module MoreMath
   # MoreMath version
-  VERSION         = '1.6.0'
+  VERSION         = '1.7.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,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: more_math 1.6.0 ruby lib
+# stub: more_math 1.7.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "more_math".freeze
-  s.version = "1.6.0".freeze
+  s.version = "1.7.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -11,19 +11,19 @@ Gem::Specification.new do |s|
   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]
-  s.files = ["CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".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, "more_math.gemspec".freeze, "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.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/lambert.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]
+  s.files = ["CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".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/lambert.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, "more_math.gemspec".freeze, "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/lambert_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.homepage = "https://github.com/flori/more_math".freeze
   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.6.9".freeze
+  s.rubygems_version = "4.0.2".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.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/lambert_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, ["~> 2.7".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.10".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/cantor_pairing_function_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class CantorPairingFunctionTest < Test::Unit::TestCase
   include MoreMath::Functions

data/tests/continued_fraction_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class ContinuedFractionTest < Test::Unit::TestCase
   include MoreMath

data/tests/distribution_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class DistributionTest < Test::Unit::TestCase
   include MoreMath

data/tests/entropy_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class EntropyTest < Test::Unit::TestCase
   include MoreMath::Functions

data/tests/functions_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class FunctionsTest < Test::Unit::TestCase
   include MoreMath::Functions

data/tests/histogram_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 require 'stringio'
 
 class HistogramTest < Test::Unit::TestCase

data/tests/lambert_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+class TestLambertW < Test::Unit::TestCase
+  include MoreMath::Functions
+
+  def setup
+    @delta = 1e-10
+  end
+
+  def test_lambert_w_zero
+    result = lambert_w(0)
+    assert_in_delta(0.0, result, @delta)
+  end
+
+  def test_lambert_w_infinity
+    result = lambert_w(Float::INFINITY)
+    assert_equal(Float::INFINITY, result)
+  end
+
+  def test_lambert_w_negative_one_over_e
+    result = lambert_w(-1.0 / Math::E)
+    assert_in_delta(-1.0, result, @delta)
+  end
+
+  def test_lambert_w_positive_value
+    result = lambert_w(1)
+    expected = 0.5671432904097838
+    assert_in_delta(expected, result, @delta)
+  end
+
+  def test_lambert_w_large_positive_value
+    result = lambert_w(100)
+    expected = 3.3856301402900501
+    assert_in_delta(expected, result, @delta)
+  end
+
+  def test_lambert_w_small_positive_value
+    result = lambert_w(0.1)
+    expected = 0.091276527160862
+    assert_in_delta(expected, result, @delta)
+  end
+
+  def test_lambert_w_verify_solution_property
+    y = 5.0
+    w = lambert_w(y)
+    result = w * Math.exp(w)
+    assert_in_delta(y, result, @delta)
+  end
+
+  def test_lambert_w_verify_solution_property_large
+    y = 1000.0
+    w = lambert_w(y)
+    result = w * Math.exp(w)
+    assert_in_delta(y, result, @delta)
+  end
+
+  def test_lambert_w_domain_error
+    result = lambert_w(-1.0 / Math::E - 0.1)
+    assert(result.nan?)
+  end
+
+  def test_lambert_w_edge_case
+    y = 1e-10
+    w = lambert_w(y)
+    result = w * Math.exp(w)
+    assert_in_delta(y, result, @delta)
+  end
+end

data/tests/newton_bisection_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class NewtonBisectionTest < Test::Unit::TestCase
   include MoreMath

data/tests/numberify_string_function_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class NumberifyStringFunctionTest < Test::Unit::TestCase
   include MoreMath::Functions

data/tests/permutation_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class PermutationTest < Test::Unit::TestCase
   include MoreMath

data/tests/sequence/refinement_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 using MoreMath::Sequence::Refinement
 
@@ -10,4 +9,3 @@ class SequenceTest < Test::Unit::TestCase
     assert_kind_of MoreMath::Sequence, [1,2,3].to_seq
   end
 end
-

data/tests/sequence_moving_average_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class SequenceMovingAverageTest < Test::Unit::TestCase
   include MoreMath
@@ -28,4 +27,3 @@ class SequenceMovingAverageTest < Test::Unit::TestCase
     assert_equal [ @seq.mean ], @seq.moving_average(5)
   end
 end
-

data/tests/sequence_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class SequenceTest < Test::Unit::TestCase
   include MoreMath

data/tests/string_numeral_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class StringNumeralTest < Test::Unit::TestCase
   include MoreMath

data/tests/subset_test.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test_helper'
-require 'more_math'
 
 class SubsetTest < Test::Unit::TestCase
   include MoreMath

data/tests/test_helper.rb

@@ -1,3 +1,4 @@
 require 'gem_hadar/simplecov'
 GemHadar::SimpleCov.start
 require 'test/unit'
+require 'more_math'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: more_math
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +151,7 @@ extra_rdoc_files:
 - lib/more_math/exceptions.rb
 - lib/more_math/functions.rb
 - lib/more_math/histogram.rb
+- lib/more_math/lambert.rb
 - lib/more_math/linear_regression.rb
 - lib/more_math/newton_bisection.rb
 - lib/more_math/numberify_string_function.rb
@@ -177,6 +178,7 @@ files:
 - lib/more_math/exceptions.rb
 - lib/more_math/functions.rb
 - lib/more_math/histogram.rb
+- lib/more_math/lambert.rb
 - lib/more_math/linear_regression.rb
 - lib/more_math/newton_bisection.rb
 - lib/more_math/numberify_string_function.rb
@@ -195,6 +197,7 @@ files:
 - tests/entropy_test.rb
 - tests/functions_test.rb
 - tests/histogram_test.rb
+- tests/lambert_test.rb
 - tests/newton_bisection_test.rb
 - tests/numberify_string_function_test.rb
 - tests/permutation_test.rb
@@ -226,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.2
 specification_version: 4
 summary: Library that provides more mathematics.
 test_files:
@@ -236,6 +239,7 @@ test_files:
 - tests/entropy_test.rb
 - tests/functions_test.rb
 - tests/histogram_test.rb
+- tests/lambert_test.rb
 - tests/newton_bisection_test.rb
 - tests/numberify_string_function_test.rb
 - tests/permutation_test.rb