tonal-tools 7.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08e71f0a71f06993084a2567211a4106cefc25aaa4d1f28bc941bf737097915b'
-  data.tar.gz: 6fa78c5271fa011906a7de57b9a56f7693bd11f2985d5193b868bd00468d3341
+  metadata.gz: 6eb41e5ffdfb2d4e1d6e76f5f69a2c1ad9a81d658af99e8a338211a5deea5d09
+  data.tar.gz: b63cb8bd6081fecdbbd97a2b003d84c2ea6533f9c656a63ba856c9732d021810
 SHA512:
-  metadata.gz: 6509f49a314f5cec9b413617ddf00967e7c57655b9eb86b8b96e56033c3ef8cd8e136ee0a69cffb0e1de413e998b67537671763fd98bb937552bb03dc52316ff
-  data.tar.gz: c99a22e906caaaca500225189a19f7633df2144485ef6c9479faf9bbbaefed01a04a085fd7de0b74cf4549f6b37c8afa919566d561709e66685306d962218863
+  metadata.gz: f33625446c980e2a0e92d37efefb6abda13a084f214900af13c2cad9a981e087ff971d3fd62f86e83ec574a1bc9f153f80a5b61001c36cc9fe8eb4fda6fb9336
+  data.tar.gz: 99f81e26f709629654cd54402635d2e504c7075426f5f5807add1a3226736951f37cd459e929fc6c96b101a7290e88a23914b296e5b987212def629455fd9886

data/lib/tonal/attributions.rb

@@ -1,4 +1,4 @@
 module Tonal
   TOOLS_PRODUCER = "mTonal"
-  TOOLS_VERSION = "7.0.0"
+  TOOLS_VERSION = "7.1.0"
 end

data/lib/tonal/extensions.rb

@@ -39,13 +39,22 @@ class Numeric
   #
   def div_times(factor) = [self / factor, self * factor]
 
-  # @return [Tonal::ReducedRatio] the octave reduced ratio of self
+  # @return [Tonal::Ratio] the octave reduced ratio of self
   # @example
-  #   (2**(1.0/12)).ratio => (4771397596969315/4503599627370496)
+  #   (4/5r).to_ratio => 4/5
+  # @param reduced
+  # @param equave
   #
   def to_ratio(reduced: false, equave: 2/1r) = reduced ? Tonal::ReducedRatio.new(self, equave: equave) : Tonal::Ratio.new(self, equave: equave)
   alias :ratio :to_ratio
 
+  # @return [Tonal::ReducedRatio]
+  # @example
+  #   {4/5r}.to_reduced_ratio => 8/5
+  # @param equave
+  #
+  def to_reduced_ratio(equave: 2/1r) = to_ratio(reduced: true, equave: equave)
+
   # @return [Float], the degrees on a circle of self
   # @example
   #   (2**(6.0/12)).period_degrees => 180.0
@@ -124,6 +133,9 @@ class Numeric
 
   # @return [Integer] the Wilson height
   # @example (14/9r).wilson_height => 13
+  # @param reduced
+  # @param equave
+  # @param prime_rejects
   #
   def wilson_height(reduced: false, equave: 2/1r, prime_rejects: [2]) = ratio(reduced: reduced, equave: equave).wilson_height(prime_rejects: prime_rejects)
 
@@ -153,6 +165,7 @@ class Numeric
   # @return [Vector], self represented as a prime vector
   # @example
   #   (3/2r).prime_vector => Vector[-1, 1]
+  # @param reduced
   #
   def prime_vector(reduced: false) = ratio(reduced: reduced).prime_vector
   alias :monzo :prime_vector
@@ -183,13 +196,13 @@ class Numeric
   def to_vector = Vector[self.numerator, self.denominator]
   alias :vector :to_vector
 
-  # @return [Tonal::ReducedRatio], the Ernst Levy negative of self
+  # @return [Tonal::Ratio], the Ernst Levy negative of self
   # @example
   #  (7/4r).negative => (12/7)
   #
   def negative = ratio.negative
 
-  # @return [Tonal::ReducedRatio], the ratio rotated on the given axis, default 1/1
+  # @return [Tonal::Ratio], the ratio rotated on the given axis, default 1/1
   # @example
   #   (3/2r).mirror => (4/3)
   # @param axis around which self is mirrored
@@ -377,7 +390,7 @@ class Array
   #
   def mean = self.sum / self.count.to_f
 
-  # @return [Tonal::ReducedRatio] ratio reconstructed from the result of a prime factor decomposition
+  # @return [Tonal::Ratio] ratio reconstructed from the result of a prime factor decomposition
   # @example
   #   [[[3, 1]], [[2, 1]]].ratio_from_prime_divisions => (3/2)
   # @param reduced [Boolean] if a reduced or unreduced ratio is returned

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tonal-tools
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Jose Hales-Garcia
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '3.1'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Tonal tools
 test_files: []