ruby-mext 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 773f3e12f73de66842d7642971dcea4b2867739ef6b4cc31cd5817e0ffe4ffe6
-  data.tar.gz: 15072b30760291f0018672562ab5f3a7b3a72a3e943b63822b2ef334c4a4cbb5
+  metadata.gz: f9b816eb8358ac2720a30375f4d7c5c85a8d99b61781efd8eea22ba931e54b5e
+  data.tar.gz: fe9a1ad5339a33fc710319bcd9c512538aec99902ebd3ac5bee8e0b617bef013
 SHA512:
-  metadata.gz: d90bc088598500d36d74bfecc0dcf56cbc7be5f1e4f9febbbbd954ce2d49da1c3bc6b949729363da5ffe0d8476361ddc10ac66fb4da040efcc7fd6babe44bc3d
-  data.tar.gz: 66a518a399b40aadaf5e9e318489951859eed2c8412f655336c802f0195bb8713b68aeb25873f91388f8daa960669a91f6f154f01c1c86bca5c384abad75d46b
+  metadata.gz: 77455bc326bfe523232abca1f8985ea6ded5a7368c06ca41f2b10f551b541b656c4d402b0e10fcf7946895169ad4e2c6c2ee7c7c9260319602081c71900e2f9c
+  data.tar.gz: c02ba1e2882ad0760cb7c217980c92c7d65896f6cb7e42c086f7f428efa57852c0a5f30f2400a181d364fe4ff84ee00f416f876d863dfa90d7a743934dc70340

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require 'rdoc/task'
+require 'ruby-mext'
 
 RDoc::Task.new do |rdoc|
   rdoc.main = "README.md"
@@ -10,3 +11,5 @@ end
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+Dir.glob(File.expand_path(File.join('..', 'lib', 'tasks', '**', '*.rake'), __FILE__)).each { |f| load f }

data/lib/mext/math/expon.rb

@@ -0,0 +1,88 @@
+require 'cmath'
+
+module Math
+
+  class Expon
+
+    attr_reader :y_start, :y_end, :x_start, :x_end, :tau
+    attr_reader :a, :b, :c
+
+    #
+    # +DEFAULT_TAU+: default exponential curvature factor for +expon()+
+    #
+    DEFAULT_TAU = 0.01
+
+    #
+    # +Math::Expon.new(ystart, yend, xstart, xend, tau = DEFAULT_TAU)+:
+    #
+    # exponential curve `y = e^(a*x + b) + c` where:
+    #
+    # `c = yend + tau`
+    #
+    # Arguments are:
+    #
+    # +ystart+, +yend+: start/end y values required
+    # +xstart+, +xend+: start/end x values
+    # +tau+: the curvature factor
+    #
+    #:nodoc:
+    def initialize(ys, ye, xs, xe, tau = DEFAULT_TAU)
+      @y_start = ys
+      @y_end   = ye
+      @x_start = xs
+      @x_end   = xe
+      @tau     = tau
+      setup
+    end
+
+    #:doc:
+    #
+    # +y(x)+:
+    #
+    # Returns a real value (forcing any complex result to its modulus) for any
+    # given x
+    #
+    #:nodoc:
+    def y(x)
+      (CMath::exp(self.a*x + self.b) + self.c).abs   # we want a real number result, no complex please
+    end
+
+    #:doc:
+    #
+    # +xy(step)+
+    #
+    # Returns a full deployment of the function evaluated with a step of
+    # +step+. It is returned in two arrays - one for the +x+ values and the
+    # other for the +y+ values.
+    #
+    # This method is mainly for testing purposes with the dataxy method of +gruff+ 
+    #
+    #:nodoc:
+    def xy(s)
+      resx = []
+      resy = []
+      self.x_start.step(x_end, s) do
+        |x|
+        resx << x
+        resy << self.y(x)
+      end
+      [resx, resy]
+    end
+
+  private
+
+    def setup
+       @c = self.y_end + self.tau
+
+       exp_sv = self.y_start - self.c        # start value of the exponential
+       exp_ev = self.y_end - self.c          # end value of the exponential
+       x_length = self.x_end - self.x_start
+
+       @a = (CMath::log(exp_ev) - CMath::log(exp_sv)) / x_length;
+       @b= CMath::log(exp_sv) - (self.a * x_start);
+
+    end
+
+  end
+
+end

data/lib/mext/math.rb

@@ -0,0 +1,9 @@
+module Mext
+
+  MATH_PATH = File.join(Mext::PATH, 'math')
+
+end
+
+%w(
+  expon
+).each { |f| require File.join(Mext::MATH_PATH, f) }

data/lib/mext/numeric/cpspch.rb

@@ -0,0 +1,18 @@
+class Numeric
+
+  #
+  # +cpspch+: frequency to pitch class converter
+  #
+  # interprets its receiver as frequency and returns its corresponing pitch class
+  #
+  #:nodoc:
+
+  def cpspch
+    raise NegativeNumeric if self <= 0.0
+
+    midi_note = self.ftom
+
+    midi_note.mtopch
+  end
+
+end

data/lib/mext/numeric/mtopch.rb

@@ -0,0 +1,20 @@
+class Numeric
+
+  #
+  # +mtopch+: MIDI note to pitch class converter
+  #
+  # interprets its receiver as a MIDI note and returns its corresponing pitch class
+  #
+  #:nodoc:
+
+  def mtopch
+
+    intv = (self - MIDI_MIDDLE_C) / CHROMATIC_NOTES_PER_OCTAVE
+
+    intv_octave = intv.to_i
+    intv_semi = (intv - intv_octave) * CHROMATIC_NOTES_PER_OCTAVE;
+
+    PITCH_MIDDLE_C + intv_octave + (intv_semi/100.0);
+  end
+
+end

data/lib/mext/numeric/pchcps.rb

@@ -0,0 +1,16 @@
+class Numeric
+
+  #
+  # +pchcps+: pitch class converter to frequency
+  #
+  # interprets its receiver as pitch class and returns its corresponing frequency
+  #
+  #:nodoc:
+
+  def pchcps
+    m_note = self.pchtom
+
+    m_note.mtof
+  end
+
+end

data/lib/mext/numeric/pchtom.rb

@@ -0,0 +1,26 @@
+class Numeric
+
+  #
+  # +pchtom+: pitch class to MIDI note converter
+  #
+  # interprets its receiver as a pitch class and returns its corresponing MIDI note
+  #
+  #:nodoc:
+  MIDI_MIDDLE_C = 60
+  PITCH_MIDDLE_C = 8.0
+  CHROMATIC_NOTES_PER_OCTAVE = 12.0
+
+  def pchtom
+    p_octave = self.to_i
+    p_note = (self - p_octave) * 100
+    ref = self < 0.0 ? -CHROMATIC_NOTES_PER_OCTAVE : CHROMATIC_NOTES_PER_OCTAVE
+
+    p_octave += (p_note / CHROMATIC_NOTES_PER_OCTAVE).to_i # cater for octave wrapping
+    p_note   = (p_note % ref);                             # reduce note in a 0-11 space (keeping track of sign)
+
+    m_octave = ((p_octave - PITCH_MIDDLE_C)*CHROMATIC_NOTES_PER_OCTAVE) + MIDI_MIDDLE_C; # find the appropriate midi octave
+
+    m_octave + p_note
+  end
+
+end

data/lib/mext/numeric/rrand.rb

@@ -0,0 +1,32 @@
+class Numeric
+
+  #
+  # +rrand(upper)+: random number generator
+  #
+  # returns a random number in the range receiver-upper bound
+  # 
+  # If any of the numbers (the receiver +or+ the argument) are +Float+s
+  # the method will return a +Float+. If both arguments are integers then an
+  # +Integer+ will be returned.
+  #
+  # (this method is present in the SuperCollider sclang interpreter)
+  #
+  #:nodoc:
+
+  def rrand(upper)
+    lobound = self.to_f
+    rng = upper.to_f - lobound
+
+    (rand()*rng) + lobound
+  end
+
+end
+
+class Integer
+
+  def rrand(upper)
+    res = super(upper)
+    upper.is_a?(Integer) ? res.round : res
+  end
+
+end

data/lib/mext/numeric.rb

@@ -11,4 +11,9 @@ end
   ftom
   ampdb
   dbamp
+  pchtom
+  mtopch
+  cpspch
+  pchcps
+  rrand
 ).each { |f| require File.join(Mext::NUMERIC_PATH, f) }

data/lib/mext.rb

@@ -6,4 +6,5 @@ end
 
 %w(
   numeric
+  math
 ).each { |f| require File.join(Mext::PATH, f) }

data/lib/tasks/clean.rake

@@ -0,0 +1,5 @@
+require 'rake/clean'
+
+CLEAN.include('tmp')
+CLEAN.include('html')
+CLEAN.include('pkg')

data/lib/tasks/gruff/expon.rake

@@ -0,0 +1,20 @@
+require 'fileutils'
+require File.expand_path(File.join(['..'] * 4, 'spec', 'fixtures', 'expon_dataset'), __FILE__)
+require File.expand_path(File.join('..', 'gruff_plot'), __FILE__)
+
+namespace :plot do
+
+  task :create_output_dir do
+    unless Dir.exists?(Mext::Gruff::Plotter::OUTPUT_PATH)
+      mkdir_p Mext::Gruff::Plotter::OUTPUT_PATH
+    end
+  end
+
+  desc 'plot the Expon dataset'
+  task :expon => :create_output_dir do
+    ranges = [ Range.new(0, 2), Range.new(3,3) ]
+    p = Mext::Gruff::Plotter.new('expon_dataset', 800, Mext::Spec::Fixtures::Math::EXPON_DATASETS, ranges)
+    p.plot
+  end
+
+end

data/lib/tasks/gruff/gruff.rake

@@ -0,0 +1,3 @@
+
+desc 'plot all plots'
+task :plot => ['plot:expon']

data/lib/tasks/gruff/gruff_plot.rb

@@ -0,0 +1,39 @@
+require 'gruff'
+
+module Mext
+  module Gruff
+
+    class Plotter
+      attr_reader :title, :size, :datasets, :ranges
+
+      OUTPUT_PATH = File.expand_path(File.join(['..'] * 4, 'tmp', 'output'), __FILE__)
+
+      def initialize(t, s, ds, r = nil)
+        @title = t
+        @size = s
+        @datasets = ds
+        @ranges = r
+      end
+
+      def plot
+        @ranges = [Range.new(0, self.datasets-1)] unless self.ranges
+        idx = 0
+        self.ranges.each do
+          |range|
+          g = ::Gruff::Line.new(self.size)
+          g.title = self.title + " (#{idx})"
+          self.datasets[range].each do
+            |args|
+            (ys, ye, xs, xe, tau, xmid, ymid) = args
+            f = Math::Expon.new(ys, ye, xs, xe, tau)
+            (xdata, ydata) = f.xy(0.1)
+            g.dataxy("tau: #{f.tau}", xdata, ydata)
+          end
+          g.write(File.join(Mext::Gruff::Plotter::OUTPUT_PATH, self.title.gsub(/\s+/, '_') + "_#{idx}.png"))
+          idx += 1
+        end
+      end
+
+    end
+  end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Mext
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/ruby-mext.gemspec

@@ -34,5 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rdoc'
   spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'gruff'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mext
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nicola Bernardini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-20 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gruff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'ruby-mext: musical extensions for the Ruby language.'
 email:
 - nicb@sme-ccppd.org
@@ -100,14 +114,25 @@ files:
 - bin/console
 - bin/setup
 - lib/mext.rb
+- lib/mext/math.rb
+- lib/mext/math/expon.rb
 - lib/mext/numeric.rb
 - lib/mext/numeric/ampdb.rb
+- lib/mext/numeric/cpspch.rb
 - lib/mext/numeric/dbamp.rb
 - lib/mext/numeric/exceptions.rb
 - lib/mext/numeric/ftom.rb
 - lib/mext/numeric/mtof.rb
+- lib/mext/numeric/mtopch.rb
+- lib/mext/numeric/pchcps.rb
+- lib/mext/numeric/pchtom.rb
 - lib/mext/numeric/pitch_fork.rb
+- lib/mext/numeric/rrand.rb
 - lib/ruby-mext.rb
+- lib/tasks/clean.rake
+- lib/tasks/gruff/expon.rake
+- lib/tasks/gruff/gruff.rake
+- lib/tasks/gruff/gruff_plot.rb
 - lib/version.rb
 - ruby-mext.gemspec
 homepage: https://github.com/nicb/ruby-mext