ruby-statistics 3.0.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5708aa695b3da8169acd11eade4bd66fb882176031dcb246217c25a8f07bfa66
-  data.tar.gz: 85e85043d9ff86f5b87fd9bd5fb0d447682919f4a2ad9bd6925c88efc62885f6
+  metadata.gz: 27e203f810d4efc877c5684b20397691a6c15ff0822bffd066806913514eca5b
+  data.tar.gz: 3585ea21ec02b2be95654010e0907ffa20ffa5ab59f5d8f3fa595f05e24378f3
 SHA512:
-  metadata.gz: c950d0983e6184e6372b0f4e1ba3306826b7260900062c44a3dad08cdbfbd7b2835b8df0f5974e1a89ae360efcda633e34c667d2b32aee743a5163d665075789
-  data.tar.gz: b04fe969caca5709430c7e5a213cbc5396359c49c42829d4f678266d7f207ce051d552a3820ff511198128c8f4ac3b5c7c2f4037664c225fdeed6830e3650d2a
+  metadata.gz: 2169076eca6216bbd847309b8c19eee02811cf4ec1e2f7684b998a874058449444b3410101f179ad31f169a6337350d871a1fbb47832a92017cbf256fdde00c4
+  data.tar.gz: b004115fe3d165e1a82304c4194176edfa6827693f5a428818068eaee04f7c2b60e638cbdfd5a3a3cf664b2a6eba4432282ce48b2e00a2900c2d376348bff56e

data/.github/workflows/ruby.yml

@@ -1,6 +1,6 @@
 name: Ruby
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build: # Latest ruby
@@ -8,27 +8,27 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby 3.1
-      uses: ruby/setup-ruby@v1.146.0
+    - uses: actions/checkout@v4
+    - name: Set up Ruby 3.3
+      uses: ruby/setup-ruby@v1.183.0
       with:
-        ruby-version: 3.1.2
+        ruby-version: 3.3
     - name: Build and test with Rake
       run: |
         gem install bundler
         bundle install --jobs 2 --retry 1
         bundle exec rake
 
-  build_2_7:
+  build_3_2:
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby 2.7
-      uses: ruby/setup-ruby@v1.146.0
+    - uses: actions/checkout@v4
+    - name: Set up Ruby 3.2
+      uses: ruby/setup-ruby@v1.183.0
       with:
-        ruby-version: 2.7.6
+        ruby-version: 3.2
     - name: Build and test with Rake
       run: |
         gem install bundler
@@ -40,11 +40,27 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby 3.0
-      uses: ruby/setup-ruby@v1.146.0
+      uses: ruby/setup-ruby@v1.183.0
+      with:
+        ruby-version: 3.0
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 2 --retry 1
+        bundle exec rake
+
+  build_3_1:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby 3.1
+      uses: ruby/setup-ruby@v1.183.0
       with:
-        ruby-version: 3.0.4
+        ruby-version: 3.1
     - name: Build and test with Rake
       run: |
         gem install bundler

data/README.md

@@ -1,13 +1,18 @@
 # Ruby Statistics
+![](https://github.com/estebanz01/ruby-statistics/actions/workflows/ruby.yml/badge.svg)
 
-![](https://travis-ci.org/estebanz01/ruby-statistics.svg?branch=master)
+## Note regarding Versions 3.x and 4.x
+Hola! :wave: right now the gem got an update that introduced a breaking change in master where the Outermost namespace was changed to be `ruby_statistics` instead of `statistics`. This change is in _master_ already but not yet released. If you're relying on branch instead of gem version, you can checkout branch `3.x`. This branch will be supported but no additional features will be added.
+
+---
 
 A basic ruby gem that implements some statistical methods, functions and concepts to be used in any ruby environment without depending on any mathematical software like `R`, `Matlab`, `Octave` or similar.
 
 Unit test runs under the following ruby versions:
-* Ruby 2.7.6.
-* Ruby 3.0.4.
-* Ruby 3.1.2.
+* Ruby 3.0.
+* Ruby 3.1.
+* Ruby 3.2.
+* Ruby 3.3.
 
 We got the inspiration from the folks at [JStat](https://github.com/jstat/jstat) and some interesting lectures about [Keystroke dynamics](http://www.biometric-solutions.com/keystroke-dynamics.html).
 
@@ -32,22 +37,22 @@ Or install it yourself as:
 
 ## Basic Usage
 
-just require the `statistics` gem in order to load it. If you don't have defined the `Distribution` namespace, the gem will assign an alias, reducing the number of namespaces needed to use a class.
+just require the `ruby-statistics` gem in order to load it. If you don't have defined the `Distribution` namespace, the gem will assign an alias, reducing the number of namespaces needed to use a class.
 
 Right now you can load:
 
-* The whole statistics gem. `require 'statistics'`
-* A namespace. `require 'statistics/distribution'`
-* A class. `require 'statistics/distribution/normal'`
+* The whole statistics gem. `require 'ruby-statistics'`
+* A namespace. `require 'ruby-statistics/distribution'`
+* A class. `require 'ruby-statistics/distribution/normal'`
 
 Feel free to use the one that is more convenient to you.
 
 ### Hello-World Example
 ```ruby
-require 'statistics'
+require 'ruby-statistics'
 
 poisson = Distribution::Poisson.new(l) # Using Distribution alias.
-normal = Statistics::Distribution::StandardNormal.new # Using all namespaces.
+normal = RubyStatistics::Distribution::StandardNormal.new # Using all namespaces.
 ```
 
 ## Documentation
@@ -69,7 +74,7 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the Statistics project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/estebanz01/ruby-statistics/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RubyStatistics project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/estebanz01/ruby-statistics/blob/master/CODE_OF_CONDUCT.md).
 
 ## Contact
 

data/lib/math.rb

@@ -45,8 +45,11 @@ module Math
   end
 
   def self.lower_incomplete_gamma_function(s, x)
+    base_iterator = x.round(1)
+    base_iterator += 1 if x < 1.0 && !x.zero?
+
     # The greater the iterations, the better. That's why we are iterating 10_000 * x times
-    iterator = (10_000 * x.round(1)).round
+    iterator = (10_000 * base_iterator).round
     iterator = 100_000 if iterator.zero?
 
     self.simpson_rule(0, x.to_r, iterator) do |t|

data/lib/{statistics → ruby-statistics}/distribution/bernoulli.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class Bernoulli
       def self.density_function(n, p)

data/lib/{statistics → ruby-statistics}/distribution/beta.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class Beta
       attr_accessor :alpha, :beta

data/lib/{statistics → ruby-statistics}/distribution/binomial.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class Binomial
       attr_accessor :number_of_trials, :probability_per_trial

data/lib/{statistics → ruby-statistics}/distribution/chi_squared.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class ChiSquared
       attr_accessor :degrees_of_freedom
@@ -10,8 +10,13 @@ module Statistics
       end
 
       def cumulative_function(value)
-        k = degrees_of_freedom/2.0
-        Math.lower_incomplete_gamma_function(k, value/2.0)/Math.gamma(k)
+        if degrees_of_freedom == 2
+          # Special case where DF = 2 https://en.wikipedia.org/wiki/Chi-squared_distribution#Cumulative_distribution_function
+          1.0 - Math.exp((-1.0 * value / 2.0))
+        else
+          k = degrees_of_freedom/2.0
+          Math.lower_incomplete_gamma_function(k, value/2.0)/Math.gamma(k)
+        end
       end
 
       def density_function(value)

data/lib/{statistics → ruby-statistics}/distribution/empirical.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class Empirical
       attr_accessor :samples

data/lib/{statistics → ruby-statistics}/distribution/f.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class F
       attr_accessor :d1, :d2 # Degrees of freedom #1 and #2

data/lib/{statistics → ruby-statistics}/distribution/geometric.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class Geometric
       attr_accessor :probability_of_success, :always_success_allowed

data/lib/{statistics → ruby-statistics}/distribution/logseries.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class LogSeries
       def self.density_function(k, p)

data/lib/{statistics → ruby-statistics}/distribution/negative_binomial.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class NegativeBinomial
       attr_accessor :number_of_failures, :probability_per_trial

data/lib/{statistics → ruby-statistics}/distribution/normal.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class Normal
       attr_accessor :mean, :standard_deviation, :variance

data/lib/{statistics → ruby-statistics}/distribution/poisson.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class Poisson
       attr_accessor :expected_number_of_occurrences

data/lib/{statistics → ruby-statistics}/distribution/t_student.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class TStudent
       attr_accessor :degrees_of_freedom

data/lib/{statistics → ruby-statistics}/distribution/uniform.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class Uniform
       attr_accessor :left, :right

data/lib/{statistics → ruby-statistics}/distribution/weibull.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module Distribution
     class Weibull
       attr_accessor :shape, :scale # k and lambda

data/lib/{statistics → ruby-statistics}/distribution.rb

@@ -1,6 +1,6 @@
 Dir[File.dirname(__FILE__) + '/distribution/**/*.rb'].each {|file| require file }
 
-module Statistics
+module RubyStatistics
   module Distribution
   end
 end

data/lib/{statistics → ruby-statistics}/spearman_rank_coefficient.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   class SpearmanRankCoefficient
     def self.rank(data:, return_ranks_only: true)
       descending_order_data = data.sort { |a, b| b <=> a }

data/lib/{statistics → ruby-statistics}/statistical_test/chi_squared_test.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module StatisticalTest
     class ChiSquaredTest
       def self.chi_statistic(expected, observed)

data/lib/{statistics → ruby-statistics}/statistical_test/f_test.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module StatisticalTest
     class FTest
       # This method calculates the one-way ANOVA F-test statistic.

data/lib/{statistics → ruby-statistics}/statistical_test/kolmogorov_smirnov_test.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module StatisticalTest
     class KolmogorovSmirnovTest
       # Common alpha, and critical D are calculated following formulas from: https://en.wikipedia.org/wiki/Kolmogorov%E2%80%93Smirnov_test#Two-sample_Kolmogorov%E2%80%93Smirnov_test

data/lib/{statistics → ruby-statistics}/statistical_test/t_test.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module StatisticalTest
     class TTest
       # Errors for Zero std

data/lib/{statistics → ruby-statistics}/statistical_test/wilcoxon_rank_sum_test.rb

@@ -1,4 +1,4 @@
-module Statistics
+module RubyStatistics
   module StatisticalTest
     class WilcoxonRankSumTest
       def rank(elements)

data/lib/{statistics → ruby-statistics}/statistical_test.rb

@@ -1,11 +1,11 @@
 Dir[File.dirname(__FILE__) + '/statistical_test/**/*.rb'].each {|file| require file }
 
-module Statistics
+module RubyStatistics
   module StatisticalTest
   end
 end
 
 # If StatisticalTest is not defined, setup alias.
-if defined?(Statistics) && !(defined?(StatisticalTest))
-  StatisticalTest = Statistics::StatisticalTest
+if defined?(RubyStatistics) && !(defined?(StatisticalTest))
+  StatisticalTest = RubyStatistics::StatisticalTest
 end

data/lib/ruby-statistics/version.rb

@@ -0,0 +1,3 @@
+module RubyStatistics
+  VERSION = "4.0.0"
+end

data/lib/statistics.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/enumerable'
 require File.dirname(__FILE__) + '/math'
-Dir[ File.dirname(__FILE__) + '/statistics/**/*.rb'].each {|file| require file }
+Dir[ File.dirname(__FILE__) + '/ruby-statistics/**/*.rb'].each {|file| require file }
 
-module Statistics
+module RubyStatistics
   # Your code goes here...
 end

data/ruby-statistics.gemspec

@@ -1,13 +1,13 @@
 # coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "statistics/version"
+require "ruby-statistics/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ruby-statistics"
-  spec.version       = Statistics::VERSION
+  spec.version       = RubyStatistics::VERSION
   spec.authors       = ["esteban zapata"]
-  spec.email         = ["estebanz01@outlook.com"]
+  spec.email         = ["ruby@estebanz.email"]
 
   spec.summary       = %q{A ruby gem for som specific statistics. Inspired by the jStat js library.}
   spec.description   = %q{This gem is intended to accomplish the same purpose as jStat js library:
@@ -27,9 +27,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake", '>= 12.0.0', '~> 13.0'
-  spec.add_development_dependency "rspec", '>= 3.6.0'
-  spec.add_development_dependency "grb", '~> 0.4.1', '>= 0.4.1'
-  spec.add_development_dependency 'byebug', '>= 9.1.0'
-  spec.add_development_dependency 'pry'
+  # Minimum required ruby version
+  spec.required_ruby_version = '>= 3.0'
+
+  spec.add_development_dependency "rake", '~> 13.0', '>= 12.0.0'
+  spec.add_development_dependency "rspec", '~> 3.6', '>= 3.6.0'
+  spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.0'
+  spec.add_development_dependency 'pry', '~> 0.14', '>= 0.14.0'
 end

metadata

@@ -1,97 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: ruby-statistics
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 4.0.0
 platform: ruby
 authors:
 - esteban zapata
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.0.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
-  name: grb
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 9.1.0
+        version: 11.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 9.1.0
+        version: 11.1.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
 description: |-
   This gem is intended to accomplish the same purpose as jStat js library:
                             to provide ruby with statistical capabilities without the need
@@ -99,7 +97,7 @@ description: |-
                             and capabilities are an implementation from other authors and are
                             referenced properly in the class/method.
 email:
-- estebanz01@outlook.com
+- ruby@estebanz.email
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -120,30 +118,30 @@ files:
 - bin/setup
 - lib/enumerable.rb
 - lib/math.rb
+- lib/ruby-statistics/distribution.rb
+- lib/ruby-statistics/distribution/bernoulli.rb
+- lib/ruby-statistics/distribution/beta.rb
+- lib/ruby-statistics/distribution/binomial.rb
+- lib/ruby-statistics/distribution/chi_squared.rb
+- lib/ruby-statistics/distribution/empirical.rb
+- lib/ruby-statistics/distribution/f.rb
+- lib/ruby-statistics/distribution/geometric.rb
+- lib/ruby-statistics/distribution/logseries.rb
+- lib/ruby-statistics/distribution/negative_binomial.rb
+- lib/ruby-statistics/distribution/normal.rb
+- lib/ruby-statistics/distribution/poisson.rb
+- lib/ruby-statistics/distribution/t_student.rb
+- lib/ruby-statistics/distribution/uniform.rb
+- lib/ruby-statistics/distribution/weibull.rb
+- lib/ruby-statistics/spearman_rank_coefficient.rb
+- lib/ruby-statistics/statistical_test.rb
+- lib/ruby-statistics/statistical_test/chi_squared_test.rb
+- lib/ruby-statistics/statistical_test/f_test.rb
+- lib/ruby-statistics/statistical_test/kolmogorov_smirnov_test.rb
+- lib/ruby-statistics/statistical_test/t_test.rb
+- lib/ruby-statistics/statistical_test/wilcoxon_rank_sum_test.rb
+- lib/ruby-statistics/version.rb
 - lib/statistics.rb
-- lib/statistics/distribution.rb
-- lib/statistics/distribution/bernoulli.rb
-- lib/statistics/distribution/beta.rb
-- lib/statistics/distribution/binomial.rb
-- lib/statistics/distribution/chi_squared.rb
-- lib/statistics/distribution/empirical.rb
-- lib/statistics/distribution/f.rb
-- lib/statistics/distribution/geometric.rb
-- lib/statistics/distribution/logseries.rb
-- lib/statistics/distribution/negative_binomial.rb
-- lib/statistics/distribution/normal.rb
-- lib/statistics/distribution/poisson.rb
-- lib/statistics/distribution/t_student.rb
-- lib/statistics/distribution/uniform.rb
-- lib/statistics/distribution/weibull.rb
-- lib/statistics/spearman_rank_coefficient.rb
-- lib/statistics/statistical_test.rb
-- lib/statistics/statistical_test/chi_squared_test.rb
-- lib/statistics/statistical_test/f_test.rb
-- lib/statistics/statistical_test/kolmogorov_smirnov_test.rb
-- lib/statistics/statistical_test/t_test.rb
-- lib/statistics/statistical_test/wilcoxon_rank_sum_test.rb
-- lib/statistics/version.rb
 - ruby-statistics.gemspec
 homepage: https://github.com/estebanz01/ruby-statistics
 licenses:
@@ -157,14 +155,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A ruby gem for som specific statistics. Inspired by the jStat js library.

data/lib/statistics/version.rb

@@ -1,3 +0,0 @@
-module Statistics
-  VERSION = "3.0.2"
-end