ruby-mext 0.21.4 → 0.21.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38c48bcd24251667ce5add29d5fdce2e84bbe79e96a28a8186908fbd497135fb
-  data.tar.gz: 2c5b300ff3d78301ebcabd3103c45f2b10cb70873e43403fea362d6010b44d00
+  metadata.gz: f2f4f4f25273a53383d136a74e37bc86532da799ffcda4a158216d87e68e4eaf
+  data.tar.gz: 006b52ca22341b85fe7f3e6bfb2a53d8242880fb66e5e577ead3a1fe437e29f3
 SHA512:
-  metadata.gz: 4214e793102277046d77c518771cf14d2edd2f499557f613c9e615f6639cff7f3897c9aa9a4a9e7572e7034703c6d8249ad8d69779f8df8135b9a4568c069db3
-  data.tar.gz: 7bc0794803b8c1659b9e669bd9ca60ed1fb6135393a9dc0f7ea207047fb317bdfa32920429afc6f7464765831ec23ec621a72cda4c4f9a1ce5c317f70e55aae0
+  metadata.gz: c0aede90dcd997f577eea7f96280c38e1bd815983f746a026f22b0ebe3e7a8a588b762c37a3e76345b7d8159181bf5c11af08e5f8bcf844d362f10a9b3172db3
+  data.tar.gz: 56c1b1346179f2daee885cfb0d1e68c929d79b42a5260a618892a226348b9cc3b36fbc1e83f2612e97cec6b87a6166df4db654980a32c6edc6089cc6b0c807c9

data/README.md

@@ -10,6 +10,11 @@ These are extensions of usual idiomatic `ruby` objects (i.e. `Numeric`,
 It is the usual unfinished ever-expanding project. Feel free to contribute to
 it in the form of pull requests if you are so inclined.
 
+## Requirements
+
+Some `Function`s (notably: `Mext::Math::Polynomial`) require [`octave`](https://octave.org) to be
+installed and running on the same computer.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/mext/math.rb

@@ -10,4 +10,5 @@ end
   expon
   log
   stepwise
+  polynomial
 ).each { |f| require File.join(Mext::MATH_PATH, f) }

data/lib/mext/math/polynomial.rb

@@ -0,0 +1,95 @@
+module Math
+
+  class Polynomial < Function
+
+    #
+    # +:values+
+    #
+    # is an array of pairs (+x+, +y+)
+    #
+    attr_reader :values, :factors
+
+    #
+    # +Math::Polynomial.new(values = [])+
+    #
+    # stepwise function
+    #
+    # Arguments are:
+    #
+    # +values+:         an array of (+x+, +y+) pairs
+    #
+    #:nodoc:
+    def initialize(vs = [])
+      setup(vs)
+    end
+
+    #:doc:
+    #
+    # +y(x)+:
+    #
+    # Returns a value for any given x
+    #
+    #:nodoc:
+    def y(x)
+      calculate(x)
+    end
+
+    def label
+      'polynomial function'
+    end
+
+    class << self
+
+      #
+      # +from_yaml(yaml_hash)+:
+      #
+      # creates a Math::Polynomial class from a yaml file which must have the
+      # relevant fields:
+      #
+      # +values+: an array of duples [x, y]
+      #
+      def from_yaml(yh)
+        new(yh['values'])
+      end
+
+    end
+
+  private
+
+    def calculate(x)
+      result = 0
+      idx = self.factors.size-1
+      fidx = 0
+      idx.downto(0) do
+        |n|
+        result += (self.factors[fidx]*(x**(n)))
+        fidx += 1
+      end
+      result
+    end
+
+    #
+    # +setup+
+    #
+    # calls +octave+'s +polyfit+ function to load the factors of the
+    # polynomial
+    #
+    #:nodoc:
+    def setup(vs)
+      @values = []
+      sorted = vs.sort { |a, b| a[0] <=> b[0] }
+      @values.concat(sorted)
+      xs = self.values.map { |v| v[0] }
+      ys = self.values.map { |v| v[1] }
+      porder = vs.size
+      @factors = ::Octave::Io::polyfit(xs, ys, porder)
+      #
+      # keep in mind that vs might be empty
+      #
+      @x_start = self.values.first ? self.values.first.first : self.values.first
+      @x_end   = self.values.last ? self.values.last.first : self.values.last
+    end
+
+  end
+
+end

data/lib/mext/music.rb

@@ -7,4 +7,6 @@ end
 %w(
   pitch_class
   meter
+  note_name
+  note_names
 ).each { |f| require File.join(Mext::MUSIC_PATH, f) }

data/lib/mext/music/note_name.rb

@@ -0,0 +1,43 @@
+module Mext
+  module Music
+    #
+    # +Mext::Music::NoteName+
+    #
+    # produces all the conversions from a named note to +pitch frequency+,
+    # +pitch class+, +LilyPond notation+, etc.
+    #
+    # In these conversions we assume that 8 is the central octave.
+    #
+    class NotALilypondName < StandardError; end
+    class NoteName
+
+      DEFAULT_NOTE_NAME_OFFSET = 9 # central 'A' 440 is 8.09, isn't it?
+      LILY_NOTE_NAMES = %w( a b c d e f )
+
+      attr_reader :name, :index
+
+      def initialize(name, idx)
+        @name = name
+        @index = idx
+      end
+
+      def to_lily(octave = 8, other = '') # 8 is the central octave
+        nn = self.name.sub(/\A\s*(.).*$/, '\1').downcase
+        raise NotALilypondName, "\"#{self.name}\" does not contain a note" unless LILY_NOTE_NAMES.include?(nn)
+        sharps = (self.name.match?(/\A\s*\w#/) && self.name.sub(/\A\s*\w(#+).*$/, '\1').gsub(/#/, 'is')) || nil
+        flats = (self.name.match?(/\A\s*\w[Ff]/) && self.name.sub(/\A\s*\w([Ff]+).*$/, '\1').gsub(/[Ff]/, 'es')) || nil
+        accs = sharps ? sharps : (flats ? flats : '')
+        "#{nn}#{accs}#{octave}#{other}"
+      end
+
+      def to_pitch_class(octave = 8) # 8 is the central octave
+        octave + (self.index/100.0)
+      end
+
+      def to_frequency(octave = 8)
+        self.to_pitch_class(octave).pchcps
+      end
+
+    end
+  end
+end

data/lib/mext/music/note_names.rb

@@ -0,0 +1,8 @@
+module Mext
+  module Music
+
+    DEFAULT_ANGLO_NAMES = %w(A B C D E F G)
+    DEFAULT_ITA_NAMES   = %w(Do Re Mi Fa Sol La Si)
+
+  end
+end

data/lib/octave.rb

@@ -0,0 +1,12 @@
+module Mext
+  module Octave
+
+    PATH = File.expand_path(File.join('..', 'octave'), __FILE__)
+
+  end
+end
+
+%w(
+  io
+  polyfit
+).each { |f| require File.join(Mext::Octave::PATH, f) }

data/lib/octave/io.rb

@@ -0,0 +1,29 @@
+module Octave
+
+  module Io
+
+    class << self
+
+      OCTAVE_EXE='/usr/bin/env octave -q'
+      #
+      # +Octave::Io.command(command_string)+
+      #
+      # send a command to Octave in a pipe and return the results.
+      # The results are returned as arrays of float values
+      #
+      def command(command_string)
+        res = []
+        decorated_command_string = "echo \"#{command_string}\" | #{OCTAVE_EXE}"
+        IO.popen(decorated_command_string) do
+          |octave_result|
+          out = octave_result.readlines.map { |l| l.chomp }
+          out.each { |line| res << line.to_f if line.match?(/\s*\d+/) }
+        end
+        res
+      end
+
+    end
+
+  end
+
+end

data/lib/octave/polyfit.rb

@@ -0,0 +1,22 @@
+module Octave
+
+  module Io
+
+    class << self
+
+      #
+      # +Octave::Io.polyfit(x, y, n)+
+      #
+      # get the coefficients of an n-degree polynomial
+      # using +octave+'s +polyfit+ function
+      #
+      def polyfit(x, y, n)
+        command_string = "a = polyfit(#{x}, #{y}, #{n}); a'"
+        ::Octave::Io.command(command_string)
+      end
+
+    end
+
+  end
+
+end

data/lib/ruby-mext.rb

@@ -8,5 +8,6 @@ end
 
 %w(
   ruby
+  octave
   mext
 ).each { |f| require File.join(Mext::ROOT, f) }

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Mext
-  VERSION = '0.21.4'
+  VERSION = '0.21.5'
 end

data/ruby-mext.gemspec

@@ -7,11 +7,11 @@ Gem::Specification.new do |spec|
   spec.name          = 'ruby-mext'
   spec.version       = Mext::VERSION
   spec.authors       = ['Nicola Bernardini']
-  spec.email         = ['nicb@sme-ccppd.org']
+  spec.email         = ['nicola.bernardini.rome@gmail.com']
 
   spec.summary       = %q{ruby-mext: musical extensions for the Ruby language.}
   spec.description   = %q{ruby-mext: musical extensions for the Ruby language.}
-  spec.homepage      = 'https://github.com/nicb/ruby-mext'
+  spec.homepage      = 'https://git.smerm.org/nicb/ruby-mext'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -36,6 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rdoc'
   spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'gruff'
+  spec.add_development_dependency 'matplotlib'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mext
 version: !ruby/object:Gem::Version
-  version: 0.21.4
+  version: 0.21.5
 platform: ruby
 authors:
 - Nicola Bernardini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wavefile
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: gruff
+  name: matplotlib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,7 +124,7 @@ dependencies:
         version: '0'
 description: 'ruby-mext: musical extensions for the Ruby language.'
 email:
-- nicb@sme-ccppd.org
+- nicola.bernardini.rome@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -157,9 +157,12 @@ files:
 - lib/mext/math/function.rb
 - lib/mext/math/line.rb
 - lib/mext/math/log.rb
+- lib/mext/math/polynomial.rb
 - lib/mext/math/stepwise.rb
 - lib/mext/music.rb
 - lib/mext/music/meter.rb
+- lib/mext/music/note_name.rb
+- lib/mext/music/note_names.rb
 - lib/mext/music/pitch_class.rb
 - lib/mext/numeric.rb
 - lib/mext/numeric/addsemi.rb
@@ -185,6 +188,9 @@ files:
 - lib/mext/sound.rb
 - lib/mext/sound/info.rb
 - lib/mext/utilities.rb
+- lib/octave.rb
+- lib/octave/io.rb
+- lib/octave/polyfit.rb
 - lib/ruby-mext.rb
 - lib/ruby.rb
 - lib/ruby/extensions.rb
@@ -197,7 +203,7 @@ files:
 - lib/tasks/gruff/stepwise.rake
 - lib/version.rb
 - ruby-mext.gemspec
-homepage: https://github.com/nicb/ruby-mext
+homepage: https://git.smerm.org/nicb/ruby-mext
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
@@ -216,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.2
 signing_key: 
 specification_version: 4
 summary: 'ruby-mext: musical extensions for the Ruby language.'