ruby_native_statistics 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a01f2968f24b3e0c105a78755534c3e3ae2ff956
+  data.tar.gz: 0c4d49a30ef69306dbe2e7509d4d8b33fd9a0e21
+SHA512:
+  metadata.gz: 0a3c5b5fc5a81ec0d70d869bef3c9b25d8bf57c6270bc93e8af11748f5f003eddc73cb2b1cd84097427578afb4c13fca1772c077005682e4e5b23b9c0f8bd08a
+  data.tar.gz: b6353a7646c37a0a7db2294fbd146f595de88cad078da381e3c17a6fbbc4371ff1145f96ce3bc88335fb9968cc55356d438e6091607da79b93facc338599e41b

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+*.bundle

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    ruby_native_statistics (0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.8.4)
+    rake (11.1.2)
+    rake-compiler (0.9.9)
+      rake
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  minitest (~> 5.0)
+  rake (~> 11.0)
+  rake-compiler (~> 0.9)
+  ruby_native_statistics!
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org>

data/README.md

@@ -0,0 +1,35 @@
+# Ruby Native Statistics
+
+[![Build Status](https://travis-ci.org/corybuecker/ruby-native-statistics.svg)](https://travis-ci.org/corybuecker/ruby-native-statistics)
+
+This is a native extension to Ruby that adds native (C) statistical functions to the Array class. At present the following functions are provided:
+
+* [Sample Standard Deviation](https://en.wikipedia.org/wiki/Standard_deviation#Corrected_sample_standard_deviation) (stdev, stdevs)
+* [Population Standard Deviation](https://en.wikipedia.org/wiki/Standard_deviation#Uncorrected_sample_standard_deviation) (stdevp)
+
+Check the TravisCI build to see the currently supported versions of Ruby. This list will match whatever versions are specified at https://www.ruby-lang.org/en/downloads/.
+
+It is much more performant than calculating the standard deviation with pure Ruby. For a comparison, run the benchmarks with rake.
+
+    bench_native_extension   0.000573	 0.000507	 0.000616	 0.000606	 0.000528
+    bench_pure_ruby          0.004794	 0.004045	 0.002673	 0.002667	 0.003728
+
+## Usage
+
+    require 'ruby_native_statistics'
+    r = [1,3,21,32,42]
+
+    # calculate sample standard deviation, you can also use "stdevs"
+    p r.stdev
+
+    # calculate population standard deviation
+    p r.stdevp
+
+## Links
+
+This is the third version of this gem, and it is a total rewrite of a SWIG-based design. Lots of thanks to the following resources:
+
+* https://blog.jcoglan.com/2012/07/29/your-first-ruby-native-extension-c/
+* https://github.com/andremedeiros/ruby-c-cheat-sheet
+* http://silverhammermba.github.io/emberb/c/
+* http://docs.ruby-lang.org/en/2.3.0/extension_rdoc.html

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rake/extensiontask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb', "test/**/*_benchmark.rb"]
+end
+
+Rake::ExtensionTask.new("dispersion")
+
+task :default => [:compile, :test]

data/ext/dispersion/dispersion.c

@@ -0,0 +1,52 @@
+#include "ruby.h"
+#include "dispersion.h"
+
+void Init_dispersion() {
+  DispersionModule = rb_define_module("Dispersion");
+  rb_define_method(DispersionModule, "stdev", rb_sample_standard_deviation, 0);
+  rb_define_method(DispersionModule, "stdevs", rb_sample_standard_deviation, 0);
+  rb_define_method(DispersionModule, "stdevp", rb_population_standard_deviation, 0);
+}
+
+double calculate_total_distance_from_mean(VALUE array, unsigned long array_length){
+  unsigned long i;
+  double total = 0;
+  double mean = 0;
+  double total_distance_from_mean = 0;
+
+  for(i = 0; i < array_length; i++){
+    total += rb_num2dbl(rb_ary_entry(array, i));
+  }
+
+  mean = total / array_length;
+
+  for(i = 0; i < array_length; i++){
+    total_distance_from_mean += pow((rb_num2dbl(rb_ary_entry(array, i)) - mean), 2);
+  }
+
+  return total_distance_from_mean;
+}
+
+VALUE rb_sample_standard_deviation(VALUE self) {
+  Check_Type(self, T_ARRAY);
+
+  unsigned int array_length = rb_long2int(RARRAY_LEN(self));
+
+  if (array_length <= 1) {
+    rb_raise(rb_eRangeError, "array must have more than one element");
+  }
+
+  return DBL2NUM(sqrt((calculate_total_distance_from_mean(self, array_length)/(array_length - 1))));
+}
+
+VALUE rb_population_standard_deviation(VALUE self) {
+  Check_Type(self, T_ARRAY);
+
+  unsigned int array_length = rb_long2int(RARRAY_LEN(self));
+
+  if (array_length <= 1) {
+    rb_raise(rb_eRangeError, "array must have more than one element");
+  }
+
+  return DBL2NUM(sqrt(calculate_total_distance_from_mean(self, array_length) / array_length));
+}

data/ext/dispersion/dispersion.h

@@ -0,0 +1,4 @@
+VALUE DispersionModule = Qnil;
+VALUE rb_sample_standard_deviation(VALUE self);
+VALUE rb_population_standard_deviation(VALUE self);
+double calculate_total_distance_from_mean(VALUE array, unsigned long array_length);

data/ext/dispersion/extconf.rb

@@ -0,0 +1,2 @@
+require 'mkmf'
+create_makefile("dispersion")

data/lib/ruby_native_statistics.rb

@@ -0,0 +1,6 @@
+require "ruby_native_statistics/version"
+require "dispersion"
+
+class Array
+  include Dispersion
+end

data/lib/ruby_native_statistics/version.rb

@@ -0,0 +1,3 @@
+module RubyNativeStatistics
+  VERSION = "0.7.0"
+end

data/ruby_native_statistics.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_native_statistics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_native_statistics"
+  spec.version       = RubyNativeStatistics::VERSION
+  spec.authors       = ["Cory Buecker"]
+  spec.email         = ["email@corybuecker.com"]
+  spec.license       = "Unlicense"
+  spec.summary       = "This is a native extension to Ruby that adds various statistical functions to the Array class."
+  spec.homepage      = "https://github.com/corybuecker/ruby-native-statistics"
+
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.extensions << "ext/dispersion/extconf.rb"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 11.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake-compiler", "~> 0.9"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ruby_native_statistics
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- Cory Buecker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  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-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- email@corybuecker.com
+executables: []
+extensions:
+- ext/dispersion/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- ext/dispersion/dispersion.c
+- ext/dispersion/dispersion.h
+- ext/dispersion/extconf.rb
+- lib/ruby_native_statistics.rb
+- lib/ruby_native_statistics/version.rb
+- ruby_native_statistics.gemspec
+homepage: https://github.com/corybuecker/ruby-native-statistics
+licenses:
+- Unlicense
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: This is a native extension to Ruby that adds various statistical functions
+  to the Array class.
+test_files: []