ruby-mext 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 765a069de73dccde01080cc08b7dc773781bc26f5dd5f3181a4d01e1bbdd04f2
-  data.tar.gz: bd1a550f9cce944c99c0fdd863696d99784eca0536278d19ec7768df45a775b0
+  metadata.gz: 333432c69cb5c931d71693a145648130e816cdfb17bc5a2b72965fcee4e6760c
+  data.tar.gz: 3b2d6f694370f4864702ff8e3c7d46fbf3343438cb8f6475c430471a4007afb2
 SHA512:
-  metadata.gz: f3de1073d0fb33c9dd5a1fd29eae1ea17ede3915a644478ed452780de20e75c2fe3ea15464fab9515e0c0c9331e83e879a77c55f382d156443c96022143a2016
-  data.tar.gz: c601e4e6f42b862f06238878a2a55bed482311851fc05e8b30c74f3904ed24ae202d9c61c963d73e3bef6929661494533de7ad8409c4a95186a52c1caefc2e45
+  metadata.gz: ec7603a7aef497e79f6ac624f5ed3a988f0ab1842f2520739ef0ef863ca5e3ebf29dec52d790e119537cf1f4168c98cddbee1a8dc42c380a6ddf9bc3f32f8db5
+  data.tar.gz: 955887187d5738f7470b9d1999d412156d76f5ae561c8db89d9a912649375e9e1c51aff040c1e07447977e1b7f09e84feaa3487cbd81b7916b38e32fcfe0d9d8

data/lib/mext/music/pitch_class.rb

@@ -1,10 +1,25 @@
 module Mext
   module Music
 
+    #
+    # +Mext::Music::PitchClass+
+    #
+    # this is a representation of pitches in the usual +PitchClass+
+    # representation of +csound+ and other software
+    #
+    # Internally, the representation is in semitones. In order to be
+    # consistent with the +csound+ representation, a +PitchClass+ of
+    # +8.00+ represents +central C4+ (+ca. 261.3 Hz+, depending on tuning),
+    # while a +PitchClass+ of +0.00+ is 96 semitones below (8 * 12).
+    #
+    # The internal representation allows for floating point values, negative
+    # values etc. However, since the +PitchClass+ is a geometric
+    # representation of pitches, it will never produce a negative
+    # frequency value (for semitones that go to -Inf., it'll produce
+    # infinitely small positive values.
+    #
     class PitchClass
   
-      attr_reader :octave, :semi
-  
       #
       # +Mext::Music::PitchClass.new(float_value, semi = nil)+:
       #
@@ -18,7 +33,40 @@ module Mext
       #
       #:nodoc:
       def initialize(fv, semi = nil)
-        semi ? setup_with_two_arguments(fv, semi) : setup_with_one_argument(fv)
+        @semi = semi ? setup_with_two_arguments(fv, semi) : setup_with_one_argument(fv)
+      end
+
+      #:doc:
+      #
+      # +octave+
+      #
+      # returns the octave part of the pitch class
+      #
+      def octave
+        res = @semi / ::Numeric::CNPO
+        res >= 0.0 ? res.floor : res.ceil
+      end
+  
+      #:doc:
+      #
+      # +semi+
+      #
+      # returns the semitone part of the pitch class
+      #
+      def semi
+        @semi >= 0.0 ? (@semi % 12.0) : (@semi % -12.0)
+      end
+
+      #:doc:
+      #
+      # +inner_representation+
+      #
+      # returns the inner representation in semitones (this is a public method
+      # since it is used in several comparison methods)
+      #
+      #:no_doc:
+      def inner_representation
+        @semi
       end
   
       #:doc:
@@ -29,11 +77,7 @@ module Mext
       #
       #:nodoc:
       def to_f
-        #
-        # we suppose here that the pitch_class data is well-formed inside the
-        # object
-        #
-        self.octave + (self.semi / ::Numeric::PCC)
+        self.inner_representation.semitopch
       end
   
       #:doc:
@@ -44,7 +88,7 @@ module Mext
       #
       #:nodoc:
       def to_freq
-        self.to_f.pchcps
+        self.inner_representation.semitopch.pchcps
       end
   
       #:doc:
@@ -55,7 +99,7 @@ module Mext
       #:nodoc:
       [:>, :>=, :<, :<=, :<=>, :==, :!=, :=== ].each do
         |op|
-        define_method(op) { |other| self.to_freq.send(op, other.to_freq) }
+        define_method(op) { |other| self.inner_representation.send(op, other.inner_representation) }
       end
 
       #:doc:
@@ -66,11 +110,7 @@ module Mext
       #
       #:nodoc:
       def +(other)
-        octave = ((self.to_semitones + other.to_semitones) / 12.0).cround
-        octave = octave >= 0.0 ? octave.floor : octave.ceil
-        semis  = (self.to_semitones + other.to_semitones).cround % 12.0
-        phase  = octave >= 0.0 ? 1 : -1
-        PitchClass.new(octave, phase*semis)
+        self.class.create_from_semitones((self.inner_representation + other.inner_representation).cround)
       end
 
       #:doc:
@@ -82,8 +122,7 @@ module Mext
       #
       #:nodoc:
       def -(other)
-        tot_semi = self.to_semitones - other.to_semitones
-        PitchClass.new(0.0, tot_semi)
+        self.class.create_from_semitones((self.inner_representation - other.inner_representation).cround)
       end
 
       #:doc:
@@ -92,9 +131,7 @@ module Mext
       #
       # returns the +PitchClass+ to a number of semitones
       #
-      def to_semitones
-        self.to_f.pchtosemi
-      end
+      alias_method :to_semitones, :inner_representation
   
       #:doc:
       #
@@ -105,18 +142,30 @@ module Mext
       #
       #:nodoc:
       def interval(other)
-        other.to_semitones - self.to_semitones
+        (other - self).inner_representation
       end
 
       #:doc:
       #
       # +transpose(semitones)+
       #
-      # returns the transposition in semitones
+      # returns a +PitchClass+ transposed by +semitones+ semitones
       #
       #:nodoc:
       def transpose(semi)
-        self + PitchClass.new(0.0, semi)
+        self.class.create_from_semitones((self.inner_representation + semi).cround)
+      end
+
+      #:doc:
+      #
+      # +transpose!(semitones)+
+      #
+      # transposes the receiver by +semitones+ semitones
+      #
+      #:nodoc:
+      def transpose!(semi)
+        @semi += semi
+        self
       end
 
       #:doc:
@@ -132,7 +181,46 @@ module Mext
         self.interval(other) * prop
       end
 
+      #:doc:
+      #
+      # +add_semitones(semi)+:
+      #
+      # returns a +PitchClass+ the addition of semitones required by argument
+      #
+      # - +semi+: the semitones to add; can be any sort of +Numeric+, also
+      #           negative to subtract.
+      #
+      def add_semitones(semi)
+        self.class.create_from_semitones((self.inner_representation + semi).cround)
+      end
+
+      #:doc:
+      #
+      # +add_semitones!(semi)+:
+      #
+      # returns the addition of semitones required in the receiver's pitch class
+      #
+      # - +semi+: the semitones to add; can be any sort of +Numeric+, also
+      #           negative to subtract.
+      #
+      def add_semitones!(semi)
+        @semi += semi
+        self
+      end
+
       class << self
+
+        #:doc:
+        #
+        # +create_from_semitones+
+        #
+        # creates a +PitchClass+ object out of a semitone representation
+        #
+        #:nodoc:
+        def create_from_semitones(s)
+          new(0.0, s)
+        end
+
   
         #:doc:
         #
@@ -172,17 +260,7 @@ module Mext
       # taking into account that pitch classes can be positive or negative
       #
       def setup_with_two_arguments(oct, s)
-        octsemi = (s / 12.0)
-        octsemi = case
-                  when octsemi > 0.0 then octsemi.floor
-                  when octsemi < 0.0 then octsemi.ceil
-                  when octsemi == 0.0 then 0.0
-                  end
-        oct += octsemi
-        remainder = s >= 0.0 ? (s % 12.0) : (s % -12.0)
-        @octave = oct
-        @semi = remainder
-        self
+        (oct * ::Numeric::CNPO) + s
       end
 
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Mext
-  VERSION = '0.10.0'
+  VERSION = '0.10.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mext
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Nicola Bernardini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2019-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler