simpack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 675c709efae46cf72cbc281ee4e020759e6ac43b
+  data.tar.gz: 7facb2c0311aea090cdabfaecf2f6e22d9431c66
+SHA512:
+  metadata.gz: a86ff1f5a58a486c3e533f8bdd1ed95c603c66aea7d37e423561c5bad693a59ccd6961e72fed477c5e38edcac90bcb31913e52b0b2e2382b0bca6abf304f42e5
+  data.tar.gz: d3e4f9ed611cd3997506a9a5093cb855a0370cb7a8bb789edb6dfc9a4ff43239c7f0ac8e01f159b529b27c490383dcfce5f91798fb241273d2dd944795fc1886

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.0
+
+addons:
+  code_climate:
+    repo_token: 434d4cfa388ad2146c71bca82bf4cb9693336f208412c7378c2c099de8f81326

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem "codeclimate-test-reporter"
+  gem 'rake', '~> 10.4.2'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 John Ochs
+
+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,83 @@
+# Simpack
+[![Code Climate](https://codeclimate.com/github/johnochs/simpack/badges/gpa.svg)](https://codeclimate.com/github/johnochs/simpack)
+[![Test Coverage](https://codeclimate.com/github/johnochs/simpack/badges/coverage.svg)](https://codeclimate.com/github/johnochs/simpack)
+
+Simpack is your go-to gem for your simulation needs in Ruby.  At its heart, Simpack is a linear congruential generator (LCG) which can then be used to generate random samples from a number of statistical distributions.
+
+Use it for simulation, modeling, or games!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simpack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simpack
+
+## Usage
+
+### Simpack::LCG
+
+#### \#initialize
+
+```ruby
+lcg = Simpack::LCG.new
+```
+
+Optionally, you may wish to configure your LCG to suit your preferences with an options hash:
+
+```ruby
+lcg = Simpack::LCG.new({modulus: 8, multiplier: 5})
+```
+Keys for the options hash include the following:
+* `:modulus`
+* `:multiplier`
+* `:increment`
+* `:seed`
+
+If you do decide to specify your own constants, all bets are off.  Simpack (as of now) does not test for constraints of the Hull-Dobell Theorem, or any other tests of period or uniformity.  This allows you to create a crappy LCG if you desire, but it will not alert you if you do.
+
+See the __Technical Specs__ section for details of the standard configuration.
+
+#### \#uniform
+
+\#uniform can be called with an optional argument specifying the number of random numbers to return.
+
+```ruby
+> lcg.uniform
+> 0.27662859533103207
+
+> lcg.uniform(3)
+> [0.9518568231847053, 0.7968659172399516, 0.15733885122680413]
+```
+
+## Contributing
+
+Want to add a new distribution?  Have ideas for a feature?  Spotted a bug?  Contribute!  I am especially looking for people who have a bit more statistical knowledge than I do to spot any potential problems with the code.
+
+1. Fork it ( https://github.com/johnochs/simpack/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+##Technical Specs
+
+### Simpack::LCG
+
+Table of standard parameters:
+
+|Parameter |Value              |
+|----------|-------------------|
+|Modulus   | 2<sup>64          |
+|Multiplier|6364136223846793005|
+|Increment |1442695040888963407|
+|Seed      |`Time.now.to_i`    |

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simpack"
+
+# 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
+
+# require "irb"
+# IRB.start

data/bin/setup

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

data/lib/simpack.rb

@@ -0,0 +1,48 @@
+require "simpack/version"
+
+module Simpack
+
+  class LCG
+
+    attr_reader :multiplier, :modulus, :increment, :seed
+
+    def initialize(options = {})
+      default_options = {multiplier: 6364136223846793005,
+                         modulus: 2 ** 64,
+                         increment: 1442695040888963407,
+                         seed: Time.now.to_i}
+
+      options = default_options.merge(options)
+      check_options(options)
+
+      @multiplier = options[:multiplier]
+      @modulus = options[:modulus]
+      @increment = options[:increment]
+      @seed = @x = options[:seed]
+    end
+
+    def uniform(n = 1)
+      return generate_number if n == 1
+
+      results = Array.new(n)
+      (0...n).each do |i|
+        results[i] = generate_number
+      end
+      results
+    end
+
+    private
+
+    def check_options(options)
+      raise "Invalid Modulus" if options[:modulus] == 0
+      raise "Invalid Multiplier" if options[:multiplier] == 0
+    end
+
+    def generate_number
+      @x = (@multiplier * @x + @increment) % @modulus
+      @x / @modulus.to_f
+    end
+
+  end
+
+end

data/lib/simpack/version.rb

@@ -0,0 +1,3 @@
+module Simpack
+  VERSION = "0.1.0"
+end

data/simpack.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simpack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simpack"
+  spec.version       = Simpack::VERSION
+  spec.authors       = ["John Ochs"]
+  spec.email         = ["johnochs@me.com"]
+
+  spec.summary       = %q{Simpack is your go-to gem for your simulation needs in Ruby. At its heart, Simpack is a linear congruential generator (LCG) which can then be used to generate random samples from a number of statistical distributions.}
+  spec.description   = %q{A solution for all your simulation needs!}
+  spec.homepage      = "https://github.com/johnochs/simpack"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: simpack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Ochs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: A solution for all your simulation needs!
+email:
+- johnochs@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simpack.rb
+- lib/simpack/version.rb
+- simpack.gemspec
+homepage: https://github.com/johnochs/simpack
+licenses:
+- MIT
+metadata: {}
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simpack is your go-to gem for your simulation needs in Ruby. At its heart,
+  Simpack is a linear congruential generator (LCG) which can then be used to generate
+  random samples from a number of statistical distributions.
+test_files: []