ruby-mext 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a8ef82a4d0e377ee67f260e3adc5f0aec0cf082abdf9f185f84cd596088f9af
-  data.tar.gz: e477a325f72a4ac3034c888c78a6f36b2c4b08539ac5d4424977467f2bfea726
+  metadata.gz: e17fe59684741fe17bcb1115faf090621239cdc7afb3823a3601ae7b8e643449
+  data.tar.gz: 670b6028c1a79e8feaac202c9ddb3da4f07f5d72e93a3a5d862e3a9f9ce58e7a
 SHA512:
-  metadata.gz: a394a770eb6b7d0babb8ddeeaed4e9a88e52644b9cf5cbd008d124ba68b700cbc9c388023ccd5b4af2461870bcc96616e28c25549a3aeee646ff399dba63e196
-  data.tar.gz: 3f829693124772fc1e77080223914da0a9a525fa7f1ed191340d99c4a905d9a1d2855baae28b8dec3c2559b345f09f63dd8c669c0c353077ab415f68cdeefb15
+  metadata.gz: a09e8d92256aadcd2bbfe12fa3ec7caffb4c33c2213f7e1e5843a810cef484c580b39db9c064f0da2a83c562c63e0b51d06e1a391343903777f5bc23192baa6e
+  data.tar.gz: 7e5414a0aa5f5790286825e2acf7c800e3a43b8d315b29df1a35bb8f7d97c8587909dba9d62f256d8431ad63935aa9313c14d488f9ac66bb6581521481245c9e

data/.gitignore

@@ -7,4 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-.byebug_history
+/.byebug_history
+/.rake_tasks~

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/nicb/ruby-mext.svg?branch=master)](https://travis-ci.org/nicb/ruby-mext)
 [![Maintainability](https://api.codeclimate.com/v1/badges/53686892aa9ee6a30ebb/maintainability)](https://codeclimate.com/github/nicb/ruby-mext/maintainability)
+[![Gem Version](https://badge.fury.io/rb/ruby-mext.svg)](https://badge.fury.io/rb/ruby-mext)
 
 These are extensions of usual idiomatic `ruby` objects (i.e. `Numeric`,
 `Array`, etc.) that make `ruby` a comfortable language for musicians.

data/lib/mext/{numeric/exceptions.rb → exceptions.rb}

@@ -1,4 +1,4 @@
-class Numeric
+module Mext
 
   #
   # +NegativeNumeric+ is raised on certain operations that do not allow
@@ -6,4 +6,10 @@ class Numeric
   #
   class NegativeNumeric < StandardError; end
 
+  #
+  # +PureAbstractMethodCalled+ is raised when an abstract
+  # base class is called
+  #
+  class PureAbstractMethodCalled < StandardError; end
+
 end

data/lib/mext/math/expon.rb

@@ -2,9 +2,9 @@ require 'cmath'
 
 module Math
 
-  class Expon
+  class Expon < Function
 
-    attr_reader :y_start, :y_end, :x_start, :x_end, :tau
+    attr_reader :y_start, :y_end, :tau
     attr_reader :a, :b, :c
 
     #
@@ -47,28 +47,6 @@ module Math
       (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

data/lib/mext/math/function.rb

@@ -0,0 +1,56 @@
+module Math
+
+  class Function
+
+    attr_reader :x_start, :x_end
+    #
+    # +Math::Function.new+:
+    #
+    # abstract base class function
+    #
+    #:nodoc:
+    def initialize
+      setup
+    end
+
+    #:doc:
+    #
+    # +y(x)+:
+    #
+    # Returns a real value given x
+    #
+    #:nodoc:
+    def y(x)
+    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
+      raise Mext::PureAbstractMethodCalled
+    end
+
+  end
+
+end

data/lib/mext/math/line.rb

@@ -0,0 +1,51 @@
+module Math
+
+  class Line < Function
+
+    attr_reader :y_start, :y_end
+    attr_reader :a, :b
+
+    #
+    # +Math::Line.new(ystart, yend, xstart, xend)+:
+    #
+    # linear interpolation `y = a*x + b` where:
+    #
+    # `a = (yend-ystart)/(xend-xstart)`
+    # `b = ystart - (a*xstart)`
+    #
+    # Arguments are:
+    #
+    # +ystart+, +yend+: start/end y values required
+    # +xstart+, +xend+: start/end x values
+    #
+    #:nodoc:
+    def initialize(ys, ye, xs, xe)
+      @y_start = ys.to_f
+      @y_end   = ye.to_f
+      @x_start = xs.to_f
+      @x_end   = xe.to_f
+      setup
+    end
+
+    #:doc:
+    #
+    # +y(x)+:
+    #
+    # Returns a real value given x
+    #
+    #:nodoc:
+    def y(x)
+      (self.a*x) + self.b
+    end
+
+  private
+
+    def setup
+      @a = (self.y_end - self.y_start)/(self.x_end - self.x_start)
+      @b = (self.y_start - (self.x_start * self.a))
+    end
+
+  end
+
+end
+

data/lib/mext/math.rb

@@ -5,5 +5,7 @@ module Mext
 end
 
 %w(
+  function
+  line
   expon
 ).each { |f| require File.join(Mext::MATH_PATH, f) }

data/lib/mext/numeric/ampdb.rb

@@ -6,7 +6,7 @@ class Numeric
   # interprets its receiver as a linear value and returns it in dB
   #
   def ampdb
-    raise NegativeNumeric if self < 0.0
+    raise Mext::NegativeNumeric if self < 0.0
     20*Math::log10(self)
   end
 

data/lib/mext/numeric/cpspch.rb

@@ -8,7 +8,7 @@ class Numeric
   #:nodoc:
 
   def cpspch
-    raise NegativeNumeric if self <= 0.0
+    raise Mext::NegativeNumeric if self <= 0.0
 
     midi_note = self.ftom
 

data/lib/mext/numeric/ftom.rb

@@ -7,7 +7,7 @@ class Numeric
   #
 
   def ftom
-    raise NegativeNumeric if self < 0.0
+    raise Mext::NegativeNumeric if self < 0.0
     MIDI_PITCH_FORK + (12.0*Math::log2(self/self.class.pitch_fork))
   end
 

data/lib/mext/numeric.rb

@@ -5,7 +5,6 @@ module Mext
 end
 
 %w(
-  exceptions
   pitch_fork
   mtof
   ftom

data/lib/mext.rb

@@ -5,6 +5,7 @@ module Mext
 end
 
 %w(
+  exceptions
   numeric
   array
   math

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Mext
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mext
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Nicola Bernardini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-22 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,13 +116,15 @@ files:
 - lib/mext.rb
 - lib/mext/array.rb
 - lib/mext/array/choose.rb
+- lib/mext/exceptions.rb
 - lib/mext/math.rb
 - lib/mext/math/expon.rb
+- lib/mext/math/function.rb
+- lib/mext/math/line.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