random-walk 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,26 +1,17 @@
 = random-walk
 
-This is an extremely simple gem for generating random-walk test data in an array. It's useful for statistics testing, where random data falls short for testing something like simple regression.
+This is an extremely simple gem for generating random-walk test data in an array. It's useful for statistics or finance testing, where random data falls short for something like simple regression or the movement of stocks.
 
-The resulting array will always stay within the range provided (inclusive). The random-walk adds +1, 0, or -1 on each iteration.
+The resulting array will always stay within the range provided (inclusive). The random-walk adds +1, 0, or -1 on each iteration by default.
 
 == Usage
 
     require 'random-walk'
 
-    # RandomWalk.generate(range, array_length)
+    # RandomWalk.generate(range, array_length, step=1)
     RandomWalk.generate(10..40, 5) # [11, 12, 11, 10, 10]
     RandomWalk.generate(10..40, 5) # [27, 28, 29, 30, 29]
-
-    # generate_vectors(x_range, y_range, vector_length)
-    rw = RandomWalk.new
-    rw.generate_vectors(0..99, 0..1023, 5)
-    rw.x # [78, 79, 80, 81, 81]
-    rw.y # [700, 701, 702, 702, 701]
-
-    # fit_y_to_x(fit_chance)
-    rw.fit_y_to_x(100) # Perfect fit. If x goes up by 1, y goes up by 1
-    rw.fit_y_to_x(50) # 50% chance. If x goes up by 1, y has a 50 percent chance of going up by 1
+    RandomWalk.generate(10..40, 5, 2) # [34, 36, 36, 38, 36]
 
 == Contributing to random-walk
  

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/random-walk.rb

@@ -1,11 +1,10 @@
 class RandomWalk
-  attr_accessor :x, :y
-
-  def self.generate(limits, array_length)
+  def self.generate(limits, array_length, step = 1)
     starting_point = Random.rand(limits)
     output_array = [starting_point]
+
     (array_length - 1).times do
-      add_or_subtract = Random.rand(-1..1)
+      add_or_subtract = Random.rand(-step..step)
       end_point = output_array.last + add_or_subtract
       if end_point <= limits.max && end_point >= limits.min
         output_array << end_point
@@ -13,24 +12,7 @@ class RandomWalk
         output_array << output_array.last
       end
     end
-    return output_array
-  end
 
-  def generate_vectors(x_limits, y_limits, vector_length)
-    self.x = RandomWalk.generate(x_limits, vector_length)
-    self.y = RandomWalk.generate(y_limits, vector_length)
-  end
-
-  def fit_y_to_x(fit_chance)
-    raise 'Fit chance must be between 0 and 100' unless fit_chance <= 100 && fit_chance >= 0
-    self.x.each_with_index do |value, i|
-      if self.x[i] && self.x[i+1]
-        x_diff = self.x[i] - self.x[i+1]
-        rand = Random.rand(100 / fit_chance)
-        if rand == 0
-          self.y[i+1] = self.y[i] - x_diff
-        end
-      end
-    end
+    return output_array
   end
 end

data/random-walk.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "random-walk"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Tann"]

data/spec/random-walk_spec.rb

@@ -1,62 +1,35 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "RandomWalk" do
-  describe "generate" do
-    it "returns results between given limits" do
-      5.times do
-        results = RandomWalk.generate(0..10, 1000)
-        results.each do |result|
-          result.should be >= 0
-          result.should be <= 10
-        end
+  it "returns results between given limits" do
+    5.times do
+      results = RandomWalk.generate(0..10, 1000)
+      results.each do |result|
+        (result.should be >= 0) && (result.should be <= 10)
       end
     end
-
-    it "returns an array of the correct length" do
-      results = RandomWalk.generate(100..200, 250)
-      results.length.should == 250
-    end
   end
 
-  describe "generate_vectors" do
-    let(:rw) { RandomWalk.new }
-
-    it "returns results between given limits" do
-      5.times do
-        rw.generate_vectors(0..10, 0..10, 1000)
-        rw.x.each do |result|
-          result.should be >= 0
-          result.should be <= 10
-        end
-        rw.y.each do |result|
-          result.should be >= 0
-          result.should be <= 10
-        end
-      end
-    end
+  it "returns an array of the correct length" do
+    results = RandomWalk.generate(100..200, 250)
+    results.length.should == 250
+  end
 
-    it "returns 2 arrays of the correct length" do
-      rw.generate_vectors(0..99, 0..1023, 500)
-      rw.x.length.should == 500
-      rw.y.length.should == 500
+  it "uses a default step size of 1" do
+    results = RandomWalk.generate(0..10, 1000, 1)
+    previous_result = results.first
+    results.each do |result|
+      (previous_result-1..previous_result+1).should cover(result)
+      previous_result = result
     end
   end
 
-  describe "fit_y_to_x" do
-    let(:rw) { RandomWalk.new }
-
-    it "fits the y array to the x array perfectly" do
-      rw.generate_vectors(0..99, 250..1000, 500)
-      fit_chance = 100
-      rw.fit_y_to_x(fit_chance)
-      diff_x, diff_y = 0, 0
-      rw.x.each_with_index do |result, i|
-        if rw.x[i+1]
-          diff_x += rw.x[i] - rw.x[i+1]
-          diff_y += rw.y[i] - rw.y[i+1]
-        end
-      end
-      diff_x.should == diff_y
+  it "uses steps of the specified size" do
+    results = RandomWalk.generate(0..10, 1000, 5)
+    previous_result = results.first
+    results.each do |result|
+      (previous_result-5..previous_result+5).should cover(result)
+      previous_result = result
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: random-walk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -109,9 +109,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3032803507122637849
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -125,3 +122,4 @@ signing_key:
 specification_version: 3
 summary: Simple random-walk generator
 test_files: []
+has_rdoc: