fast_statistics 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f74e28e9d460ef4ebcab5b0efa21ef0bd7aa1bc17ec398292dbc90fb2f759c10
-  data.tar.gz: 1ab07eeea3e7e139b0305b0d4109f780d2d7f372a0c3d8998ffc297a690f8eef
+  metadata.gz: 98882f948017b8d64fdd334bd0ea4e3475a9beb0e1817e766af4779a9f56aafe
+  data.tar.gz: e06600fef9d8026e559928bac3278b606a52a0c0f287320bfc9457d45a4ba7ff
 SHA512:
-  metadata.gz: 7ce73ccecf92df45a42789a45dab9d00ea0642d5b08904e07ecb43eb75148c33f4d645737cf1999fd2b9b7931e80b5efc9f3882756b62820464481ae8a954bfe
-  data.tar.gz: 8e9385b1776b36d9d45c402ccc3015ecc01c4c52a95fae4321f3f6409ebc050921192d2c049cb8b453c49a46defd899d25a84491dbb811f9e10ae3bc2caa2b60
+  metadata.gz: '0449c749047a282bc3aaebfeb1c84a5416cd98a727884f5153f25513b7750ad557b7c51cc51356245c7a28a2ed0d096638b3efd9a6a89801e4ad532386f7e7f7'
+  data.tar.gz: e3c2ceedb95e765e5e88dfb4ceddc36065f6040e2a066c03f480d75867f7c5763f559e73c26525ce493270cbdf3865cfe9f5e7a83076e85e752e21cb2fb12aad

data/README.md

@@ -1,4 +1,4 @@
-# FastStatistics
+# Fast Statistics :rocket:
 ![Build Status](https://travis-ci.com/Martin-Nyaga/fast_statistics.svg?branch=master)
 
 A high performance native ruby extension (written in C++) for computation of
@@ -9,6 +9,10 @@ This gem provides fast computation of descriptive statistics (min, max, mean,
 median, 1st and 3rd quartiles, population standard deviation) for a multivariate
 dataset (represented as a 2D array) in ruby.
 
+It is **~11x** faster than an optimal algorithm in hand-written ruby, and
+**~4.7x** faster than the next fastest available ruby gem or native extension
+(see [benchmarks](#benchmarks) below).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -81,10 +85,6 @@ Some alternatives compared are:
 - [Numo::NArray](https://github.com/ruby-numo/numo-narray)
 - Hand-written ruby (using the same algorithm implemented in C++ in this gem)
 
-Benchmarked on my machine (8th gen i7, sse2), this gem is **~11x**
-faster than an optimal algorithm in hand-written ruby, and **~4.7x** faster than
-the next fastest available native ruby extension (that I tested).
-
 You can reivew the benchmark implementations at `benchmark/benchmark.rb` and run the
 benchmark with `rake benchmark`. 
 
@@ -124,6 +124,15 @@ first explored performing the computations natively in [this
 repository](https://github.com/Martin-Nyaga/ruby-ffi-simd). The results were
 promising, so I decided to package it as a ruby gem.
 
+**Note**: This is an early release and should be considered unstable, at least
+until I'm confident in the stability & performance in a real world application
+setting.  Feel free to test it out in non-critical scenarios/environments (let
+me know in [this discussion
+thread](https://github.com/Martin-Nyaga/fast_statistics/discussions/1) or by
+filing an issue if you use it!). I'm also not really an expert in C++, so
+reviews & suggestions are welcome.
+
+### How is the performance achieved? 
 The following factors combined help this gem achieve high performance compared
 to available native alternatives and hand-written computations in ruby:
 
@@ -139,20 +148,14 @@ to available native alternatives and hand-written computations in ruby:
   where possible, giving an additional speed advantage while still being single
   threaded.
 
-That said, there are some limitations in the current implementation:
+### Limitations of the current implementation
+The speed gains notwithstanding, there are some limitations in the current implementation:
 - The variables in the 2D array must all have the same number of data points
   (inner arrays must have the same length) and contain only numbers (i.e. no
   `nil` awareness is present).
 - There is currently no API to calculate single statistics (although this may be
   made available in the future).
 
-This is an early release and should be considered unstable, at least until I'm
-confident in the stability & performance in a real world application setting
-(let me know in [the Welcome discussion
-thread](https://github.com/Martin-Nyaga/fast_statistics/discussions/1) if you
-use it!). I'm also not really an expert in C++, so reviews & suggestions are
-welcome.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at

data/Rakefile

@@ -22,15 +22,3 @@ task :benchmark => [:clean, :compile] do
   bench.compare_results!
   bench.benchmark_ips!
 end
-
-task :profile => [:clean, :compile] do
-  require "fast_statistics"
-  $stdout.sync = true
-
-  variables = 12
-  length = 100_000
-  data = (0..(variables - 1)).map { (0..(length - 1)).map { rand } }
-  FastStatistics::Array2D.new(data, dtype: :float).mean.to_a
-  puts
-  puts
-end

data/ext/fast_statistics/extconf.rb

@@ -8,6 +8,9 @@ if ENV["DEBUG"]
   $defs << "-DDEBUG"
 end
 
+# Compile with C++11
+$CXXFLAGS += " -std=c++11 "
+
 # Disable warnings
 [
   / -Wdeclaration-after-statement/,

data/lib/fast_statistics/version.rb

@@ -1,3 +1,3 @@
 module FastStatistics
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_statistics
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Martin Nyaga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies: []
 description: Fast computation of descriptive statistics in ruby using native code
   and SIMD