philiprehberger-math_kit 0.2.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e454a11061739fecb690a7246eb3b4120676ab809e103868b1c7b1c6772456f
-  data.tar.gz: c47a3d320f89cf3446cfe4f649e1b4ddc2f058f7cbaf1d5351e25d97a60f5499
+  metadata.gz: a73db6abf0e0f987688786bd18c0b959182dc5290c52ac52e04a55926361436e
+  data.tar.gz: 85c7d136bf63030f7009b736aa0d44c81429e383973bb8bd65ca58f0aa08c927
 SHA512:
-  metadata.gz: c6e207c58fd8512f5ef5b61bab968d4379004d3d93a118dad5b340521615f3405270c64aa253665066568249e5ab6d41e1914da73cffa2a3e4203868dc2827f7
-  data.tar.gz: da21ff4a0bf20630b2cc46477147ad530ec79d9fdc563dea0900c972cb618d37a5ddead11b9210e8a0fee0e735c1141ed72f6ac04761b9e1065fd5dcd5c325a4
+  metadata.gz: 63bbbb1ca5f8c31f476dbb87f9df33569a4cdd420e49b736f2a5289c5f7e3839cff4cc3353af2c8db87f5bf909feb7b7047088e29167ea36d7318752c271848c
+  data.tar.gz: 183f0a9fec1904a98d37520df268f260e7f6e4dd9e32403fc5ce1ef3e3fdf1d346947d1751e757a4d81de0eae73cd215b393c19faa82a3b7510d7ff4b23d6c9a

data/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2026-04-15
+
+### Added
+- `Numeric` module with common integer and value helpers
+- `Numeric.factorial(n)` for non-negative integer factorial (arbitrary precision)
+- `Numeric.fibonacci(n)` for the n-th Fibonacci number via iterative O(n)/O(1) computation
+- `Numeric.gcd(a, b)` for greatest common divisor (accepts negative inputs)
+- `Numeric.lcm(a, b)` for least common multiple (accepts negative inputs)
+- `Numeric.clamp(value, min, max)` for constraining a value to a range
+
+## [0.3.0] - 2026-04-10
+
+### Added
+- `Stats.describe(values)` for summary statistics (count, mean, median, min, max, stddev, variance, percentiles)
+- `Stats.histogram(values, bins:)` for frequency distribution into equal-width bins
+- `Stats.weighted_mean(values, weights:)` for weighted arithmetic mean
+
 ## [0.2.3] - 2026-04-08
 
 ### Changed
@@ -59,3 +76,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Linear interpolation between sorted points with extrapolation
 - Rounding modes: bankers (round half to even), ceiling, floor, truncate with precision
 - Simple moving average and exponential moving average
+
+[Unreleased]: https://github.com/philiprehberger/rb-math-kit/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/philiprehberger/rb-math-kit/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/philiprehberger/rb-math-kit/compare/v0.2.3...v0.3.0
+[0.2.3]: https://github.com/philiprehberger/rb-math-kit/compare/v0.2.2...v0.2.3
+[0.2.2]: https://github.com/philiprehberger/rb-math-kit/compare/v0.2.1...v0.2.2
+[0.2.1]: https://github.com/philiprehberger/rb-math-kit/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/philiprehberger/rb-math-kit/compare/v0.1.2...v0.2.0
+[0.1.2]: https://github.com/philiprehberger/rb-math-kit/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/philiprehberger/rb-math-kit/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/philiprehberger/rb-math-kit/releases/tag/v0.1.0

data/README.md

@@ -43,6 +43,28 @@ Philiprehberger::MathKit::Stats.sum([1, 2, 3])                # => 6
 Philiprehberger::MathKit::Stats.range([1, 5, 3, 9, 2])        # => 8
 ```
 
+### Summary Statistics
+
+```ruby
+Philiprehberger::MathKit::Stats.describe([1, 2, 3, 4, 5])
+# => { count: 5, mean: 3.0, median: 3.0, min: 1.0, max: 5.0,
+#      stddev: 1.58..., variance: 2.5, p25: 2.0, p50: 3.0, p75: 4.0 }
+```
+
+### Weighted Mean
+
+```ruby
+Philiprehberger::MathKit::Stats.weighted_mean([10, 20, 30], weights: [3, 1, 1])
+# => 16.0
+```
+
+### Histogram
+
+```ruby
+Philiprehberger::MathKit::Stats.histogram([1, 2, 3, 4, 5, 6, 7, 8, 9, 10], bins: 5)
+# => [{ min: 1.0, max: 2.8, count: 2 }, { min: 2.8, max: 4.6, count: 2 }, ...]
+```
+
 ### Skewness and Kurtosis
 
 ```ruby
@@ -116,6 +138,16 @@ Philiprehberger::MathKit::MovingAverage.simple([1, 2, 3, 4, 5], window: 3)
 Philiprehberger::MathKit::MovingAverage.exponential([1, 2, 3, 4, 5], alpha: 0.5) # => [1.0, 1.5, 2.25, 3.125, 4.0625]
 ```
 
+### Numeric Helpers
+
+```ruby
+Philiprehberger::MathKit::Numeric.factorial(5)      # => 120
+Philiprehberger::MathKit::Numeric.fibonacci(10)     # => 55
+Philiprehberger::MathKit::Numeric.gcd(12, 18)       # => 6
+Philiprehberger::MathKit::Numeric.lcm(4, 6)         # => 12
+Philiprehberger::MathKit::Numeric.clamp(42, 0, 10)  # => 10
+```
+
 ## API
 
 ### `Stats`
@@ -140,6 +172,9 @@ Philiprehberger::MathKit::MovingAverage.exponential([1, 2, 3, 4, 5], alpha: 0.5)
 | `.median_absolute_deviation(values)` | Median absolute deviation |
 | `.trimmed_mean(values, trim: 0.1)` | Trimmed mean (remove fraction from each end) |
 | `.winsorized_mean(values, trim: 0.1)` | Winsorized mean (clamp extremes) |
+| `.describe(values)` | Summary statistics hash (count, mean, median, min, max, stddev, percentiles) |
+| `.histogram(values, bins: 10)` | Frequency distribution as array of bin hashes |
+| `.weighted_mean(values, weights:)` | Weighted arithmetic mean |
 
 ### `Regression`
 
@@ -173,6 +208,16 @@ Philiprehberger::MathKit::MovingAverage.exponential([1, 2, 3, 4, 5], alpha: 0.5)
 | `.simple(values, window:)` | Simple moving average |
 | `.exponential(values, alpha:)` | Exponential moving average |
 
+### `Numeric`
+
+| Method | Description |
+|--------|-------------|
+| `.factorial(n)` | Factorial of a non-negative integer |
+| `.fibonacci(n)` | N-th Fibonacci number (0-indexed) |
+| `.gcd(a, b)` | Greatest common divisor of two integers |
+| `.lcm(a, b)` | Least common multiple of two integers |
+| `.clamp(value, min, max)` | Clamp a numeric value between min and max |
+
 ## Development
 
 ```bash

data/lib/philiprehberger/math_kit/numeric.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module MathKit
+    # Numeric helpers for common integer and value operations
+    module Numeric
+      class << self
+        # Factorial of a non-negative integer (n!)
+        #
+        # @param n [Integer] a non-negative integer
+        # @return [Integer] the factorial of n
+        # @raise [ArgumentError] if n is negative or not an Integer
+        def factorial(n)
+          raise ArgumentError, 'factorial requires an Integer' unless n.is_a?(Integer)
+          raise ArgumentError, 'factorial requires a non-negative integer' if n.negative?
+
+          (1..n).reduce(1, :*)
+        end
+
+        # N-th Fibonacci number (0-indexed: fibonacci(0) = 0, fibonacci(1) = 1)
+        #
+        # Uses an iterative algorithm for O(n) time and O(1) space.
+        #
+        # @param n [Integer] a non-negative index
+        # @return [Integer] the n-th Fibonacci number
+        # @raise [ArgumentError] if n is negative or not an Integer
+        def fibonacci(n)
+          raise ArgumentError, 'fibonacci requires an Integer' unless n.is_a?(Integer)
+          raise ArgumentError, 'fibonacci requires a non-negative integer' if n.negative?
+
+          a = 0
+          b = 1
+          n.times { a, b = b, a + b }
+          a
+        end
+
+        # Greatest common divisor of two integers (Euclidean algorithm)
+        #
+        # @param a [Integer] first integer
+        # @param b [Integer] second integer
+        # @return [Integer] the non-negative greatest common divisor
+        # @raise [ArgumentError] if either argument is not an Integer
+        def gcd(a, b)
+          raise ArgumentError, 'gcd requires Integer arguments' unless a.is_a?(Integer) && b.is_a?(Integer)
+
+          a.abs.gcd(b.abs)
+        end
+
+        # Least common multiple of two integers
+        #
+        # @param a [Integer] first integer
+        # @param b [Integer] second integer
+        # @return [Integer] the non-negative least common multiple (0 if either is 0)
+        # @raise [ArgumentError] if either argument is not an Integer
+        def lcm(a, b)
+          raise ArgumentError, 'lcm requires Integer arguments' unless a.is_a?(Integer) && b.is_a?(Integer)
+
+          a.abs.lcm(b.abs)
+        end
+
+        # Clamp a numeric value between a minimum and maximum
+        #
+        # @param value [Numeric] the value to clamp
+        # @param min [Numeric] lower bound
+        # @param max [Numeric] upper bound
+        # @return [Numeric] the clamped value
+        # @raise [ArgumentError] if min is greater than max
+        def clamp(value, min, max)
+          raise ArgumentError, 'min must not be greater than max' if min > max
+
+          return min if value < min
+          return max if value > max
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/philiprehberger/math_kit/stats.rb

@@ -291,6 +291,71 @@ module Philiprehberger
           mean(winsorized)
         end
 
+        # Summary statistics for a dataset
+        #
+        # @param values [Array<Numeric>] the input values
+        # @return [Hash] with :count, :mean, :median, :min, :max, :stddev, :variance, :p25, :p50, :p75
+        # @raise [ArgumentError] if values is empty
+        def describe(values)
+          raise ArgumentError, 'values must not be empty' if values.empty?
+
+          {
+            count: values.size,
+            mean: mean(values),
+            median: median(values),
+            min: values.min.to_f,
+            max: values.max.to_f,
+            stddev: values.size >= 2 ? stddev(values, population: false) : 0.0,
+            variance: values.size >= 2 ? variance(values, population: false) : 0.0,
+            p25: percentile(values, 25),
+            p50: percentile(values, 50),
+            p75: percentile(values, 75)
+          }
+        end
+
+        # Frequency distribution (histogram)
+        #
+        # @param values [Array<Numeric>] the input values
+        # @param bins [Integer] number of bins (default: 10)
+        # @return [Array<Hash>] array of { min:, max:, count: } hashes
+        # @raise [ArgumentError] if values is empty or bins < 1
+        def histogram(values, bins: 10)
+          raise ArgumentError, 'values must not be empty' if values.empty?
+          raise ArgumentError, 'bins must be at least 1' if bins < 1
+
+          min_val = values.min.to_f
+          max_val = values.max.to_f
+          width = max_val == min_val ? 1.0 : (max_val - min_val) / bins.to_f
+
+          result = Array.new(bins) do |i|
+            { min: min_val + (i * width), max: min_val + ((i + 1) * width), count: 0 }
+          end
+
+          values.each do |v|
+            idx = width.zero? ? 0 : ((v - min_val) / width).floor
+            idx = bins - 1 if idx >= bins
+            result[idx][:count] += 1
+          end
+
+          result
+        end
+
+        # Weighted arithmetic mean
+        #
+        # @param values [Array<Numeric>] the input values
+        # @param weights [Array<Numeric>] the corresponding weights
+        # @return [Float] the weighted mean
+        # @raise [ArgumentError] if arrays differ in size, are empty, or weights sum to zero
+        def weighted_mean(values, weights:)
+          raise ArgumentError, 'values must not be empty' if values.empty?
+          raise ArgumentError, 'values and weights must have the same size' if values.size != weights.size
+
+          total_weight = weights.sum.to_f
+          raise ArgumentError, 'weights must not sum to zero' if total_weight.zero?
+
+          values.zip(weights).sum { |v, w| v * w } / total_weight
+        end
+
         private
 
         # T-distribution critical values for common confidence levels

data/lib/philiprehberger/math_kit/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module MathKit
-    VERSION = '0.2.3'
+    VERSION = '0.4.0'
   end
 end

data/lib/philiprehberger/math_kit.rb

@@ -6,6 +6,7 @@ require_relative 'math_kit/interpolation'
 require_relative 'math_kit/round'
 require_relative 'math_kit/moving_average'
 require_relative 'math_kit/regression'
+require_relative 'math_kit/numeric'
 
 module Philiprehberger
   module MathKit

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-math_kit
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-09 00:00:00.000000000 Z
+date: 2026-04-15 00:00:00.000000000 Z
 dependencies: []
 description: Descriptive statistics, linear interpolation, rounding modes, and moving
   averages. Lightweight math toolkit with zero dependencies.
@@ -24,6 +24,7 @@ files:
 - lib/philiprehberger/math_kit.rb
 - lib/philiprehberger/math_kit/interpolation.rb
 - lib/philiprehberger/math_kit/moving_average.rb
+- lib/philiprehberger/math_kit/numeric.rb
 - lib/philiprehberger/math_kit/regression.rb
 - lib/philiprehberger/math_kit/round.rb
 - lib/philiprehberger/math_kit/stats.rb