statistical 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 386aaee4684c8ee33471467a97cb425c193d11a4
+  data.tar.gz: 3dd98e635eba8c3aa81d180e269d09676343333f
+SHA512:
+  metadata.gz: 2f0fbbb0170e4602d9a4aec6239afd7cc881c7cd8840fe640d8d5a989ac9b2e3bc5de9bc3dd2d35c0c59ba399c88c7f2f16e163a751bbd018190420a48f3e33c
+  data.tar.gz: e0c1d634ea53c89194efdfc3dc271b003f098311619d6a08aa1aca96dd615a0779cfac8880efd16944ba0deb63df298e64dbc72bde07786a4344b7fa08aec073

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/1000/**
+/codacy-coverage/**
+/coverage/**
+*.so
+*.o
+.gitmsg

data/.rubocop.yml

@@ -0,0 +1,111 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-02-11 17:16:01 +0000 using RuboCop version 0.37.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 80
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'statistical.gemspec'
+    - 'bin/distribution'
+
+# 10 lines won't be enough for math oriented code
+# 25 decided upon arbitrarily
+Metrics/MethodLength:
+  Max: 25
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'bin/**/*'
+
+# Indentation width must be 2 spaces
+Style/IndentationWidth:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues.
+# SupportedStyles: ruby19, ruby19_no_mixed_keys, hash_rockets
+Style/HashSyntax:
+  Enabled: true
+  UseHashRocketsWithSymbolValues: true
+  Exclude:
+    - 'statistical.gemspec'
+    - 'spec/**/*'
+    - 'test/**/*'
+    
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Enabled: true
+
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'statistical.gemspec'
+  Exclude:
+    - 'statistical.gemspec'
+    - 'spec/**/*'
+    - 'test/**/*'
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+Style/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyle: no_space
+  Exclude:
+    - 'statistical.gemspec'
+    - 'spec/**/*'
+    - 'test/**/*'
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Enabled: true
+  Exclude:
+    - 'statistical.gemspec'
+    - 'bin/*'
+    - 'spec/**/*'
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: final_newline, final_blank_line
+Style/TrailingBlankLines:
+  Enabled: true
+  EnforcedStyle: final_newline
+
+# Cop supports --auto-correct.
+Style/TrailingWhitespace:
+  Enabled: true
+
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'statistical.gemspec'
+
+# I'm fine with either
+Style/RedundantReturn:
+  Enabled: false
+
+# Allow non-ascii characters in comments
+Style/AsciiComments:
+  Enabled: false
+  
+Style/Alias:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.3
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Adding a new distribution
+run `bundle exec bin/distribution -n <dist_name>` from the project root to add boilerplate code for the distribution class, rng class and specs.
+
+## Structure
+The gem is split into random number generators and the abstract probabilty distributions that these generators draw from.
+
+To add an RNG for a distribution in `statistical/lib/rng` a class with the same name must be defined under `statistical/lib/distribution` under the `Distribution` module
+
+`rng.rb` and `distribution.rb` provide useful constants to list all the subclassed distributions, and act as a factory layer on top of all distributions in 
+
+All abstractions of distributions must be under the module `Statistical::Distribution`
+
+All random number generators must be under the module `Statistical::Rng`
+
+## Useful rake tasks
+The default `rake` task is to run the tests
+* `bundle exec rake spec` - Run rspec tests
+* `bundle exec rake cop` - Run rubocop
+* `bundle exec rake doc` - Run yard to generate documentation
+
+## Workflow / General Guidelines
+1. Fork this repository and create your feature branch
+2. All new code addition must be through the feature branch only. Changes to master will be rejected.
+3. Test your on code atleast 3 continuous major releases of ruby (you can setup travis-CI for this). Usually CURRENT_RUBY_VERSION and two major predecessors should be fine (2.3.X, 2.2.Y 2.1.W)
+4. Try to keep one commit per change (Optional, but better to be organized)
+5. If possible write a test case which confirms your change
+6. When submitting a change that chooses a specific algorithm over others available write your rationale behind the choice. Benchmarks comparing different algorithms would be highly appreciated.
+7. Yes, it's OK to pick an algorithm for simplicity of expression.
+8. Your pull request should attempt to explain the change you want to introduce
+
+## Coding conventions
+
+How to style your C and Ruby code which you want to submit.
+
+### C code
+
+Please note the following hints for your C code:
+
+#### Comply with C99 (ISO/IEC 9899:1999)
+
+This library should be portable to other systems and compilers. For this it is
+recommended to keep your code as close as possible to the C99 standard
+(http://www.open-std.org/jtc1/sc22/WG14/www/docs/n1256.pdf).
+
+As some of us may also be using Visual C++ as a build target. For this reason a
+declaration of a local variable has to be at the beginning of a scope block.
+
+#### Reduce library dependencies to a minimum
+
+The dependencies to libraries should be kept to an absolute minimum. If this is
+not possible immediately, consider authoring a secondary gem for this that lives 
+under statistical-<feature_name>. This can also be added as a plugin.
+
+#### Don't use C++ style comments
+
+    /* This is the preferred comment style */
+
+Use C++ style comments only for temporary comments e.g. commenting out some code lines.
+
+#### Insert a break after the method return value:
+
+    int
+    main(void)
+    {
+      ...
+    }
+
+### Ruby code
+
+`bundle exec rake cop` is your best friend.
+
+## Notes
+Feel free to open a "question" issue if you have any questions or want to discuss about better ways to go about this.

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'codeclimate-test-reporter', :group => :test, :require => nil
+gem 'yard', require: false
+
+# Other dependencies go in statistical.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vaibhav Yenamandra
+
+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,37 @@
+# Statistical
+[![Code Climate](https://codeclimate.com/github/vaibhav-y/statistical/badges/gpa.svg)](https://codeclimate.com/github/vaibhav-y/statistical)
+[![Test Coverage](https://codeclimate.com/github/vaibhav-y/statistical/badges/coverage.svg)](https://codeclimate.com/github/vaibhav-y/statistical/coverage)
+[![Issue Count](https://codeclimate.com/github/vaibhav-y/statistical/badges/issue_count.svg)](https://codeclimate.com/github/vaibhav-y/statistical)
+
+Statistical distributions in ruby. This library aims to provide and enhance an API that maintains familiarity with ruby's core and stdlib.
+
+## Usage
+
+TODO: Write usage instructions here, see docs
+
+### Documentation
+Available [here](http://www.rubydoc.info/github/vaibhav-y/statistical/master).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
+
+
+## Roadmap
+### Immediate focus
+* Implementations of all common distributions mentioned in the NIST [engineering and statistics handbook](http://www.itl.nist.gov/div898/handbook/eda/section3/eda366.htm)
+* Parity with Sciruby/distrbution (The inspiration for this project)
+
+### Long term
+* Add a module `Statistical::Hypothesis` which allows for statistical hypothesis testing
+* Explore creating a symbolic DSL using this library that involves manipulating random variates
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,43 @@
+require 'bundler'
+
+Bundler.setup
+
+require 'rake'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+require 'statistical/version'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+
+# Add a cop task for code linting
+RuboCop::RakeTask.new(:cop) do |t|
+  t.options = ['--format', 'simple']
+end
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+# Build the gem
+task :build do
+  system "gem build statistical.gemspec"
+end
+
+# Install gem locally
+task :install => :build do
+  system "gem install statistical-#{Statistical::VERSION}.gem"
+end
+
+# Release gem to github
+task :release => :build do
+  system "git tag -a v#{Statistical::VERSION} -m 'Version #{Statistical::VERSION}'"
+  system "git push --tags"
+  system "gem push statistical-#{Statistical::VERSION}.gem"
+end
+
+task :default => :spec
+
+task :gem => :build

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "statistical"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/distribution

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'fileutils'
+require 'erb'
+gem_base = File.expand_path(File.dirname(__FILE__) + '/..')
+require gem_base + '/lib/statistical'
+
+class String
+  def camelcase
+    split('_').map(&:capitalize).join
+  end
+end
+
+needs_new = false
+parameters = ''
+OptionParser.new do |opts|
+  opts.banner = 'Usage: distribution [--new] [--params parameters] distribution_name'
+  opts.on('-n', '--new', 'Create a new template for distribution') do
+    needs_new = true
+  end
+  opts.on('-PMANDATORY', '--params MANDATORY', String, 'Parameters for distribution') do |n_param|
+    parameters = ", #{n_param}"
+  end
+
+  opts.on('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+
+  begin
+    ARGV << '-h' if ARGV.empty?
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    STDERR.puts e.message, "\n", opts
+    exit(-1)
+  end
+end
+
+ARGV.each do |distribution|
+  next unless needs_new
+  basename = distribution.downcase
+  raise 'You should be inside distribution lib directory' unless File.exist? 'statistical.gemspec'
+  raise 'Distribution already created' if File.exist?("#{gem_base}/lib/statistical/distribution/#{basename}.rb") && File.exist?("#{gem_base}/lib/statistical/rng/#{basename}.rb")
+
+  dist = ERB.new(File.read(gem_base + '/data/template/distribution.erb'))
+  rng = ERB.new(File.read(gem_base + '/data/template/rng.erb'))
+  spec = ERB.new(File.read(gem_base + '/data/template/spec.erb'))
+
+  File.open("#{gem_base}/lib/statistical/distribution/#{basename}.rb", 'w') { |fp| fp.write(dist.result(binding))}
+  File.open("#{gem_base}/lib/statistical/rng/#{basename}.rb", 'w') { |fp| fp.write(rng.result(binding))}
+  File.open("#{gem_base}/spec/#{basename}_spec.rb", 'w') { |fp| fp.write(spec.result(binding))}
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data/template/distribution.erb

@@ -0,0 +1,84 @@
+require 'statistical/exceptions'
+
+module Statistical
+  module Distribution
+    # Say something useful about this class.
+    #
+    # @note Any caveats you want to talk about go here...
+    #
+    # @author Full Name
+    # @attr [Types] attribute_name a full description of the attribute
+    # @attr_writer [Types] attribute_name a full description of the attribute
+    # @attr_reader [Types] attribute_name a full description of the attribute
+    # @deprecated warn if the class is deprecated and provide and alternative
+    class <%= distribution.capitalize.camelcase %>
+      attr_reader # params go here
+
+      # Returns a new `Statistical::Distribution::<%= distribution.capitalize.camelcase %>` instance
+      #
+      # @param [Types] param_name Description
+      # @return `Statistical::Distribution::<%= distribution.capitalize.camelcase %>` instance
+      def initialize(<% parameters %>)
+      end
+
+      # Returns value of probability density function at a point. Calculated
+      #   using some technique that you might want to name
+      #
+      # @param [Numeric] x A real valued point
+      # @return Probability density function evaluated at `x`
+      def pdf(x)
+      end
+
+      # Returns value of cumulative density function at a point. Calculated
+      #   using some technique that you might want to name
+      #
+      # @param [Numeric] x A real valued point
+      # @return Cumulative density function evaluated for F(u <= x)
+      def cdf(x)
+      end
+
+      # Returns value of inverse CDF for a given probability
+      #
+      # @see #p_value
+      #
+      # @param [Numeric] p a value within [0, 1]
+      # @return Inverse CDF for valid p
+      # @raise [RangeError] if p > 1 or p < 0
+      def quantile(p)
+        raise RangeError, "`p` must be in [0, 1], found: #{p}" if p < 0 || p > 1
+      end
+
+      # Returns the mean value for the calling instance. Calculated mean, and
+      #   not inferred from simulations
+      #
+      # @return Mean of the distribution
+      def mean
+      end
+
+      # Returns the expected value of variance for the calling instance.
+      #
+      # @return Variance of the distribution
+      def variance
+      end
+
+      # Compares two distribution instances and returns a boolean outcome
+      #   Available publicly as #==
+      #
+      # @private
+      #
+      # @param other A distribution object (preferred)
+      # @return [Boolean] true if-and-only-if two instances are of the same
+      #   class and have the same parameters.
+      def eql?(other)
+        return false unless other.is_a?(self.class)
+        # Compare parameters and other stuff here
+        return true
+      end
+
+      alias :== :eql?
+      alias :p_value :quantile
+
+      private :eql?
+    end
+  end
+end