tonal-tools 8.3.4 → 8.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdb178eb44ac2841a878052e7ec184d97dbe4b992596c4fc849ba7cbd8c08538
-  data.tar.gz: 59043afa410a203fb83c361e8f580a60e2c81903d4b95153ed5f8a8e3285a68e
+  metadata.gz: 520c39d6d3f6519ad21174305aaa089babd81bccde2416ddc09e2cc22d3f5ae7
+  data.tar.gz: 03ecbc849c92b953298c804c7b43caa0c020290dd3a1f183a5cfea3a0728fdaa
 SHA512:
-  metadata.gz: cbc32bccbf514a8abce43f1627b1795d8517091a452be252325317958075c1c9a13a407f389b12c93426c6786feedfb00c1bb777368e0c625440de605d734cfe
-  data.tar.gz: 86d55133cdd853c597d07fdd1017d674aa8cc1898dbe560a31c556877ae2c1567b262bcfd43b68eab9e67f0fe44267d0f02f9c770f5032ca66d4e53a922abab4
+  metadata.gz: 21af61fe964bff3bca95070e3796fcaa77b93e52dadc68314eb52b0dafa08932486cfa988d6bacab9a0dc86b3543d4782534f575304d752b0ad34155785b1578
+  data.tar.gz: ba8d2348c7b0d9f50bd8188051c64db63c49dd5d731ad1b2e61c473a844242978809edce8df261b761ff6efb13220f1ebcc737edf45b52a4fea2481e03299fe7

data/lib/tonal/attributions.rb

@@ -1,4 +1,4 @@
 module Tonal
   TOOLS_PRODUCER = "mTonal"
-  TOOLS_VERSION = "8.3.4"
+  TOOLS_VERSION = "8.5.0"
 end

data/lib/tonal/cents.rb

@@ -15,7 +15,7 @@ class Tonal::Cents
 
   # @return [Tonal::Cents]
   # @example
-  #   Tonal::Cents.new(ratio: 2**(2.0/12)) => 200.0
+  #   Tonal::Cents.new(ratio: 2**(2.0/12)) => 200.0 ¢
   # @param cents [Numeric, Tonal::Log2]
   # @param log [Numeric, Tonal::Log2]
   # @param ratio [Numeric, Tonal::Log2]
@@ -45,7 +45,7 @@ class Tonal::Cents
 
   # @return [Tonal::Cents] the default cents tolerance
   # @example
-  #   Tonal::Cents.default_tolerance => 5
+  #   Tonal::Cents.default_tolerance => 5 ¢
   #
   def self.default_tolerance
     self.new(cents: TOLERANCE)
@@ -53,7 +53,7 @@ class Tonal::Cents
 
   # @return [Float] value of self
   # @example
-  #   Tonal::Cents.new(ratio: 2**(1.0/12)).value => 100.00
+  #   Tonal::Cents.new(ratio: 2**(1.0/12)).value => 100.00 ¢
   #
   def value(precision: @precision)
     @value.round(precision)
@@ -64,7 +64,7 @@ class Tonal::Cents
   # @return
   #   [Tonal::Cents] nearest hundredth cent value
   # @example
-  #   Tonal::Cents.new(cents: 701.9550008653874).nearest_hundredth => 700.0
+  #   Tonal::Cents.new(cents: 701.9550008653874).nearest_hundredth => 700.0 ¢
   #
   def nearest_hundredth
     self.class.new(cents: value.round(Tonal::Cents::HUNDREDTHS_ROUNDOFF).to_f)
@@ -73,7 +73,7 @@ class Tonal::Cents
   # @return
   #   [Tonal::Cents] nearest hundredth cent difference
   # @example
-  #   Tonal::Cents.new(cents: 701.9550008653874).nearest_hundredth_difference => 1.96
+  #   Tonal::Cents.new(cents: 701.9550008653874).nearest_hundredth_difference => 1.96 ¢
   #
   def nearest_hundredth_difference
     self.class.new(cents: (value - nearest_hundredth))
@@ -91,10 +91,10 @@ class Tonal::Cents
   # @return
   #   [String] the string representation of Tonal::Cents
   # @example
-  #   Tonal::Cents.new(100.0).inspect => "100.0"
+  #   Tonal::Cents.new(100.0).inspect => 100.0 ¢
   #
   def inspect
-    "#{value.round(@precision)}"
+    "#{value.round(@precision)} ¢"
   end
   alias :to_s :inspect
 
@@ -102,7 +102,7 @@ class Tonal::Cents
   #
   # @return [Tonal::Cents, Numeric] result of operation
   # @example
-  #   Tonal::Cents.new(cents: 200) - Tonal::Cents.new(cents: 100) => 100.0
+  #   Tonal::Cents.new(cents: 200) - Tonal::Cents.new(cents: 100) => 100.0 ¢
   # @param rhs [Tonal::Cents, Numeric]
   #
   def -(rhs)
@@ -111,7 +111,7 @@ class Tonal::Cents
 
   # @return [Tonal::Cents, Numeric] result of operation
   # @example
-  #   Tonal::Cents.new(cents: 100) + Tonal::Cents.new(cents: 200) => 300.0
+  #   Tonal::Cents.new(cents: 100) + Tonal::Cents.new(cents: 200) => 300.0 ¢
   # @param rhs [Tonal::Cents, Numeric]
   #
   def +(rhs)
@@ -120,7 +120,7 @@ class Tonal::Cents
 
   # @return [Tonal::Cents, Numeric] result of operation
   # @example
-  #  Tonal::Cents.new(cents: 200) * 2 => 400.0
+  #  Tonal::Cents.new(cents: 200) * 2 => 400.0 ¢
   # @param rhs [Tonal::Cents, Numeric]
   #
   def *(rhs)
@@ -129,7 +129,7 @@ class Tonal::Cents
 
   # @return [Tonal::Cents, Numeric] result of operation
   # @example
-  #   Tonal::Cents.new(cents: 400) / 2 => 200.0
+  #   Tonal::Cents.new(cents: 400) / 2 => 200.0 ¢
   # @param rhs [Tonal::Cents, Numeric]
   #
   def /(rhs)

data/lib/tonal/extensions.rb

@@ -142,11 +142,11 @@ class Numeric
   #
   def wilson_height(reduced: false, equave: 2/1r, prime_rejects: [2]) = ratio(reduced:, equave:).wilson_height(prime_rejects:)
 
-  # @return [Float] the cents difference between self and its step in the given modulo
+  # @return [Tonal::Cents] the cents difference between self and its step in the given modulo
   # @example
-  #   (3/2r).efficiency(12) => -1.96
+  #   (3/2r).efficiency(12) => -1.96 ¢
   # @example
-  #   (3/2r).efficiency(12, is_step_efficiency: true) => 1.96
+  #   (3/2r).efficiency(12, is_step_efficiency: true) => 1.96 ¢
   # @param modulo against which the difference of self is compared
   # @param reduced if true, self is reduced to the octave before calculating efficiency
   # @param is_step_efficiency if true, calculates the efficiency of the step instead of the ratio (self). If the step efficiency is X cents, then the ratio efficiency is -X cents.

data/lib/tonal/step.rb

@@ -78,15 +78,23 @@ class Tonal::Scale
 
     # @return [Tonal::Cents] the difference between the step and the ratio
     # @example
-    #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).efficiency
-    #   => 5.19
+    #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).efficiency => 5.19 ¢
     #
     def efficiency
-      # We want the efficiency from the step (self).
+      # We want the efficiency from the step (self). The step is the tempered approximation of the ratio, so we want to know how far off the step is from the ratio. So we take the ratio and subtract the step.
       ratio_to_cents - step_to_cents
     end
     alias :cents_difference :efficiency
 
+    # @return [Boolean] true if the step is coprime to the modulo
+    # @example
+    #   Tonal::Scale::Step.new(step: 5, modulo: 12).coprime? => true
+    #   Tonal::Scale::Step.new(step: 6, modulo: 12).coprime? => false
+    #
+    def coprime?
+      step.coprime?(modulo)
+    end
+
     def +(rhs)
       self.class.new(step: (rhs % modulo), modulo: modulo)
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tonal-tools
 version: !ruby/object:Gem::Version
-  version: 8.3.4
+  version: 8.5.0
 platform: ruby
 authors:
 - Jose Hales-Garcia
 bindir: bin
 cert_chain: []
-date: 2026-03-22 00:00:00.000000000 Z
+date: 2026-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '3.1'
 requirements: []
-rubygems_version: 4.0.7
+rubygems_version: 4.0.8
 specification_version: 4
 summary: Tonal tools
 test_files: []