statistics.rb 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca6c39ebb723322893b28fc4cc9310e4004120ae20faa3be0aa502df6bae0d1b
-  data.tar.gz: aad65236bd96a97805c7d0cce74e2c922d34e07ee6c95e3ebc3848a6c9eb92b0
+  metadata.gz: 9db0156fb926432eb2d48821c410a0badec96b32dacd485893b0bdf8e7b25cb5
+  data.tar.gz: 77ac6c90e08b0017d1f66ad427ed0c5f0560ef1732fa79627bb0a2160eea292e
 SHA512:
-  metadata.gz: 16f2c79aa61f53f1b7d6ef30d61e54ad2dde96e541056651c165e8955270c8e77290fc9f50e5a7bb752dc97ed3c87da715e0ec55950a352b45d9cb0ed5481780
-  data.tar.gz: 4f0129b9ed5fcd74ff7a3940f3e4b578b7d586221b2a514354425a0c6fef2fcf8dfd5b5d8c6992deef0c73b4872805c356e46b3c387cea5e0ca995577dfaadb2
+  metadata.gz: 43cf596e2166e2cd345528dd6aae8aaadcf78e9bfe62cfe5f28903729bca2ae60a9b142796ab6ab699da57754b27480c4b7c07dae81c37f569f244064daa05f1
+  data.tar.gz: e0f26dd100a0741855f46b466b5c9c28a673f386c674a65feafe2cf5793f7353d4791dc54e1e4f1c95f2200724caefcbcc7901b71a830743f7cb97f653ba3692

data/CHANGELOG.md

@@ -1,7 +1,18 @@
 # CHANGELOG
 
+## [0.6.1] - 20260513
+## Statistics::Histogram::Bin --> Statistics::Bin
+
+1. lib/Statistics/Histogram/Bin.rb --> lib/Statistics/Bin.rb
+2. test/Statistics/Histogram/Bin\_test.rb --> test/Statistics/Bin\_test.rb
+3. ~ lib/Statistics/Histogram.rb: /require\_relative './Histogram/Bin'/require\_relative './Bin'/
+4. ~ lib/statistics.rb: + require\_relative './Statistics/Bin'
+5. ~ .gitignore: Add standard contents.
+6. ~ README.md: + Contributions section
+7. ~ lib/Statistics/VERSION.rb: /0.6.0/0.6.1/
+
 ## [0.6.0] - 20260504
-## Percentile, StandardDeviation, IQR
+## + Percentile, StandardDeviation, IQR
 
 1. + lib/Statistics/Percentile.rb
 2. + lib/Statistics/StandardDeviation.rb
@@ -15,7 +26,7 @@
 
 
 ## [0.5.0] - 20260503
-## Bin.bin\_for\_value, Bin split, gem scaffolding
+## + Bin.bin\_for\_value, Bin split, gem scaffolding.
 
 1. + Bin.bin\_for\_value (wraps index\_for\_value, now private)
 2. ~ Histogram#allocate\_values: Use Bin.bin\_for\_value
@@ -32,7 +43,7 @@
 
 
 ## [0.4.0] - 20260502
-## Bin instances and consolidated class methods
+## + Bin instances; consolidated class methods.
 
 1. + Bin instances (count-tracking via increment, attr\_reader :interval)
 2. ~ Bin.width: handles bin\_width, bin\_count, zero-range, and method selection
@@ -44,7 +55,7 @@
 
 
 ## [0.3.0] - 20260417
-## Hash-based bins, Bin as class-methods-only
+## Hash-based bins; Bin as class-methods-only.
 
 1. + Bin.boundaries class method
 2. ~ initialize: delegates to Bin.width and Bin.boundaries
@@ -55,7 +66,7 @@
 
 
 ## [0.2.0] - 20260417
-## Count-tracking, interval, zero-range guard
+## Swap storing values per bin for counting per bin; interval; zero-range guard.
 
 1. ~ Bin: count-tracking via increment instead of storing values in array
 2. ~ Bin: attr\_reader :interval instead of :range
@@ -65,42 +76,42 @@
 
 
 ## [0.1.1] - 20260417
-## Extract determine\_bin\_width
+## + Statistics::Histogram#determine\_bin\_width
 
 1. ~ initialize: extracted determine\_bin\_width from one-liner
 2. /compute\_boundaries/calculate\_boundaries/
 
 
 ## [0.1.0] - 20260417
-## Bin class
+## + Statistics::Histogram::Bin
 
 1. + Statistics::Histogram::Bin
 2. ~ allocate\_values: creates Bin instances instead of hash entries
 
 
 ## [0.0.0] - 20260417
-## Statistics::Histogram
+## + Statistics::Histogram
 
 1. + lib/Statistics/Histogram.rb
 2. - lib/BinWidth.rb
 
 
-## 20260416
-## BinWidth 0.1.0 to 0.2.0: Reintroduce all named strategies
+## [pre-0.0.0] - 20260416
+## ~ BinWidth: Reintroduce binning strategies; extra guard clauses.
 
-1. /0.1.0/0.2.0/
-2. Reintroduce all named strategies.
+1. Reintroduce all named strategies.
+2. /0.1.0/0.2.0/
 
 
-## 20260416
-## BinWidth 0.0.0 to 0.1.0: Tuneable root generalisation
+## [pre-0.0.0] - 20260416
+## + BinWidth#tuneable_root
 
-1. /0.0.0/0.1.0/
-2. + tuneable\_root as the general form
-3. ~ square\_root rewritten as range * n^(-1/2) form
+1. + tuneable\_root as the general form
+2. ~ square\_root rewritten as range * n^(-1/2) form
+3. /0.0.0/0.1.0/
 
 
-## 20260416
-## BinWidth 0.0.0
+## [pre-0.0.0] - 20260416
+## + BinWidth
 
 1. + lib/BinWidth.rb

data/README.md

@@ -101,6 +101,14 @@ Statistics::IQR.of(values)  # => 4.5
 - Additional bin width methods (Freedman-Diaconis, Scott, Sturges, cube root, tuneable root)
 - Aligned/neat bin boundaries
 
+## Contributing
+
+1. Fork it [https://github.com/thoran/statistics/fork](https://github.com/thoran/statistics/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new pull request
+
 ## License
 
 MIT

data/lib/Statistics/Bin.rb

@@ -0,0 +1,74 @@
+# Statistics/Bin.rb
+# Statistics::Bin
+
+module Statistics
+  class Bin
+    class << self
+      def width(values, bin_width: nil, bin_count: nil, method: :square_root)
+        if bin_width
+          bin_width
+        elsif bin_count
+          data_range(values) / bin_count.to_f
+        elsif data_range(values) == 0
+          1.0
+        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
+      end
+
+      def boundaries(values, bin_width: nil, bin_count: nil, method: :square_root)
+        w = bin_width || width(values, bin_count: bin_count, method: method)
+        values.first.step(to: values.last + w, by: w).to_a
+      end
+
+      def bin_for_value(value, bins, bottom_boundary, bin_width)
+        index = index_for_value(value, bins.count, bottom_boundary, bin_width)
+        bins[index]
+      end
+
+      private
+
+      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
+      end
+
+      def square_root_width(values)
+        data_range(values) * values.size ** (-1.0 / 2)
+      end
+
+      def square_root_count(values)
+        Math.sqrt(values.size).ceil
+      end
+    end # class << self
+
+    attr_reader :count, :interval
+
+    def increment
+      @count += 1
+    end
+
+    def width
+      @interval.end - @interval.begin
+    end
+
+    def empty?
+      @count == 0
+    end
+
+    private
+
+    def initialize(interval)
+      @interval = interval
+      @count = 0
+    end
+  end
+end

data/lib/Statistics/Histogram.rb

@@ -1,7 +1,7 @@
 # Statistics/Histogram.rb
 # Statistics::Histogram
 
-require_relative './Histogram/Bin'
+require_relative './Bin'
 
 module Statistics
   class Histogram

data/lib/Statistics/VERSION.rb

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

data/lib/statistics.rb

@@ -1,5 +1,6 @@
 # statistics.rb
 
+require_relative './Statistics/Bin'
 require_relative './Statistics/Histogram'
 require_relative './Statistics/IQR'
 require_relative './Statistics/Percentile'

data/test/Statistics/{Histogram/Bin_test.rb → Bin_test.rb}

@@ -1,33 +1,33 @@
-# test/Statistics/Histogram/Bin_test.rb
+# test/Statistics/Bin_test.rb
 
 require 'minitest/autorun'
 
-require_relative '../../../lib/Statistics/Histogram/Bin'
+require_relative '../../lib/Statistics/Bin'
 
-describe Statistics::Histogram::Bin do
+describe Statistics::Bin do
   describe '.width' do
     it 'calculates square root width by default' do
       values = (1..100).to_a.map(&:to_f)
-      width = Statistics::Histogram::Bin.width(values)
+      width = Statistics::Bin.width(values)
       expected = (values.last - values.first) * values.size ** (-1.0 / 2)
       _(width).must_be_close_to expected
     end
 
     it 'returns explicit bin_width when provided' do
       values = (1..100).to_a.map(&:to_f)
-      width = Statistics::Histogram::Bin.width(values, bin_width: 7.5)
+      width = Statistics::Bin.width(values, bin_width: 7.5)
       _(width).must_equal 7.5
     end
 
     it 'calculates width from bin_count when provided' do
       values = (1..100).to_a.map(&:to_f)
-      width = Statistics::Histogram::Bin.width(values, bin_count: 10)
+      width = Statistics::Bin.width(values, bin_count: 10)
       _(width).must_be_close_to 9.9
     end
 
     it 'returns 1.0 for zero-range data' do
       values = [5.0, 5.0, 5.0]
-      width = Statistics::Histogram::Bin.width(values)
+      width = Statistics::Bin.width(values)
       _(width).must_equal 1.0
     end
   end
@@ -35,13 +35,13 @@ describe Statistics::Histogram::Bin do
   describe '.boundaries' do
     it 'returns an array starting at the minimum value' do
       values = (1..10).to_a.map(&:to_f)
-      boundaries = Statistics::Histogram::Bin.boundaries(values, bin_width: 3.0)
+      boundaries = Statistics::Bin.boundaries(values, bin_width: 3.0)
       _(boundaries.first).must_equal 1.0
     end
 
     it 'extends past the maximum value' do
       values = (1..10).to_a.map(&:to_f)
-      boundaries = Statistics::Histogram::Bin.boundaries(values, bin_width: 3.0)
+      boundaries = Statistics::Bin.boundaries(values, bin_width: 3.0)
       _(boundaries.last).must_be :>=, 10.0
     end
   end
@@ -49,24 +49,24 @@ describe Statistics::Histogram::Bin do
   describe '.bin_for_value' do
     it 'returns the correct bin' do
       bins = [5.0, 10.0, 15.0, 20.0].each_cons(2).map do |lower, upper|
-        Statistics::Histogram::Bin.new(lower...upper)
+        Statistics::Bin.new(lower...upper)
       end
-      bin = Statistics::Histogram::Bin.bin_for_value(7.0, bins, 5.0, 5.0)
+      bin = Statistics::Bin.bin_for_value(7.0, bins, 5.0, 5.0)
       _(bin.interval).must_equal(5.0...10.0)
     end
 
     it 'clamps to the last bin for values at the upper boundary' do
       bins = [5.0, 10.0, 15.0].each_cons(2).map do |lower, upper|
-        Statistics::Histogram::Bin.new(lower...upper)
+        Statistics::Bin.new(lower...upper)
       end
-      bin = Statistics::Histogram::Bin.bin_for_value(15.0, bins, 5.0, 5.0)
+      bin = Statistics::Bin.bin_for_value(15.0, bins, 5.0, 5.0)
       _(bin.interval).must_equal(10.0...15.0)
     end
   end
 
   describe 'instance methods' do
     before do
-      @bin = Statistics::Histogram::Bin.new(1.0...5.0)
+      @bin = Statistics::Bin.new(1.0...5.0)
     end
 
     it 'starts with count of zero' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statistics.rb
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - thoran
@@ -48,15 +48,15 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/Statistics/Bin.rb
 - lib/Statistics/Histogram.rb
-- lib/Statistics/Histogram/Bin.rb
 - lib/Statistics/IQR.rb
 - lib/Statistics/Percentile.rb
 - lib/Statistics/StandardDeviation.rb
 - lib/Statistics/VERSION.rb
 - lib/statistics.rb
 - statistics.rb.gemspec
-- test/Statistics/Histogram/Bin_test.rb
+- test/Statistics/Bin_test.rb
 - test/Statistics/Histogram_test.rb
 - test/Statistics/IQR_test.rb
 - test/Statistics/Percentile_test.rb
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.11
 specification_version: 4
 summary: A statistics library for Ruby.
 test_files: []

data/lib/Statistics/Histogram/Bin.rb

@@ -1,76 +0,0 @@
-# Statistics/Histogram/Bin.rb
-# Statistics::Histogram::Bin
-
-module Statistics
-  class Histogram
-    class Bin
-      class << self
-        def width(values, bin_width: nil, bin_count: nil, method: :square_root)
-          if bin_width
-            bin_width
-          elsif bin_count
-            data_range(values) / bin_count.to_f
-          elsif data_range(values) == 0
-            1.0
-          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
-        end
-
-        def boundaries(values, bin_width: nil, bin_count: nil, method: :square_root)
-          w = bin_width || width(values, bin_count: bin_count, method: method)
-          values.first.step(to: values.last + w, by: w).to_a
-        end
-
-        def bin_for_value(value, bins, bottom_boundary, bin_width)
-          index = index_for_value(value, bins.count, bottom_boundary, bin_width)
-          bins[index]
-        end
-
-        private
-
-        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
-        end
-
-        def square_root_width(values)
-          data_range(values) * values.size ** (-1.0 / 2)
-        end
-
-        def square_root_count(values)
-          Math.sqrt(values.size).ceil
-        end
-      end # class << self
-
-      attr_reader :count, :interval
-
-      def increment
-        @count += 1
-      end
-
-      def width
-        @interval.end - @interval.begin
-      end
-
-      def empty?
-        @count == 0
-      end
-
-      private
-
-      def initialize(interval)
-        @interval = interval
-        @count = 0
-      end
-    end
-  end
-end