dicey 0.15.1 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315d35b504558fad6ce08ebd3e648903e9f85e97dd5388c20afbcff896c40825
-  data.tar.gz: f4138742272906c291d44533391e3b63216c45f8bd99337f8c570e252bd0ce3b
+  metadata.gz: c18dbf421c9c19d438194ec9f63a9a22bfd18abb50d1f3b491a6e8067e3a04ae
+  data.tar.gz: e01eabaa58523f5fb2e1610ec671fc41a31f4aee7a583b64aa52d5bb9f083462
 SHA512:
-  metadata.gz: 201115ad574e086ab99bf62d0129ae2dd3457cf2c06639d2e18f95c16699fa42f0ec72852aa13bdea408001a27fc366c1150d7cef2874f227957f5cd0e80bc40
-  data.tar.gz: abfec7efee1b05e607432650a6e5de444e2cf75d9c462e9b6a0211cb48888234ccf4e95ddb50d431017ddc01d5969d6ca4b6a130faefd31b7f852dc3c41a9200
+  metadata.gz: 48759bc7919e8dbf699777a92735c586a8365f517c2c12d48cb725f12ada1fcfd6904e2c08e54ec7159267ad79003e7a1725a1e6e97694d7d4cbfb32198b2566
+  data.tar.gz: fa0cd4f20b6262cf927eb98cb5c296db2473910a27e2500323f80aeb5d2ac3224de143f67e0990fe555890535ff395d8514996934759984316d9fe22c4fb0e17

data/lib/dicey/distribution_properties_calculator.rb

@@ -8,7 +8,7 @@ module Dicey
   #
   # These are well-known properties such as:
   # - min, max, mid-range;
-  # - mode, median, arithmetic mean;
+  # - mode(s), median, arithmetic mean;
   # - important moments (expected value, variance, skewness, kurtosis).
   #
   # It is notable that most dice create symmetric distributions,
@@ -21,11 +21,13 @@ module Dicey
     # Calculate properties for a given distribution.
     #
     # Depending on values in the distribution, some properties may be undefined.
-    # In such cases, only mode is guaranteed to be present.
+    # In such cases, only mode(s) are guaranteed to be present.
     #
-    # @param distribution [Hash{Numeric => Numeric}
-    #   numeric distribution with pre-sorted keys
-    # @return [Hash{Symbol => Numeric, Array<Numeric>}]
+    # On empty distribution, returns an empty hash.
+    #
+    # @param distribution [Hash{Numeric => Numeric}, Hash{Any => Numeric}]
+    #   distribution with pre-sorted keys
+    # @return [Hash{Symbol => Numeric, Array<Numeric>, Array<Array<Numeric>>}]
     def call(distribution)
       return {} if distribution.empty?
 
@@ -40,6 +42,7 @@ module Dicey
 
       {
         mode: mode(outcomes, weights),
+        modes: modes(distribution),
         **range_characteristics(outcomes),
         **median(outcomes),
         **means(outcomes, weights),
@@ -52,13 +55,35 @@ module Dicey
       outcomes.select.with_index { |_, index| weights[index] == max_weight }
     end
 
+    def modes(distribution)
+      # Split into chunks with different weights,
+      # then select those with higher weights than their neighbors.
+      chunks = distribution.chunk_while { |(_, w_1), (_, w_2)| w_1 == w_2 }.to_a
+      return [chunks.first.map(&:first)] if chunks.size == 1
+
+      modes = []
+      add_local_mode(modes, nil, chunks[0], chunks[1])
+      chunks.each_cons(3).each do |chunk_before, chunk, chunk_after|
+        add_local_mode(modes, chunk_before, chunk, chunk_after)
+      end
+      add_local_mode(modes, chunks[-2], chunks[-1], nil)
+      modes
+    end
+
+    def add_local_mode(modes, chunk_before, chunk, chunk_after)
+      if (!chunk_before || chunk_before.first.last < chunk.first.last) &&
+         (!chunk_after || chunk_after.first.last < chunk.first.last)
+        modes << chunk.map(&:first)
+      end
+    end
+
     def range_characteristics(outcomes)
       min = outcomes.min
       max = outcomes.max
       {
         min: min,
         max: max,
-        total_range: max - min,
+        range_length: max - min,
         mid_range: rational_to_integer(Rational(min + max, 2)),
       }
     rescue ArgumentError, TypeError, NoMethodError

data/lib/dicey/rational_to_integer.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module Dicey
+  # @api private
   # Mix-in for converting rationals with denominator of 1 to integers.
   module RationalToInteger
+    private
+
     # Convert +value+ to +Integer+ if it's a +Rational+ with denominator of 1.
     # Otherwise, return +value+ as-is.
     #

data/lib/dicey/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dicey
-  VERSION = "0.15.1"
+  VERSION = "0.15.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dicey
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.15.2
 platform: ruby
 authors:
 - Alexandr Bulancov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-07 00:00:00.000000000 Z
+date: 2025-10-08 00:00:00.000000000 Z
 dependencies: []
 description: |
   Dicey provides a CLI executable and a Ruby API for fast calculation of
@@ -60,9 +60,9 @@ licenses:
 metadata:
   homepage_uri: https://github.com/trinistr/dicey
   bug_tracker_uri: https://github.com/trinistr/dicey/issues
-  documentation_uri: https://rubydoc.info/gems/dicey/0.15.1
-  source_code_uri: https://github.com/trinistr/dicey/tree/v0.15.1
-  changelog_uri: https://github.com/trinistr/dicey/blob/v0.15.1/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/dicey/0.15.2
+  source_code_uri: https://github.com/trinistr/dicey/tree/v0.15.2
+  changelog_uri: https://github.com/trinistr/dicey/blob/v0.15.2/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: