fast_blank_ocaml 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29cf7f388a3afa1193ab25134c944804f479f1e8
+  data.tar.gz: 95cf3a37f89100e15619ae870cab6aa5ad796ec2
+SHA512:
+  metadata.gz: a3e39f2097057b1c2dfa40c9895dd090c12875c9fe793813b8e2426ee7d2591252e1dcd7830e91f35f4b45cffab0b1ef3691e3a253eb01334ac2b9923480d9f0
+  data.tar.gz: 8694b96a5586521faad477dea7b617cccdcaa1551c65765cfbead4a7047b27d51d9bede5e0990bef439b2137b6ed346e74990c725a67dc5aaabffec8d2808028

data/.gitignore

@@ -0,0 +1 @@
+/*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    fast_blank_ocaml (0.0.0)
+      ffi
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    benchmark-ips (2.7.2)
+    fast_blank (1.0.0)
+    ffi (1.9.17)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  bundler (~> 1.15)
+  fast_blank
+  fast_blank_ocaml!
+
+BUNDLED WITH
+   1.15.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Alexander Komarov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,24 @@
+# fast_blank_ocaml
+
+*DISCLAIMER*: I am not an expert in OCaml, C, Ruby and native extensions.
+This is just something I wanted to try out, and since I didn't find a lot of
+info by googling, I decided to put this on GitHub and maybe someone will find
+this useful.
+
+### Description
+
+This is an example of how to write a Ruby native extension in OCaml.
+The code for `blank?` itself is in `ocaml/blank.ml`.
+
+There's also a C wrapper in `ocaml/blank.c` which is required to make a
+connection via FFI.
+
+### Benchmark
+
+To view the benchmark results (with comparison to
+[fast_blank](https://github.com/SamSaffron/fast_blank)), see `benchmark.rb`.
+Or, run it for yourself via `ruby benchmark.rb`.
+
+### Contributing
+
+Despite the gem's "it's just a test" status, issues and PRs are very welcome.

data/benchmark.rb

@@ -0,0 +1,193 @@
+require 'benchmark/ips'
+require 'fast_blank'
+require_relative 'lib/cowcaml.rb'
+
+class String
+  def ocaml_blank?
+    Cowcaml::Base.blank self
+  end
+
+  # active support implementation
+  def slow_blank?
+    /\A[[:space:]]*\z/ === self
+  end
+
+  def new_slow_blank?
+    empty? || !(/[[:^space:]]/ === self)
+  end
+end
+
+test_strings = [
+  "",
+  "\r\n\r\n  ",
+  "this is a test",
+  "   this is a longer test",
+  "   this is a longer test
+      this is a longer test
+      this is a longer test
+      this is a longer test
+      this is a longer test"
+]
+
+test_strings.each do |s|
+  raise "failed on #{s.inspect}" if s.ocaml_blank? != s.slow_blank?
+  raise "failed on #{s.inspect}" if s.ocaml_blank? != s.new_slow_blank?
+end
+
+test_strings.each do |s|
+  puts "\n================== Test String Length: #{s.length} =================="
+  Benchmark.ips do |x|
+    x.report("Fast Blank") do |times|
+      i = 0
+      while i < times
+        s.blank?
+        i += 1
+      end
+    end
+
+    x.report("Fast ActiveSupport") do |times|
+      i = 0
+      while i < times
+        s.blank_as?
+        i += 1
+      end
+    end
+
+    x.report("Slow Blank") do |times|
+      i = 0
+      while i < times
+        s.slow_blank?
+        i += 1
+      end
+    end
+
+    x.report("New Slow Blank") do |times|
+      i = 0
+      while i < times
+        s.new_slow_blank?
+        i += 1
+      end
+    end
+
+    x.report("OCaml Fast Blank") do |times|
+      i = 0
+      while i < times
+        s.ocaml_blank?
+        i += 1
+      end
+    end
+
+    x.compare!
+  end
+end
+
+__END__
+
+================== Test String Length: 0 ==================
+Warming up --------------------------------------
+          Fast Blank   259.226k i/100ms
+  Fast ActiveSupport   226.507k i/100ms
+          Slow Blank    67.603k i/100ms
+      New Slow Blank   259.002k i/100ms
+    OCaml Fast Blank   186.906k i/100ms
+Calculating -------------------------------------
+          Fast Blank     20.637M (±15.6%) i/s -     99.284M in   5.013785s
+  Fast ActiveSupport     21.001M (±14.2%) i/s -    101.702M in   5.007715s
+          Slow Blank    802.420k (±20.7%) i/s -      3.718M in   5.001746s
+      New Slow Blank     18.710M (±23.3%) i/s -     84.694M in   4.998752s
+    OCaml Fast Blank      4.950M (±15.4%) i/s -     23.924M in   5.025812s
+
+Comparison:
+  Fast ActiveSupport: 21001105.8 i/s
+          Fast Blank: 20637083.6 i/s - same-ish: difference falls within error
+      New Slow Blank: 18710072.3 i/s - same-ish: difference falls within error
+    OCaml Fast Blank:  4949668.0 i/s - 4.24x  slower
+          Slow Blank:   802419.7 i/s - 26.17x  slower
+
+
+================== Test String Length: 6 ==================
+Warming up --------------------------------------
+          Fast Blank   187.458k i/100ms
+  Fast ActiveSupport   171.902k i/100ms
+          Slow Blank    61.453k i/100ms
+      New Slow Blank   102.474k i/100ms
+    OCaml Fast Blank   163.372k i/100ms
+Calculating -------------------------------------
+          Fast Blank      9.151M (± 9.8%) i/s -     45.177M in   5.004625s
+  Fast ActiveSupport     10.112M (± 6.9%) i/s -     50.367M in   5.010209s
+          Slow Blank    922.222k (± 4.0%) i/s -      4.609M in   5.005885s
+      New Slow Blank      1.741M (± 6.3%) i/s -      8.710M in   5.026138s
+    OCaml Fast Blank      4.555M (±10.2%) i/s -     22.382M in   5.005977s
+
+Comparison:
+  Fast ActiveSupport: 10112422.2 i/s
+          Fast Blank:  9150969.7 i/s - same-ish: difference falls within error
+    OCaml Fast Blank:  4554510.1 i/s - 2.22x  slower
+      New Slow Blank:  1741425.3 i/s - 5.81x  slower
+          Slow Blank:   922222.1 i/s - 10.97x  slower
+
+
+================== Test String Length: 14 ==================
+Warming up --------------------------------------
+          Fast Blank   249.490k i/100ms
+  Fast ActiveSupport   248.312k i/100ms
+          Slow Blank   125.931k i/100ms
+      New Slow Blank    69.459k i/100ms
+    OCaml Fast Blank   182.275k i/100ms
+Calculating -------------------------------------
+          Fast Blank     18.106M (± 6.8%) i/s -     90.315M in   5.015731s
+  Fast ActiveSupport     16.674M (±19.7%) i/s -     77.225M in   5.006326s
+          Slow Blank      2.104M (±15.7%) i/s -     10.200M in   5.041044s
+      New Slow Blank    876.423k (±13.0%) i/s -      4.306M in   5.013083s
+    OCaml Fast Blank      5.026M (±12.4%) i/s -     24.607M in   5.011347s
+
+Comparison:
+          Fast Blank: 18106150.8 i/s
+  Fast ActiveSupport: 16673555.8 i/s - same-ish: difference falls within error
+    OCaml Fast Blank:  5026177.7 i/s - 3.60x  slower
+          Slow Blank:  2103665.1 i/s - 8.61x  slower
+      New Slow Blank:   876422.6 i/s - 20.66x  slower
+
+
+================== Test String Length: 24 ==================
+Warming up --------------------------------------
+          Fast Blank   221.182k i/100ms
+  Fast ActiveSupport   222.870k i/100ms
+          Slow Blank   111.589k i/100ms
+      New Slow Blank    66.756k i/100ms
+    OCaml Fast Blank   171.531k i/100ms
+Calculating -------------------------------------
+          Fast Blank     11.786M (± 5.3%) i/s -     58.834M in   5.007267s
+  Fast ActiveSupport     11.704M (±14.7%) i/s -     56.386M in   5.011782s
+          Slow Blank      1.984M (±10.0%) i/s -      9.820M in   5.049188s
+      New Slow Blank    874.532k (± 8.3%) i/s -      4.339M in   5.001362s
+    OCaml Fast Blank      4.967M (± 4.8%) i/s -     24.872M in   5.019823s
+
+Comparison:
+          Fast Blank: 11785709.1 i/s
+  Fast ActiveSupport: 11704475.2 i/s - same-ish: difference falls within error
+    OCaml Fast Blank:  4966928.5 i/s - 2.37x  slower
+          Slow Blank:  1983904.0 i/s - 5.94x  slower
+      New Slow Blank:   874532.3 i/s - 13.48x  slower
+
+
+================== Test String Length: 136 ==================
+Warming up --------------------------------------
+          Fast Blank   210.768k i/100ms
+  Fast ActiveSupport   193.088k i/100ms
+          Slow Blank    77.595k i/100ms
+      New Slow Blank    44.558k i/100ms
+    OCaml Fast Blank   143.046k i/100ms
+Calculating -------------------------------------
+          Fast Blank     10.256M (±20.4%) i/s -     47.844M in   5.002855s
+  Fast ActiveSupport     12.072M (±10.6%) i/s -     59.471M in   5.009553s
+          Slow Blank      1.851M (±18.1%) i/s -      8.613M in   5.087665s
+      New Slow Blank    849.400k (±14.3%) i/s -      4.144M in   5.036486s
+    OCaml Fast Blank      3.387M (±13.7%) i/s -     16.593M in   5.024423s
+
+Comparison:
+  Fast ActiveSupport: 12071703.8 i/s
+          Fast Blank: 10255565.3 i/s - same-ish: difference falls within error
+    OCaml Fast Blank:  3387110.1 i/s - 3.56x  slower
+          Slow Blank:  1850712.1 i/s - 6.52x  slower
+      New Slow Blank:   849400.0 i/s - 14.21x  slower

data/ext/ocaml-blank/.gitignore

@@ -0,0 +1,4 @@
+blank.cmi
+blank.cmx
+blank.o
+blankcaml.o

data/ext/ocaml-blank/Makefile

@@ -0,0 +1,4 @@
+libblank-so:
+	ocamlopt -output-obj -o blankcaml.o blank.ml
+	ocamlc -c blank.c
+	cc -o libblank.so blank.o blankcaml.o -L`ocamlc -where` -lunix -lasmrun

data/ext/ocaml-blank/Rakefile

@@ -0,0 +1,14 @@
+require 'rake/clean'
+require 'rubygems'
+
+CLOBBER.include('libblank.so')
+
+task :default => [:build]
+
+desc 'Build the shared library'
+task :build => %w[libblank.so]
+
+file 'libblank.so' => %w[blank.ml blank.c] do
+  sh 'make'
+  sh 'mv libblank.so ../../lib'
+end

data/ext/ocaml-blank/blank.c

@@ -0,0 +1,20 @@
+#include <stdbool.h>
+#include <string.h>
+#include <caml/alloc.h>
+#include <caml/mlvalues.h>
+#include <caml/memory.h>
+#include <caml/callback.h>
+
+void startup (char** argv) {
+  caml_startup(argv);
+}
+
+bool blank (const char* string) {
+  CAMLparam0();
+  CAMLlocal1(ostring);
+  static value* closure = NULL;
+  if (closure == NULL)
+    closure = caml_named_value("blank");
+  ostring = caml_copy_string(string); // this is probably slowing things down
+  CAMLreturn(Bool_val(caml_callback(*closure, ostring)));
+}

data/ext/ocaml-blank/blank.ml

@@ -0,0 +1,47 @@
+(* char codes taken from https://github.com/SamSaffron/fast_blank *)
+let char_blank char =
+  match int_of_char char with
+  | 0x9 -> true (* tab *)
+  | 0xA -> true (* line feed *)
+  | 0xB -> true (* vertical tab *)
+  | 0xC -> true (* form feed *)
+  | 0xD -> true (* carriage return *)
+  | 0x20 -> true (* space *)
+  | 0x85 -> true
+  | 0xA0 -> true (* nbsp *)
+  | 0x1680 -> true
+  | 0x2000 -> true
+  | 0x2001 -> true
+  | 0x2002 -> true
+  | 0x2003 -> true
+  | 0x2004 -> true
+  | 0x2005 -> true
+  | 0x2006 -> true
+  | 0x2007 -> true
+  | 0x2008 -> true
+  | 0x2009 -> true
+  | 0x200a -> true
+  | 0x2028 -> true
+  | 0x2029 -> true
+  | 0x202f -> true
+  | 0x205f -> true
+  | 0x3000 -> true
+  | _ -> false
+
+let blank_by_char string length =
+  let index = ref 0 in
+  let result = ref true in
+  while !index < length && !result do
+    if not (char_blank string.[!index]) then
+      result := false;
+    index := !index + 1
+  done;
+  !result
+
+let blank string =
+  match String.length string with
+  | 0 -> true
+  | len -> blank_by_char string len
+
+(* register callback for C *)
+let _ = Callback.register "blank" blank

data/fast_blank_ocaml.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fast_blank_ocaml'
+  spec.version       = '0.0.0'
+  spec.authors       = ['Alexander Komarov']
+  spec.email         = ['ak@akxcv.com']
+
+  spec.summary       = 'String#blank? in OCaml'
+  spec.description   = 'A simple example of how to write a Ruby native extension in OCaml'
+  spec.homepage      = 'https://github.com/akxcv/fast_blank_ocaml'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.extensions = ['ext/ocaml-blank/Rakefile']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'fast_blank'
+
+  spec.add_dependency 'ffi'
+end

data/lib/.gitignore

@@ -0,0 +1 @@
+libblank.so

data/lib/cowcaml.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+module Cowcaml
+  module Base
+    extend FFI::Library
+    ffi_lib File.expand_path('../libblank.so', __FILE__)
+    attach_function :blank, [:string], :bool
+    attach_function :startup, [:string], :void
+  end
+  Base.startup ''
+end

data/lib/fast_blank_ocaml.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'cowcaml.rb'
+
+class String
+  def blank?
+    Cowcaml::Base.blank self
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: fast_blank_ocaml
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Alexander Komarov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  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'
+- !ruby/object:Gem::Dependency
+  name: fast_blank
+  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'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple example of how to write a Ruby native extension in OCaml
+email:
+- ak@akxcv.com
+executables: []
+extensions:
+- ext/ocaml-blank/Rakefile
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- benchmark.rb
+- ext/ocaml-blank/.gitignore
+- ext/ocaml-blank/Makefile
+- ext/ocaml-blank/Rakefile
+- ext/ocaml-blank/blank.c
+- ext/ocaml-blank/blank.ml
+- fast_blank_ocaml.gemspec
+- lib/.gitignore
+- lib/cowcaml.rb
+- lib/fast_blank_ocaml.rb
+homepage: https://github.com/akxcv/fast_blank_ocaml
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: String#blank? in OCaml
+test_files: []