compsci 0.3.1.1 → 0.3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1ad9a59954ea3377e0e03992dd660fabaf7c65389d633f1e607d3a5b6731ebd
-  data.tar.gz: 5b893649cae5840c590bf4998429087cf50ad9dc97169a2c3ee1566c86748196
+  metadata.gz: 265cce45b9c0791d768d79d890bdfd3b2f3dd0f9d3b5346798274095bd38efa1
+  data.tar.gz: c921f58718dc3df31cb89572a9b428cbf9add53e6ed8d7b3f433fb8eb4dde0a4
 SHA512:
-  metadata.gz: 64100e3719380956c844e7f9eb3949eae097a6d9426b039d0d224260d4bd18a1e1dd7ad7f147643203e21b3ba95d0109bed198d8e5421c9e3c6c21312665b426
-  data.tar.gz: c8944161d1ee4b4df7afac5d27bc0801b2953893ea45db03c30ec1e9f5ee74764638464ee1c3d4d3707107370dd547eedb1f62d09cfe9f20f2efb399e462258f
+  metadata.gz: 6f7bf484573f12573ed1f3705634aacd3f7c47508df8983e5bfe92908923d4bf9495dc3ae65deb69749fa326185ec08a8233dd2689f4b400db553a65d2272708
+  data.tar.gz: c5db4b1e31b10b031dec20a21806fae10853ad7cd9bc62817f374fbef10df4934d1a16c6ea1d9a7d0ebb3c46f9c470077984d983f94755a417a130330d101431

data/README.md

@@ -1,7 +1,5 @@
-[![Build Status](https://travis-ci.org/rickhull/compsci.svg?branch=master)](https://travis-ci.org/rickhull/compsci)
+[![CI Status](https://github.com/rickhull/compsci/actions/workflows/ci.yaml/badge.svg)](https://github.com/rickhull/compsci/actions/workflows/ci.yaml)
 [![Gem Version](https://badge.fury.io/rb/compsci.svg)](https://badge.fury.io/rb/compsci)
-[![Dependency Status](https://gemnasium.com/rickhull/compsci.svg)](https://gemnasium.com/rickhull/compsci)
-[![Security Status](https://hakiri.io/github/rickhull/compsci/master.svg)](https://hakiri.io/github/rickhull/compsci/master)
 
 # CompSci
 
@@ -213,6 +211,8 @@ alphabetical order.
 
 ## [`Simplex`](lib/compsci/simplex.rb) class
 
+### WORK IN PROGRESS; DO NOT USE
+
 The [Simplex algorithm](https://en.wikipedia.org/wiki/Simplex_algorithm)
 is a technique for
 [Linear programming](https://en.wikipedia.org/wiki/Linear_programming).

data/VERSION

@@ -1 +1 @@
-0.3.1.1
+0.3.2.3

data/compsci.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/rickhull/compsci"
   s.license = "LGPL-3.0"
 
-  s.required_ruby_version = "~> 2"
+  s.required_ruby_version = "~> 3.0"
 
   s.version = File.read(File.join(__dir__, 'VERSION')).chomp
 
@@ -15,9 +15,11 @@ Gem::Specification.new do |s|
   s.files += Dir['test/**/*.rb']
   s.files += Dir['examples/**/*.rb']
 
+  s.add_dependency "matrix", "~> 0.4"
+
   s.add_development_dependency "buildar", "~> 3.0"
-  s.add_development_dependency "minitest", ">= 5.0"
-  s.add_development_dependency "rake", ">= 12.3.3" # CVE-2020-8130
+  s.add_development_dependency "minitest", "~> 5.0"
+  s.add_development_dependency "rake", "~> 12.3" # CVE-2020-8130
   s.add_development_dependency "flog", "~> 0"
   s.add_development_dependency "flay", "~> 0"
   s.add_development_dependency "roodi", "~> 0"

data/lib/compsci/fit.rb

@@ -153,5 +153,22 @@ module CompSci
 
       return Math.exp(a), b, self.error(xys) { |x| (Math.exp(a) * (x ** b)) }
     end
+
+    def self.predict(model, a, b, x)
+      case model
+      when :constant
+        a
+      when :logarithmic
+        a + b * Math.log(x)
+      when :linear
+        a + b * x
+      when :exponential
+        a * Math::E ** (b * x)
+      when :power
+        a * x ** b
+      else
+        raise("unknown model: #{model}")
+      end
+    end
   end
 end

data/lib/compsci/names/pokemon.rb

@@ -34,8 +34,8 @@ module CompSci::Names::Pokemon
   # a hash of all the names, keyed by the first letter
   def self.read_hash(path: DATAFILE)
     hsh = Hash.new { |h, k| h[k] = [] }
-    File.open(path).each_line { |l|
-      hsh[l[0]] << l.chomp
+    File.open(path).each_line { |line|
+      hsh[line.chr] << line.chomp
     }
     hsh
   end

data/lib/compsci/simplex/parse.rb

@@ -82,7 +82,11 @@ class CompSci::Simplex
     end
   end
 
-  def self.problem(maximize: nil, constraints: [], **kwargs)
+  def self.problem(**kwargs)
+    self.new(*self.get_params(**kwargs))
+  end
+
+  def self.get_params(maximize: nil, constraints: [], **kwargs)
     if maximize
       expr, maximize = maximize, true
     elsif kwargs[:minimize]
@@ -116,7 +120,7 @@ class CompSci::Simplex
       a.push cofs
       b.push rhs
     }
-    self.new(c, a, b)
+    [c, a, b]
   end
 
   def self.maximize(expression, *ineqs)

data/lib/compsci/simplex.rb

@@ -26,35 +26,36 @@ class CompSci::Simplex
     @max_pivots = DEFAULT_MAX_PIVOTS
 
     # Problem dimensions; these never change
-    @num_non_slack_vars = num_vars
-    @num_constraints    = num_inequalities
-    @num_vars           = @num_non_slack_vars + @num_constraints
+    @num_free_vars   = num_vars
+    @num_basic_vars = num_inequalities
+    @total_vars      = @num_free_vars + @num_basic_vars
 
     # Set up initial matrix A and vectors b, c
-    @c = c.map { |flt| -1 * flt } + Array.new(@num_constraints, 0)
+    # store all input values as Rational (via #rationalize)
+    @c = c.map { |flt| -1 * flt.rationalize } + Array.new(@num_basic_vars, 0)
     @a = a.map.with_index { |ary, i|
-      if ary.size != @num_non_slack_vars
+      if ary.size != @num_free_vars
         raise ArgumentError, "a is inconsistent"
       end
-      # set diagonal to 1 (identity matrix?)
-      ary + Array.new(@num_constraints) { |ci| ci == i ? 1 : 0 }
+      # add identity matrix
+      ary.map { |flt| flt.rationalize } +
+        Array.new(@num_basic_vars) { |ci| ci == i ? 1 : 0 }
     }
-    @b = b
+    @b = b.map { |flt| flt.rationalize }
 
-    # set initial solution: all non-slack variables = 0
-    @basic_vars = (@num_non_slack_vars...@num_vars).to_a
+    @basic_vars = (@num_free_vars...@total_vars).to_a
     self.update_solution
   end
 
   # does not modify vector / matrix
   def update_solution
-    @x = Array.new(@num_vars, 0)
+    @x = Array.new(@total_vars, 0)
 
     @basic_vars.each { |basic_var|
       idx = nil
-      @num_constraints.times { |i|
+      @num_basic_vars.times { |i|
         if @a[i][basic_var] == 1
-          idx =i
+          idx = i
           break
         end
       }
@@ -78,7 +79,7 @@ class CompSci::Simplex
   end
 
   def current_solution
-    @x[0...@num_non_slack_vars]
+    @x[0...@num_free_vars]
   end
 
   def can_improve?
@@ -121,7 +122,7 @@ class CompSci::Simplex
     }
 
     # update A and B
-    @num_constraints.times { |i|
+    @num_basic_vars.times { |i|
       next if i == pivot_row
       r = @a[i][pivot_column]
       @a[i] = @a[i].map.with_index { |val, j| val - r * @a[pivot_row][j] }
@@ -134,7 +135,7 @@ class CompSci::Simplex
   def pivot_row(column_ix)
     min_ratio = nil
     idx = nil
-    @num_constraints.times { |i|
+    @num_basic_vars.times { |i|
       a, b = @a[i][column_ix], @b[i]
       next if a == 0 or (b < 0) ^ (a < 0)
       ratio = Rational(b, a)

data/lib/compsci/timer.rb

@@ -1,5 +1,9 @@
 module CompSci
-  module Timer
+  class Timer
+    SECS_PER_MIN = 60
+    MINS_PER_HOUR = 60
+    SECS_PER_HOUR = SECS_PER_MIN * MINS_PER_HOUR
+
     # lifted from seattlerb/minitest
     if defined? Process::CLOCK_MONOTONIC
       def self.now
@@ -32,5 +36,61 @@ module CompSci
       }
       return val, self.since(start) / i.to_f
     end
+
+    # YYYY-MM-DD HH::MM::SS.mmm
+    def self.timestamp(t)
+      t.strftime "%Y-%m-%d %H:%M:%S.%L"
+    end
+
+    # HH::MM::SS.mmm.uuuuuuuu
+    def self.elapsed_display(elapsed_ms, show_us: false)
+      elapsed_s, ms = elapsed_ms.divmod 1000
+      ms_only, ms_fraction = ms.round(8).divmod 1
+
+      h = elapsed_s / SECS_PER_HOUR
+      elapsed_s -= h * SECS_PER_HOUR
+      m, s = elapsed_s.divmod SECS_PER_MIN
+
+      hmsms = [[h, m, s].map { |i| i.to_s.rjust(2, '0') }.join(':'),
+               ms_only.to_s.rjust(3, '0')]
+      hmsms << (ms_fraction * 10 ** 8).round.to_s.ljust(8, '0') if show_us
+      hmsms.join('.')
+    end
+
+    def restart(t = Time.now)
+      @start = t
+      self
+    end
+    alias_method :initialize, :restart
+
+    def timestamp(t = Time.now)
+      self.class.timestamp t
+    end
+
+    def timestamp!(t = Time.now)
+      puts '-' * 70, timestamp(t), '-' * 70
+    end
+
+    def elapsed(t = Time.now)
+      t - @start
+    end
+
+    def elapsed_ms(t = Time.now)
+      elapsed(t) * 1000
+    end
+
+    def elapsed_display(t = Time.now)
+      self.class.elapsed_display(elapsed_ms(t))
+    end
+    alias_method :to_s, :elapsed_display
+    alias_method :inspect, :elapsed_display
+
+    def stamp(msg = '', t = Time.now)
+      format("%s %s", elapsed_display(t), msg)
+    end
+
+    def stamp!(msg = '', t = Time.now)
+      puts stamp(msg, t)
+    end
   end
 end

data/test/fit.rb

@@ -15,14 +15,14 @@ describe Fit do
   end
 
   describe "Fit.sigma" do
-    it "must answer correctly" do
+    it "answers correctly" do
       expect(Fit.sigma([1, 2, 3])).must_equal 6
       expect(Fit.sigma([1, 2, 3]) { |n| n ** 2 }).must_equal 14
     end
   end
 
   describe "Fit.error" do
-    it "must calculate r^2" do
+    it "calculates r^2" do
       expect(Fit.error([[1, 1], [2, 2], [3, 3]]) { |x| x }).must_equal 1.0
       expect(Fit.error([[1, 1], [2, 2], [3, 4]]) { |x|
                x
@@ -36,7 +36,7 @@ describe Fit do
   #       alternate measure.  A low slope and r2 for linear fit, maybe.
   #
   describe "Fit.constant" do
-    it "must stuff" do
+    it "returns zero variance with truly constant inputs" do
       [0, 1, 10, 100, 1000, 9999].each { |a|
         y_bar, variance = Fit.constant(@xs, @xs.map { |x| a })
         expect(y_bar).must_equal a
@@ -47,7 +47,7 @@ describe Fit do
 
   # y = a + b*ln(x)
   describe "Fit.logarithmic" do
-    it "must accept logarithmic data" do
+    it "accepts logarithmic data" do
       [-9999, -2000, -500, -0.01, 0.01, 500, 2000, 9999].each { |a|
         [-9999, -2000, -500, -0.01, 0.01, 500, 2000, 9999].each { |b|
           ary = Fit.logarithmic(@xs, @xs.map { |x| a + b * Math.log(x) })
@@ -61,7 +61,7 @@ describe Fit do
 
   # y = a + bx
   describe "Fit.linear" do
-    it "must accept linear data" do
+    it "accepts linear data" do
       [-9999, -2000, -500, -0.01, 0.01, 500, 2000, 9999].each { |a|
         [-9999, -2000, -500, -0.01, 0.01, 500, 2000, 9999].each { |b|
           ary = Fit.linear(@xs, @xs.map { |x| a + b * x })
@@ -72,7 +72,7 @@ describe Fit do
       }
     end
 
-    it "must accept constant data" do
+    it "accepts constant data" do
       [0, 1, 10, 100, 1000, 9999].each { |a|
         ary = Fit.linear(@xs, @xs.map { |x| a })
         expect(ary[0]).must_equal a
@@ -84,7 +84,7 @@ describe Fit do
     # note, this test can possibly fail depending on the uniformity of
     # rand's output for our sample
     #
-    it "must accept noisy constant data" do
+    it "accepts noisy constant data" do
       r2s = []
       [0, 1, 10, 100, 1000, 9999].each { |a|
         ary = Fit.linear(@xs, @xs.map { |x| a + noise() })
@@ -96,16 +96,14 @@ describe Fit do
       expect(mean_r2).must_be_close_to 0.15, 0.15
     end
 
-    it "must reject x^2" do
-      skip "it does not reject x^2 at r^2 < 0.99"
-      xs = [1, 10, 100, 1000]
+    it "rejects x^2" do
+      xs = Array.new(99) { |i| i }
       _a, _b, r2 = Fit.linear(xs, xs.map { |x| x**2 })
       expect(r2).must_be :<, 0.99
     end
 
-    it "must reject x^3" do
-      skip "it does not reject x^3 at r^2 < 0.99"
-      xs = [1, 10, 100, 1000]
+    it "rejects x^3" do
+      xs = Array.new(99) { |i| i }
       _a, _b, r2 = Fit.linear(xs, xs.map { |x| x**3 })
       expect(r2).must_be :<, 0.99
     end
@@ -113,7 +111,7 @@ describe Fit do
 
   # y = ae^(bx)
   describe "Fit.exponential" do
-    it "must accept exponential data" do
+    it "accepts exponential data" do
       [0.001, 7.5, 500, 1000, 5000, 9999].each { |a|
         [-1.4, -1.1, -0.1, 0.01, 0.5, 0.75].each { |b|
           ary = Fit.exponential(@xs, @xs.map { |x| a * Math::E**(b * x) })
@@ -127,10 +125,13 @@ describe Fit do
 
   # y = ax^b
   describe "Fit.power" do
-    it "must accept power data" do
+    it "accepts power data" do
       [0.01, 7.5, 500, 1000, 5000, 9999].each { |a|
         [-114, -100, -10, -0.5, -0.1, 0.1, 0.75, 10, 50, 60].each { |b|
-          next if b == -114 # Fit.error warning: Bignum out of Float range
+        # [    -100, -10, -0.5, -0.1, 0.1, 0.75, 10, 50, 60].each { |b|
+          # note: on Ruby 2.4.x and older, b == -114 throws
+          # warning: Bignum out of Float range
+          # also: TruffleRuby as of Jan '22: ary[2] is NaN rather than 1.0
           ary = Fit.power(@xs, @xs.map { |x| a * x**b })
           expect(ary[0]).must_be_close_to a
           expect(ary[1]).must_be_close_to b
@@ -139,4 +140,41 @@ describe Fit do
       }
     end
   end
+
+  describe "Fit.predict" do
+    before do
+      @a, @b, @x = 1, 2, 3
+    end
+
+    it "accepts a few different models" do
+      [:constant, :logarithmic, :linear, :exponential, :power].each { |model|
+        expect(Fit.predict(model, @a, @b, @x)).must_be_kind_of(Numeric)
+      }
+      expect { Fit.predict(:invalid, @a, @b, @x) }.must_raise RuntimeError
+    end
+
+    it "predicts constant relationships" do
+      expect(Fit.predict(:constant, @a, @b, @x)).must_equal @a
+      expect(Fit.predict(:constant, @a, @x, @b)).must_equal @a
+      expect(Fit.predict(:constant, @x, @a, @b)).must_equal @x
+    end
+
+    it "predicts logarithmic relationships" do
+      expect(Fit.predict(:logarithmic, @a, @b, @x)
+            ).must_equal @a + @b * Math.log(@x)
+    end
+
+    it "predicts linear relationships" do
+      expect(Fit.predict(:linear, @a, @b, @x)).must_equal @a + @b * @x
+    end
+
+    it "predicts exponential relationships" do
+      expect(Fit.predict(:exponential, @a, @b, @x)
+            ).must_equal @a * Math::E ** (@b * @x)
+    end
+
+    it "predicts power relationships" do
+      expect(Fit.predict(:power, @a, @b, @x)).must_equal @a * @x ** @b
+    end
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: compsci
 version: !ruby/object:Gem::Version
-  version: 0.3.1.1
+  version: 0.3.2.3
 platform: ruby
 authors:
 - Rick Hull
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: matrix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: buildar
   requirement: !ruby/object:Gem::Requirement
@@ -28,30 +42,30 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: flog
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 description: Trees, Heaps, Timers, Error fitting, etc
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -172,7 +186,7 @@ homepage: https://github.com/rickhull/compsci
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,15 +194,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.26
+signing_key:
 specification_version: 4
 summary: Toy implementations for some basic computer science problems
 test_files: []