ruby-mext 0.21.1 → 0.21.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af5724f948e0ea3cdfd938e89f37c4daf105d42d3c114faa68385269907ced28
-  data.tar.gz: 17886d733497b5553741ee31022f13378a3f38d0043182b10391abebdc9fd511
+  metadata.gz: 7d543e0e00be11dea0f00c0ce6d9679d4a4c75763f4ff106eee0a262e1a0405c
+  data.tar.gz: 68ec005980d394bc22d3a17f3ab4c62706d02fc795a90b731b9393556ab338e9
 SHA512:
-  metadata.gz: 833603ff9cf2f2845fb5e3757fb5c7cef2679650439c65d3e2ea3cc7506fbea5cbd37920f56ecc067dff3820f35fba4b6a9afb0c9339b8286fc404012142fc90
-  data.tar.gz: 109db15f348ca299e959d3bd61d6371ac5f1d553e56ab9d0f5ddd8e8269f44a5e9b63a2bb9ba80667a06eee6f959f7649d3b21c91bcd113b1bb7c19fc6dc7798
+  metadata.gz: 69bd963b1dcfa608bf0735b2b7c568e949621c591146f495456866fec37688398ebc9a712905e5af8ac9c597e8408845f7ed96c50d1edc3e353522d286ccced9
+  data.tar.gz: 271c3f54fbcf26341fbf1ab681b0c04742eae5fd00fd2ec05b92118e990a85415ec7f1b90c3a13717f38132b9146d892671b2fa9400beb7064db7e9abc8d36f7

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

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

data/lib/mext/{numeric → music}/meter.rb

@@ -1,5 +1,5 @@
 module Mext
-  module Numeric
+  module Music
 
     #
     # +Meter+:
@@ -20,6 +20,7 @@ module Mext
       end
 
       def to_r
+        raise ZeroDivisionError, "#{self.numerator}/#{self.divisor} provokes a zero-division error" unless self.divisor != 0
         Rational(self.numerator, self.divisor)
       end
 
@@ -30,13 +31,22 @@ module Mext
       # we use the logic of +Rational+ to perform logic on +Meter+
       #
       [:==, :<, :<=, :>, :>=, :<=>, :===].each { |m| define_method(m) { |other| common_logic(m, other) } }
+      #
+      # we use the arithmetic of +Rational+ to perform arithmetic on +Meter+
+      #
+      [:+, :-, :*, :/, :**, :^, ].each { |m| define_method(m) { |other| common_arithmetic(m, other) } }
+
 
     private
 
       def common_logic(method, other)
-        raise ArgumentError unless other.kind_of?(Meter) || other.kind_of?(Rational)
+        raise ArgumentError, "#{other} is neither a #{self.class} nor a Rational (#{other.class})" unless other.kind_of?(Meter) || other.kind_of?(Rational)
         self.to_r.send(method, other.to_r)
       end
+
+      def common_arithmetic(method, other)
+        self.to_r.send(method, other.to_r).to_meter
+      end
   
     end
 
@@ -47,7 +57,7 @@ end
 # +Meter(n, d)+ is defined to actually mimick a +Rational()+
 #
 def Meter(n, d)
-  Mext::Numeric::Meter.new(n,d)
+  Mext::Music::Meter.new(n,d)
 end
 
 #
@@ -65,3 +75,28 @@ class String
   end
 
 end
+
+#
+# we extend the +Rational+ class to carry a +to_meter+ which
+# will convert a  into a Meter class
+#
+class Rational
+
+  def to_meter
+    Meter(self.numerator, self.denominator)
+  end
+
+end
+
+#
+# we extend the +Numeric+ class to carry a +to_meter+ which
+# will convert a  into a Meter class
+#
+class Numeric
+
+  def to_meter
+    r = self.to_r
+    Meter(r.numerator, r.denominator)
+  end
+
+end

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/mext/numeric.rb

@@ -24,7 +24,6 @@ module Mext
     NON_VECTORIZABLE_METHODS = %w(
       constants
       pitch_fork
-      meter
     )
     ADDED_METHODS = NON_VECTORIZABLE_METHODS + VECTORIZABLE_METHODS
 

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/tasks/gruff/gruff.rake

@@ -1,6 +1,6 @@
 
 desc 'plot all plots'
-task :plot => ['plot:expon', 'plot:line', 'plot:stepwise']
+task :plot => ['plot:expon', 'plot:line', 'plot:stepwise', 'plot:polynomial']
 
 namespace :plot do
 

data/lib/tasks/gruff/polynomial.rake

@@ -0,0 +1,17 @@
+require 'fileutils'
+require File.expand_path(File.join(['..'] * 4, 'spec', 'fixtures', 'polynomial_dataset'), __FILE__)
+require File.expand_path(File.join('..', 'gruff_plot'), __FILE__)
+
+namespace :plot do
+
+  desc 'plot the Polynomial dataset'
+  task :polynomial => :create_output_dir do
+    ranges = [ Range.new(0, 0) ]
+    p = Mext::Gruff::Plotter.new('polynomial_dataset', 800, Mext::Spec::Fixtures::Math::POLYNOMIAL_DATASET, ranges)
+    p.plot do
+      |args|
+      Math::Polynomial.new(args)
+    end
+  end
+
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Mext
-  VERSION = '0.21.1'
+  VERSION = '0.21.6'
 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mext
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.21.6
 platform: ruby
 authors:
 - Nicola Bernardini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-01 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wavefile
@@ -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,8 +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
@@ -169,7 +173,6 @@ files:
 - lib/mext/numeric/dbamp.rb
 - lib/mext/numeric/ftom.rb
 - lib/mext/numeric/gold.rb
-- lib/mext/numeric/meter.rb
 - lib/mext/numeric/mmtot.rb
 - lib/mext/numeric/mround.rb
 - lib/mext/numeric/mtof.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
@@ -194,10 +200,11 @@ files:
 - lib/tasks/gruff/gruff.rake
 - lib/tasks/gruff/gruff_plot.rb
 - lib/tasks/gruff/line.rake
+- lib/tasks/gruff/polynomial.rake
 - 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 +223,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.'