statistics.rb 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9db0156fb926432eb2d48821c410a0badec96b32dacd485893b0bdf8e7b25cb5
-  data.tar.gz: 77ac6c90e08b0017d1f66ad427ed0c5f0560ef1732fa79627bb0a2160eea292e
+  metadata.gz: 72207b38b9be8be456975d549e38cb32563f900d4f066170da98b991be69ff54
+  data.tar.gz: 7b06af6c2f260c12d896a5f6fe06544d03d3a8fb3832b173710dad95cb843383
 SHA512:
-  metadata.gz: 43cf596e2166e2cd345528dd6aae8aaadcf78e9bfe62cfe5f28903729bca2ae60a9b142796ab6ab699da57754b27480c4b7c07dae81c37f569f244064daa05f1
-  data.tar.gz: e0f26dd100a0741855f46b466b5c9c28a673f386c674a65feafe2cf5793f7353d4791dc54e1e4f1c95f2200724caefcbcc7901b71a830743f7cb97f653ba3692
+  metadata.gz: f35fc1c57fa9f3e46b86d423489e3d9fa057f7cf24423ffae38dfa4ddd47d47cbfce4251e93f79c640fdaae2a413f7f898463e67d85aea53470a1384a7f4d41d
+  data.tar.gz: 78f3ce433eabecb1979ea29ae4aaf8dff05290406476f1c8ba0672f4ee54d46887b79175b60091cc30c95a0a2ee000327f8127cf32c57011214bc10ededcf62f

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # CHANGELOG
 
+## [0.7.0] - 20260515
+## + cube\_root, freedman\_diaconis, scott, tuneable\_root, sturges bin width methods
+
+1. + Bin::METHODS, Bin::DEFAULT\_METHOD, Bin::DEFAULT\_FACTOR
+2. + Bin.cube\_root\_width, Bin.cube\_root\_count
+3. + Bin.tuneable\_root\_width, Bin.tuneable\_root\_count
+4. + Bin.freedman\_diaconis\_width, Bin.freedman\_diaconis\_count
+5. + Bin.scott\_width, Bin.scott\_count
+6. + Bin.sturges\_width, Bin.sturges\_count
+7. ~ Bin.width, Bin.count, Bin.boundaries: + factor: keyword argument (parameter of :tuneable\_root, defaults to DEFAULT\_FACTOR)
+8. + Bin.validate! (empty values, unknown method, non-positive factor)
+9. ~ Bin.data\_range: now private
+10. ~ Bin.rb: + require\_relative for IQR and StandardDeviation
+11. ~ Histogram#initialize: + factor: keyword argument, forwarded to Bin.width
+12. ~ test/Statistics/Bin\_test.rb: cases for new strategies, .count parity, validation
+13. + test/Statistics/Histogram\_test.rb: factor passthrough case
+14. ~ README.md: Document strategies; remove from Roadmap.
+15. ~ lib/Statistics/VERSION.rb: /0.6.1/0.7.0/
+
+
 ## [0.6.1] - 20260513
 ## Statistics::Histogram::Bin --> Statistics::Bin
 
@@ -11,6 +31,7 @@
 6. ~ README.md: + Contributions section
 7. ~ lib/Statistics/VERSION.rb: /0.6.0/0.6.1/
 
+
 ## [0.6.0] - 20260504
 ## + Percentile, StandardDeviation, IQR
 

data/README.md

@@ -42,6 +42,23 @@ Output:
 
 By default, bin width is calculated using the square root rule: `data_range / sqrt(n)`.
 
+Other strategies are available via the `method:` option:
+
+```ruby
+h = Statistics::Histogram.new(values, method: :square_root)       # default
+h = Statistics::Histogram.new(values, method: :cube_root)
+h = Statistics::Histogram.new(values, method: :freedman_diaconis)
+h = Statistics::Histogram.new(values, method: :scott)
+h = Statistics::Histogram.new(values, method: :sturges)
+```
+
+The `tuneable_root` method takes a `factor` (default `2.0`, equivalent to `square_root`):
+
+```ruby
+h = Statistics::Histogram.new(values, method: :tuneable_root, factor: 4.0)
+Statistics::Bin.width(values, method: :tuneable_root, factor: 4.0)
+```
+
 #### Manual bin width
 
 ```ruby
@@ -98,7 +115,6 @@ Statistics::IQR.of(values)  # => 4.5
 ## Roadmap
 
 - Optional per-bin value storage
-- Additional bin width methods (Freedman-Diaconis, Scott, Sturges, cube root, tuneable root)
 - Aligned/neat bin boundaries
 
 ## Contributing

data/lib/Statistics/Bin.rb

@@ -1,31 +1,43 @@
 # Statistics/Bin.rb
 # Statistics::Bin
 
+require_relative './IQR'
+require_relative './StandardDeviation'
+
 module Statistics
   class Bin
+    METHODS = [:square_root, :cube_root, :freedman_diaconis, :scott, :sturges, :tuneable_root].freeze
+    DEFAULT_METHOD = :square_root
+    DEFAULT_FACTOR = 2.0
+
     class << self
-      def width(values, bin_width: nil, bin_count: nil, method: :square_root)
+      def width(values, bin_width: nil, bin_count: nil, method: :square_root, factor: nil)
+        validate!(values, method: method, factor: factor)
         if bin_width
           bin_width
         elsif bin_count
           data_range(values) / bin_count.to_f
         elsif data_range(values) == 0
           1.0
+        elsif method == :tuneable_root
+          tuneable_root_width(values, factor || DEFAULT_FACTOR)
         else
           send("#{method}_width", values)
         end
       end
 
-      def count(values, method: :square_root)
-        send("#{method}_count", values)
-      end
-
-      def data_range(values)
-        values.last - values.first
+      def count(values, method: :square_root, factor: nil)
+        validate!(values, method: method, factor: factor)
+        if method == :tuneable_root
+          tuneable_root_count(values, factor || DEFAULT_FACTOR)
+        else
+          send("#{method}_count", values)
+        end
       end
 
-      def boundaries(values, bin_width: nil, bin_count: nil, method: :square_root)
-        w = bin_width || width(values, bin_count: bin_count, method: method)
+      def boundaries(values, bin_width: nil, bin_count: nil, method: :square_root, factor: nil)
+        validate!(values, method: method, factor: factor)
+        w = bin_width || width(values, bin_count: bin_count, method: method, factor: factor)
         values.first.step(to: values.last + w, by: w).to_a
       end
 
@@ -36,6 +48,10 @@ module Statistics
 
       private
 
+      def data_range(values)
+        values.last - values.first
+      end
+
       def index_for_value(value, bin_count, bottom_boundary, bin_width)
         i = ((value - bottom_boundary) / bin_width).floor
         i >= bin_count ? bin_count - 1 : i
@@ -48,6 +64,52 @@ module Statistics
       def square_root_count(values)
         Math.sqrt(values.size).ceil
       end
+
+      def cube_root_width(values)
+        data_range(values) * values.size ** (-1.0 / 3)
+      end
+
+      def cube_root_count(values)
+        (values.size ** (1.0 / 3)).ceil
+      end
+
+      def tuneable_root_width(values, factor)
+        data_range(values) * values.size ** (-1.0 / factor)
+      end
+
+      def tuneable_root_count(values, factor)
+        (values.size ** (1.0 / factor)).ceil
+      end
+
+      def freedman_diaconis_width(values)
+        2.0 * IQR.of(values) * values.size ** (-1.0 / 3)
+      end
+
+      def freedman_diaconis_count(values)
+        (data_range(values) / freedman_diaconis_width(values)).ceil
+      end
+
+      def scott_width(values)
+        3.49 * StandardDeviation.of(values) * values.size ** (-1.0 / 3)
+      end
+
+      def scott_count(values)
+        (data_range(values) / scott_width(values)).ceil
+      end
+
+      def sturges_width(values)
+        data_range(values) / sturges_count(values)
+      end
+
+      def sturges_count(values)
+        Math.log2(values.size).ceil + 1
+      end
+
+      def validate!(values, method:, factor: nil)
+        raise ArgumentError, 'Values must not be empty' if values.empty?
+        raise ArgumentError, "Unknown method: #{method}" unless METHODS.include?(method)
+        raise ArgumentError, 'Factor must be positive' if factor && factor <= 0
+      end
     end # class << self
 
     attr_reader :count, :interval

data/lib/Statistics/Histogram.rb

@@ -25,10 +25,10 @@ module Statistics
 
     private
 
-    def initialize(values, bin_width: nil, bin_count: nil, method: :square_root)
+    def initialize(values, bin_width: nil, bin_count: nil, method: :square_root, factor: nil)
       raise ArgumentError, 'Values must not be empty' if values.empty?
       @values = values.map(&:to_f).sort
-      @bin_width = Bin.width(@values, bin_width: bin_width, bin_count: bin_count, method: method)
+      @bin_width = Bin.width(@values, bin_width: bin_width, bin_count: bin_count, method: method, factor: factor)
       @boundaries = Bin.boundaries(@values, bin_width: @bin_width)
       @bins = allocate_values
     end

data/lib/Statistics/VERSION.rb

@@ -2,5 +2,5 @@
 # Statistics::VERSION
 
 module Statistics
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/test/Statistics/Bin_test.rb

@@ -30,6 +30,97 @@ describe Statistics::Bin do
       width = Statistics::Bin.width(values)
       _(width).must_equal 1.0
     end
+
+    it 'calculates cube root width' do
+      values = (1..100).to_a.map(&:to_f)
+      width = Statistics::Bin.width(values, method: :cube_root)
+      expected = (values.last - values.first) * values.size ** (-1.0 / 3)
+      _(width).must_be_close_to expected
+    end
+
+    it 'calculates tuneable root width with custom factor' do
+      values = (1..100).to_a.map(&:to_f)
+      width = Statistics::Bin.width(values, method: :tuneable_root, factor: 4.0)
+      expected = (values.last - values.first) * values.size ** (-1.0 / 4)
+      _(width).must_be_close_to expected
+    end
+
+    it 'tuneable root with default factor matches square root width' do
+      values = (1..100).to_a.map(&:to_f)
+      width = Statistics::Bin.width(values, method: :tuneable_root)
+      expected = Statistics::Bin.width(values, method: :square_root)
+      _(width).must_be_close_to expected
+    end
+
+    it 'calculates Freedman-Diaconis width' do
+      values = (1..100).to_a.map(&:to_f)
+      width = Statistics::Bin.width(values, method: :freedman_diaconis)
+      expected = 2.0 * Statistics::IQR.of(values) * values.size ** (-1.0 / 3)
+      _(width).must_be_close_to expected
+    end
+
+    it 'calculates Scott width' do
+      values = (1..100).to_a.map(&:to_f)
+      width = Statistics::Bin.width(values, method: :scott)
+      expected = 3.49 * Statistics::StandardDeviation.of(values) * values.size ** (-1.0 / 3)
+      _(width).must_be_close_to expected
+    end
+
+    it 'calculates Sturges width' do
+      values = (1..100).to_a.map(&:to_f)
+      width = Statistics::Bin.width(values, method: :sturges)
+      expected_count = Math.log2(values.size).ceil + 1
+      expected = (values.last - values.first) / expected_count
+      _(width).must_be_close_to expected
+    end
+
+    it 'raises for empty values' do
+      _{Statistics::Bin.width([])}.must_raise ArgumentError
+    end
+
+    it 'raises for unknown method' do
+      _{Statistics::Bin.width([1.0, 2.0], method: :bogus)}.must_raise ArgumentError
+    end
+
+    it 'raises for non-positive factor' do
+      _{Statistics::Bin.width([1.0, 2.0], factor: 0)}.must_raise ArgumentError
+    end
+  end
+
+  describe '.count' do
+    it 'calculates square root count by default' do
+      values = (1..100).to_a.map(&:to_f)
+      _(Statistics::Bin.count(values)).must_equal Math.sqrt(values.size).ceil
+    end
+
+    it 'calculates cube root count' do
+      values = (1..100).to_a.map(&:to_f)
+      _(Statistics::Bin.count(values, method: :cube_root)).must_equal (values.size ** (1.0 / 3)).ceil
+    end
+
+    it 'calculates tuneable root count with custom factor' do
+      values = (1..100).to_a.map(&:to_f)
+      _(Statistics::Bin.count(values, method: :tuneable_root, factor: 4.0)).must_equal (values.size ** (1.0 / 4)).ceil
+    end
+
+    it 'calculates Freedman-Diaconis count' do
+      values = (1..100).to_a.map(&:to_f)
+      expected_width = 2.0 * Statistics::IQR.of(values) * values.size ** (-1.0 / 3)
+      expected = ((values.last - values.first) / expected_width).ceil
+      _(Statistics::Bin.count(values, method: :freedman_diaconis)).must_equal expected
+    end
+
+    it 'calculates Scott count' do
+      values = (1..100).to_a.map(&:to_f)
+      expected_width = 3.49 * Statistics::StandardDeviation.of(values) * values.size ** (-1.0 / 3)
+      expected = ((values.last - values.first) / expected_width).ceil
+      _(Statistics::Bin.count(values, method: :scott)).must_equal expected
+    end
+
+    it 'calculates Sturges count' do
+      values = (1..100).to_a.map(&:to_f)
+      _(Statistics::Bin.count(values, method: :sturges)).must_equal Math.log2(values.size).ceil + 1
+    end
   end
 
   describe '.boundaries' do

data/test/Statistics/Histogram_test.rb

@@ -136,6 +136,16 @@ describe Statistics::Histogram do
     end
   end
 
+  describe 'with method: :tuneable_root' do
+    it 'passes factor through to Bin.width' do
+      values = (1..100).to_a
+      h_default = Statistics::Histogram.new(values, method: :tuneable_root)
+      h_custom = Statistics::Histogram.new(values, method: :tuneable_root, factor: 4.0)
+      _(h_default.bins.first.width).must_be_close_to Statistics::Bin.width(values.map(&:to_f), method: :tuneable_root)
+      _(h_custom.bins.first.width).must_be_close_to Statistics::Bin.width(values.map(&:to_f), method: :tuneable_root, factor: 4.0)
+    end
+  end
+
   describe 'with float values' do
     it 'handles floats correctly' do
       values = [1.1, 2.2, 3.3, 4.4, 5.5, 6.6, 7.7, 8.8, 9.9]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statistics.rb
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - thoran