random_bell 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8e2d2c6b448d735826d4bbfa7dab38c3ef046e7
-  data.tar.gz: 2ccfb6c3f429860a0501785fc0585c4d97b45b2d
+  metadata.gz: a2f841d0dc7315bbccd0e09bb867f6fa3223fc9c
+  data.tar.gz: 318eb5a9bb67687eba4bd8a5151c54d39fcbe47b
 SHA512:
-  metadata.gz: 39671a2d895f381db1e41e2a5137e01ce12065dd40780f21814851a1eee317641bec60b0518365524a5492334730af2a9bc242b886e40ebc1483f5b06cdbb068
-  data.tar.gz: ba678c93052cae0515dbe6e3a0a20f8d8dc926db7ba0d54c7d7fa3ebe6c4832abf9fce29e24ace585499d4f9b5ebd6d58850c0448fd1386ddd1ceeb0a8287051
+  metadata.gz: 913930f257af0d0d3e62aac74fc83093597dda29a3b4a148e031a39f48cda817bf3bb0969c59c7b8c8c087cbbc51cc5a31f17b45c72e12c458a62cc9870798a7
+  data.tar.gz: e65b45d07605b9626c44216e0b54a128457c59ada044095eff5229d47255b1fa45837a26274258b7c45fc80de90313aea635d088ab50ccb76415f6d7bde88bfa

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
-- 2.0.0
-- 2.1.0
+- 2.2.0
+- 2.3.0
+- 2.4.0

data/README.md

@@ -1,6 +1,8 @@
 # RandomBell
 
-RandomBell is nomal(Gaussian) random number generator.
+[![Build Status](https://travis-ci.org/s-osa/random_bell.svg?branch=0.1.1)](https://travis-ci.org/s-osa/random_bell)
+
+RandomBell is Ruby gem to generate normal(Gaussian) random number.
 
 ## Installation
 
@@ -24,7 +26,185 @@ $ gem install random_bell
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic
+
+#### Code
+
+```ruby
+bell = RandomBell.new
+bell.rand #=> 0.596308234257563
+bell.rand #=> 0.4986734346841275
+bell.rand #=> 0.6441978387725272
+```
+
+#### Histogram
+
+```
++0.050: ***
++0.100: *****
++0.150: *********
++0.200: *************
++0.250: **********************
++0.300: **************************
++0.350: **********************************
++0.400: ****************************************
++0.450: ***********************************************
++0.500: *************************************************
++0.550: *************************************************
++0.600: ***********************************************
++0.650: **************************************
++0.700: **********************************
++0.750: **************************
++0.800: *********************
++0.850: *************
++0.900: ********
++0.950: *****
++1.000: ***
+```
+
+### Specify mean
+
+#### Code
+
+```ruby
+bell = RandomBell.new(mu: 0.75)
+bell.rand
+```
+
+#### Histogram
+
+```
++0.050:
++0.100:
++0.150:
++0.200:
++0.250: *
++0.300: **
++0.350: *****
++0.400: *********
++0.450: *************
++0.500: ********************
++0.550: ***************************
++0.600: ***********************************
++0.650: ****************************************
++0.700: ************************************************
++0.750: *************************************************
++0.800: *************************************************
++0.850: ********************************************
++0.900: *******************************************
++0.950: ***********************************
++1.000: *************************
+```
+
+### Specify standard diviation
+
+#### Code
+
+```ruby
+bell = RandomBell.new(sigma: 0.5)
+bell.rand
+```
+
+#### Histogram
+
+```
++0.050: *******************************
++0.100: *********************************
++0.150: *********************************
++0.200: *************************************
++0.250: ******************************************
++0.300: ********************************************
++0.350: ***********************************************
++0.400: *********************************************
++0.450: *************************************************
++0.500: ***********************************************
++0.550: ************************************************
++0.600: ***********************************************
++0.650: ******************************************
++0.700: ********************************************
++0.750: *********************************************
++0.800: ******************************************
++0.850: ****************************************
++0.900: *****************************************
++0.950: *********************************
++1.000: **********************************
+```
+
+### Specify range of number
+
+#### Code
+
+```ruby
+bell = RandomBell.new(range: 0.4..1.2)
+bell.rand
+```
+
+#### Histogram
+
+```
++0.440: *********************************************
++0.480: *************************************************
++0.520: **************************************************
++0.560: *************************************************
++0.600: ********************************************
++0.640: *****************************************
++0.680: ***********************************
++0.720: *****************************
++0.760: ************************
++0.800: ********************
++0.840: *************
++0.880: **********
++0.920: *******
++0.960: ****
++1.000: ***
++1.040: *
++1.080: *
++1.120:
++1.160:
++1.200:
+```
+
+### Composition
+
+#### Code
+
+```ruby
+bell = RandomBell.new(mu: 25, sigma: 2, range: 20..30)
+bell.rand
+```
+
+```
++20.500: **
++21.000: *****
++21.500: *********
++22.000: *************
++22.500: ********************
++23.000: *************************
++23.500: *********************************
++24.000: *************************************
++24.500: ********************************************
++25.000: ************************************************
++25.500: **********************************************
++26.000: *******************************************
++26.500: ****************************************
++27.000: ********************************
++27.500: *************************
++28.000: *******************
++28.500: ************
++29.000: *******
++29.500: *****
++30.000: **
+```
+
+### Tips
+
+`RandomBell#to_histogram` returns primitive histogram string.
+The histograms in this page are drawn by this method.
+
+```ruby
+bell = RandomBell.new
+puts bell.to_histogram
+```
 
 ## Contributing
 

data/lib/random_bell.rb

@@ -1,21 +1,30 @@
 require "random_bell/version"
 
 class RandomBell
-  def initialize(mu: 0.5, sigma: 0.2, range: 0.0..1.0, method: :box_muller)
+  # @param mu     [Float]
+  # @param sigma  [Float]
+  # @param range  [Range]
+  # @param seed   [Integer]
+  # @param method [Symbol] Method to generate standard normal distribution (:box_muller or :central_limit)
+  def initialize(mu: 0.5, sigma: 0.2, range: 0.0..1.0, seed: Random.new_seed, method: :box_muller)
     @mu     = mu
     @sigma  = sigma
     @range  = range
+    @rand_generator = Random.new(seed)
     @method = method
   end
 
+  # @return [Float]
   def standard
     send(@method)
   end
 
+  # @return [Float]
   def normal
     @mu + standard * @sigma
   end
 
+  # @return [Float]
   def rand
     loop do
       num = normal
@@ -23,6 +32,7 @@ class RandomBell
     end
   end
 
+  # @return [String]
   def to_histogram(rows: 20, size: 10 ** 4)
     histogram = ""
 
@@ -30,7 +40,7 @@ class RandomBell
 
     klasses, klass_width = [], (@range.max - @range.min).to_f / rows
     (0..rows).each_cons(2) do |left, right|
-      klasses << Range.new(@range.min + klass_width * left, @range.min + klass_width *right)
+      klasses << Range.new(@range.min + klass_width * left, @range.min + klass_width * right)
     end
 
     divider = (klasses.map{|klass| numbers.select{|num| klass.include?(num) }.size }.max / 50.0).ceil
@@ -44,16 +54,29 @@ class RandomBell
 
   private
 
+  # @return [Float]
   def box_muller
-    theta  = 2 * Math::PI * Random.rand
-    r      = Math.sqrt( -2 * Math.log(Random.rand) )
-    z1, z2 = r * Math.cos(theta), r * Math.sin(theta)
-    [z1, z2].sample
+    @box_muller_queue ||= []
+
+    if @box_muller_queue.empty?
+      theta  = 2 * Math::PI * random_number
+      r      = Math.sqrt( -2 * Math.log(random_number) )
+      z1, z2 = r * Math.cos(theta), r * Math.sin(theta)
+      @box_muller_queue += [z1, z2]
+    end
+
+    @box_muller_queue.shift
   end
 
+  # @return [Float]
   def central_limit
     arr = []
-    12.times{ arr << Random.rand }
+    12.times{ arr << random_number }
     arr.reduce(0.0, &:+) - 6
   end
+
+  # @return [Float]
+  def random_number
+    @rand_generator.rand
+  end
 end

data/lib/random_bell/version.rb

@@ -1,3 +1,3 @@
 class RandomBell
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/random_bell.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2"
+  spec.add_development_dependency "rspec", "~> 3"
 end

data/spec/random_bell_spec.rb

@@ -118,6 +118,19 @@ describe RandomBell do
         end
       end
     end
+
+    context "seed given" do
+      before do
+        @bell1 = RandomBell.new(seed: 1234)
+        @bell2 = RandomBell.new(seed: 1234)
+      end
+
+      it "should return same sequence" do
+        100.times do
+          expect(@bell1.rand).to eq @bell2.rand
+        end
+      end
+    end
   end
 
   describe "#to_histogram" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: random_bell
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - OSA Shunsuke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-06 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 description: Normal(Gaussian) random number generator.
 email:
 - hhelibebcnofnenamg@gmail.com
@@ -64,7 +64,6 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/random_bell.rb
@@ -92,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Normal(Gaussian) random number generator.

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 OSA Shunsuke
-
-MIT License
-
-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.