phonetics 1.9.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c81fa9abec7c3cdd12bf84e2cd01a7dba6c8f5b66068c0dde27b23f7d3c137f6
-  data.tar.gz: 3d337a57a1eccadeb84a58ddd2e7cb0f9ea43b6ae505189376d4b97d457f5f71
+  metadata.gz: 32e8dd70cfccdfd6826023da278e2d04c75fc6e7658b5bc64af44830a0ae5668
+  data.tar.gz: 7dfd507a3fcb7914ee9eaba8049bc286068265399ee580a8c2ffb8ae8ecbd061
 SHA512:
-  metadata.gz: 657e10eb57cef58a84080445215362b4cf3906aa7ac556535ff869d621ba8f76707a03a5430bfa31909874f0fb937ee10b64cb9218544eeba3824ba17069fb3d
-  data.tar.gz: f3cbf639f3b915f4fd5832dc66a9b0c0254058ad1d4b12a6ac86b15e35cc41c9bfdd6162526a3c3c7f7bd26a6c9e4b270eceb4a918fd866c17b6c2828c07acce
+  metadata.gz: 10c9e15ec47748cf1c508538950fb090477e6762a584466bd9abcc7ffd81fff2497041adf77d190ba6adcb7ef73774502941faeff0edfcf048f7ac650336ab0a
+  data.tar.gz: 7cb06657f02ff1bad1547eb948b412876855d6e0967f927d44512e7d9b84b66e1d8c9ffb79f81e5001442d36bcbc37d8282aa80b3c1bbebecf25f2f0f3fb0849

data/.github/workflows/gempush.yml

@@ -1,16 +1,13 @@
 name: Ruby Gem
 
 on:
-  pull_request:
-    branches:
-      - master
   push:
     branches:
       - master
 
 jobs:
   build:
-    name: Build + Publish
+    name: gem publishing
     runs-on: ubuntu-latest
 
     steps:
@@ -18,7 +15,7 @@ jobs:
     - name: Set up Ruby 2.6
       uses: actions/setup-ruby@v1
       with:
-        version: 2.6.x
+        ruby-version: 2.6.x
 
     - name: Publish to RubyGems
       run: |
@@ -26,7 +23,6 @@ jobs:
         touch $HOME/.gem/credentials
         chmod 0600 $HOME/.gem/credentials
         printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
+        bin/gempush-if-changed
       env:
         GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Tests
+
+on: push
+
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.3.x'
+          - '2.4.x'
+          - '2.5.x'
+          - '2.6.x'
+    steps:
+      - uses: actions/checkout@master
+      - name: Setup ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - run: gem install bundler && bundle && bundle exec rake 

data/Gemfile

@@ -2,7 +2,5 @@
 
 source 'https://rubygems.org'
 
-# gem 'ruby-prof-flamegraph', path: '/www/ruby-prof-flamegraph'
-
 # Specify your gem's dependencies in phonetics.gemspec
 gemspec

data/VERSION

@@ -1 +1 @@
-1.9.0
+2.0.1

data/bin/gempush-if-changed

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -x
+if git diff --name-only HEAD..HEAD^ | egrep -q '^VERSION$'; then
+  # The VERSION file changed in the last commit, build the gem and push
+  gem build *.gemspec
+  gem push *.gem
+fi

data/ext/c_levenshtein/levenshtein.c

@@ -7,7 +7,13 @@
 #include "./next_phoneme_length.h"
 #include "./phonetic_cost.h"
 
+// #define DEBUG
+
+#ifdef DEBUG
 #define debug(M, ...) if (verbose) printf(M, ##__VA_ARGS__)
+#else
+#define debug(M, ...)
+#endif
 
 VALUE Binding = Qnil;
 
@@ -15,8 +21,8 @@ VALUE Binding = Qnil;
 
 void Init_c_levenshtein();
 
-void set_initial(double *d, int string1_phoneme_count, int64_t *string1_phonemes, int string2_phoneme_count, int64_t *string2_phonemes, bool verbose);
-void print_matrix(double *d, int *string1, int string1_phoneme_count, int *string1_phoneme_sizes, int *string2, int string2_phoneme_count, int *string2_phoneme_sizes, bool verbose);
+void set_initial(float *d, int string1_phoneme_count, uint64_t *string1_phonemes, int string2_phoneme_count, uint64_t *string2_phonemes, bool verbose);
+void print_matrix(float *d, int *string1, int string1_phoneme_count, int *string1_phoneme_sizes, int *string2, int string2_phoneme_count, int *string2_phoneme_sizes, bool verbose);
 VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _string2, VALUE _verbose);
 
 /* Function implemitations */
@@ -41,11 +47,11 @@ VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _strin
   int string1[string1_length + 1];
   int string2[string2_length + 1];
 
-  double *d;              // The (flattened) 2-dimensional matrix
+  float *d;              // The (flattened) 2-dimensional matrix
                           // underlying this algorithm
 
-  double distance;        // Return value of this function
-  double min, delete,     // Reusable cost calculations
+  float distance;        // Return value of this function
+  float min, delete,     // Reusable cost calculations
          insert, replace,
          cost;
   int i, j;               // Frequently overwritten loop vars
@@ -64,34 +70,22 @@ VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _strin
   }
 
   find_phonemes(string1, string1_length, &string1_phoneme_count, string1_phoneme_sizes);
-  int64_t string1_phonemes[string1_phoneme_count];
+  uint64_t string1_phonemes[string1_phoneme_count];
+  set_phonemes(string1_phonemes, string1, string1_phoneme_count, string1_phoneme_sizes);
 
   find_phonemes(string2, string2_length, &string2_phoneme_count, string2_phoneme_sizes);
-  int64_t string2_phonemes[string2_phoneme_count];
+  uint64_t string2_phonemes[string2_phoneme_count];
+  set_phonemes(string2_phonemes, string2, string2_phoneme_count, string2_phoneme_sizes);
 
   // Guard clauses for empty strings
   if (string1_phoneme_count == 0 && string2_phoneme_count == 0)
     return DBL2NUM(0.0);
   
-  // Collect between 1 and 8 bytes of a phoneme into a single 64-bit word so we can compare two
-  // phonemes using just one instruction.
-  // These 64-bit words are how we implement the lookup table in phonetic_cost
-  int idx = 0;
-  for (i = 0; i < string1_phoneme_count; i++) {
-    for (j = 0; j < string1_phoneme_sizes[j]; j++) {
-      string1_phonemes[i] = (int) ( string1_phonemes[i] << 8 | string1[idx] );
-      idx++;
-    }
-  }
-  for (i = 0; i < string2_phoneme_count; i++) {
-    for (j = 0; j < string2_phoneme_sizes[j]; j++) {
-      string2_phonemes[i] = (int) ( string2_phonemes[i] << 8 | string2[idx] );
-      idx++;
-    }
-  }
+  debug("\n");
+  debug("distance between 0 and 1 of phoneme1: %f\n", phonetic_cost(string1_phonemes[0], string1_phonemes[1]));
 
   // one-dimensional representation of 2 dimensional array
-  d = calloc((string1_phoneme_count+1) * (string2_phoneme_count+1), sizeof(double));
+  d = calloc((string1_phoneme_count+1) * (string2_phoneme_count+1), sizeof(float));
 
   // First, set the top row and left column of the matrix using the sequential
   // phonetic edit distance of string1 and string2, respectively
@@ -115,34 +109,34 @@ VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _strin
       // plus the phonetic distance between the sound we're moving from to the
       // new one.
 
-      // debug("------- %d/%d (%d) \n", i, j, j*(string1_phoneme_count+1) + i);
+      debug("------- %d/%d (%d) \n", i, j, j*(string1_phoneme_count+1) + i);
 
       cost = phonetic_cost(string1_phonemes[i-1], string2_phonemes[j-1]);
 
       insert = d[j*(string1_phoneme_count+1) + i-1];
-      // debug("insert proposes cell %d,%d - %f\n", i-1, j, insert);
+      debug("insert proposes cell %d,%d - %f\n", i-1, j, insert);
       min = insert;
-      // debug("min (insert): %f\n", min);
+      debug("min (insert): %f\n", min);
 
       delete = d[(j-1)*(string1_phoneme_count+1) + i];
-      // debug("delete proposes cell %d,%d - %f\n", i, j-1, delete);
+      debug("delete proposes cell %d,%d - %f\n", i, j-1, delete);
       if (delete < min) {
-        // debug("delete is %f, better than %f for %d/%d\n", delete, min, i, j);
+        debug("delete is %f, better than %f for %d/%d\n", delete, min, i, j);
         min = delete;
       }
 
       replace = d[(j-1)*(string1_phoneme_count+1) + i-1];
-      // debug("replace proposes cell %d,%d - %f\n", i-1, j-1, replace);
+      debug("replace proposes cell %d,%d - %f\n", i-1, j-1, replace);
       if (replace < min) {
-        // debug("replace is %f, better than %f for %d/%d\n", replace, min, i, j);
+        debug("replace is %f, better than %f for %d/%d\n", replace, min, i, j);
         min = replace;
       }
 
       d[(j * (string1_phoneme_count+1)) + i] = min + cost;
-      // debug("\n");
-      // if (verbose) {
-        // print_matrix(d, string1, string1_phoneme_count, string1_phoneme_sizes, string2, string2_phoneme_count, string2_phoneme_sizes, verbose);
-      // }
+      debug("\n");
+      if (verbose) {
+        print_matrix(d, string1, string1_phoneme_count, string1_phoneme_sizes, string2, string2_phoneme_count, string2_phoneme_sizes, verbose);
+      }
 
     }
   }
@@ -166,9 +160,9 @@ VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _strin
 // Subsequent values are the cumulative phonetic distance between each
 // phoneme within the same string.
 // "aek" -> [0.0, 1.0, 1.61, 2.61]
-void set_initial(double *d, int string1_phoneme_count, int64_t *string1_phonemes, int string2_phoneme_count, int64_t *string2_phonemes, bool verbose) {
+void set_initial(float *d, int string1_phoneme_count, uint64_t *string1_phonemes, int string2_phoneme_count, uint64_t *string2_phonemes, bool verbose) {
 
-  double initial_distance;
+  float initial_distance;
   int i, j;
 
   if (string1_phoneme_count == 0 || string2_phoneme_count == 0) {
@@ -178,7 +172,7 @@ void set_initial(double *d, int string1_phoneme_count, int64_t *string1_phonemes
   }
 
   // The top-left is 0, the cell to the right and down are each 1 to start
-  d[0] = (double) 0.0;
+  d[0] = (float) 0.0;
   if (string1_phoneme_count > 0) {
     d[1] = initial_distance;
   }
@@ -186,16 +180,12 @@ void set_initial(double *d, int string1_phoneme_count, int64_t *string1_phonemes
     d[string1_phoneme_count+1] = initial_distance;
   }
 
-  debug("string1 phoneme count: %d\n", string1_phoneme_count);
-
   for (i=2; i <= string1_phoneme_count; i++) {
     // The cost of adding the next phoneme is the cost so far plus the phonetic
     // distance between the previous one and the current one.
     d[i] = d[i-1] + phonetic_cost(string1_phonemes[i-2], string1_phonemes[i-1]);
   }
 
-  debug("string2 phoneme count: %d\n", string2_phoneme_count);
-
   for (j=2; j <= string2_phoneme_count; j++) {
     // The same exact pattern down the left side of the matrix
     d[j * (string1_phoneme_count+1)] = d[(j - 1) * (string1_phoneme_count+1)] + phonetic_cost(string2_phonemes[j-2], string2_phonemes[j-1]);
@@ -203,13 +193,12 @@ void set_initial(double *d, int string1_phoneme_count, int64_t *string1_phonemes
 }
 
 // A handy visualization for developers
-void print_matrix(double *d, int *string1, int string1_phoneme_count, int *string1_phoneme_sizes, int *string2, int string2_phoneme_count, int *string2_phoneme_sizes, bool verbose) {
+void print_matrix(float *d, int *string1, int string1_phoneme_count, int *string1_phoneme_sizes, int *string2, int string2_phoneme_count, int *string2_phoneme_sizes, bool verbose) {
 
   int i, j;
   int string1_offset = 0;
   int string2_offset = 0;
 
-  return;
   if (!verbose)
     return;
 

data/ext/c_levenshtein/next_phoneme_length.c

@@ -1,4 +1,5 @@
-// This is compiled from Ruby, in phonetics/lib/phonetics/code_generator.rb:158
+// This is compiled from Ruby, in phonetics/lib/phonetics/code_generator.rb:163
+#include <stdio.h>
 int next_phoneme_length(int *string, int cursor, int length) {
 
   int max_length;

data/ext/c_levenshtein/phonemes.c

@@ -1,8 +1,13 @@
 #include <stdio.h>
+#include <stdlib.h>
+#include <stdint.h>
 #include "./next_phoneme_length.h"
+
 void find_phonemes(int *string, int string_length, int *count, int *lengths) {
-  int i = 0;
   int length;
+  int i;
+
+  i = 0;
   while (i < string_length) {
     length = next_phoneme_length(string, i, string_length);
     if (length) {
@@ -14,6 +19,21 @@ void find_phonemes(int *string, int string_length, int *count, int *lengths) {
   }
 }
 
+// Collect between 1 and 8 bytes of a phoneme into a single 64-bit word so we can compare two
+// phonemes using just one instruction.
+// These 64-bit words are how we implement the lookup table in phonetic_cost
+void set_phonemes(uint64_t* phonemes, int* string, int count, int* lengths) {
+  int idx = 0;
+  int i, j;
+  for (i = 0; i < count; i++) {
+    phonemes[i] = 0;
+    for (j = 0; j < lengths[i]; j++) {
+      phonemes[i] = (uint64_t) ( phonemes[i] << 8 | string[idx] );
+      idx++;
+    }
+  }
+}
+
 void print_phoneme(int *string, int offset, int length, int padding) {
   int p;
   int max = padding;

data/ext/c_levenshtein/phonemes.h

@@ -1,2 +1,3 @@
 void find_phonemes(int *string, int string_length, int *count, int *lengths);
 void print_phoneme(int *string, int offset, int length, int padding);
+void set_phonemes(uint64_t* phonemes, int* string, int count, int* lengths);

data/ext/c_levenshtein/phonetic_cost.c

@@ -1,7 +1,12 @@
 
 // This is compiled from Ruby, in phonetics/lib/phonetics/code_generator.rb:110
 #include <stdint.h>
+#include <stdio.h>
+#include <inttypes.h>
 float phonetic_cost(int64_t phoneme1, int64_t phoneme2) {
+  if (phoneme1 == phoneme2) {
+    return (float) 0.0;
+  }
 
   switch (phoneme1) {
     case 0b01101001:

data/lib/phonetics/code_generator.rb

@@ -95,7 +95,7 @@ module Phonetics
     #    switch (phoneme1) {
     #      case 'ɪ': // two bytes: [201, 170]
     #                // vowel features: {"F1":300,"F2":2100,"rounded":false}
-    #         
+    #
     #         switch(phoneme2) {
     #            'i': // one byte: [105]
     #                 // vowel features: {"F1":240,"F2":2400,"rounded":false}
@@ -109,7 +109,12 @@ module Phonetics
 
       // This is compiled from Ruby, in #{ruby_source}
       #include <stdint.h>
+      #include <stdio.h>
+      #include <inttypes.h>
       float phonetic_cost(int64_t phoneme1, int64_t phoneme2) {
+        if (phoneme1 == phoneme2) {
+          return (float) 0.0;
+        }
 
       HEADER
 
@@ -117,14 +122,14 @@ module Phonetics
       Phonetics.phonemes.each do |phoneme1|
         write "    case #{binary(phoneme1)}:"
         describe(phoneme1, 2)
-        write "      switch(phoneme2) {"
+        write '      switch(phoneme2) {'
         Phonetics.distance_map[phoneme1].each do |phoneme2, distance|
           write "        case #{binary(phoneme2)}:"
           describe(phoneme2, 6)
           write "          return (float) #{distance};"
           write '          break;'
         end
-        write "      }"
+        write '      }'
         write '      break;'
       end
       write '  }'
@@ -156,6 +161,7 @@ module Phonetics
     def generate
       write(<<-HEADER.gsub(/^ {6}/, ''))
       // This is compiled from Ruby, in #{ruby_source}
+      #include <stdio.h>
       int next_phoneme_length(int *string, int cursor, int length) {
 
         int max_length;

data/phonetics.gemspec

@@ -26,5 +26,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake-compiler'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'ruby-prof'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phonetics
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Jack Danger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-30 00:00:00.000000000 Z
+date: 2019-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-prof
-  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: tools for linguistic code using the International Phonetic Alphabet
 email:
 - github@jackcanty.com
@@ -117,6 +103,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".github/workflows/gempush.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -133,6 +120,7 @@ files:
 - _site/phonetic_levenshtein_example.png
 - _site/vowel_chart_b_words.jpg
 - bin/console
+- bin/gempush-if-changed
 - ext/c_levenshtein/extconf.rb
 - ext/c_levenshtein/levenshtein.c
 - ext/c_levenshtein/next_phoneme_length.c