nondeterminism 0.1.0

data/README

@@ -0,0 +1,86 @@
+Copyright 2008 James Rosen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+
+
+Some example use cases:
+
+	
+	# accept only half of emails
+	50.percent_of_the_time do
+		email.accept!
+	end
+	
+	
+	# accept only half of emails and send nasty
+	# responses to the rest
+	50.percent_of_the_time do
+		email.accept!
+	end.else do
+		email.send_nasty_response!
+	end
+	
+
+	# name should be
+	#	'jerome' 30% of the time
+	#	'kevin' 40% of the time
+	#	'leslie' the rest of the time
+	
+	with_probability(0.30) do
+		name = 'jerome'
+	end.else_with_probability(0.40) do
+		name = 'kevin'
+	end.else
+		name = 'leslie'
+	end
+	
+	
+	# select a random friend from an Array:
+	friend = person.friends.random_element
+	
+	
+	# call foo between 5 and 8 times (inclusive):
+	(5..8).times do
+		foo
+	end
+
+
+
+Using a custom random probability generator:
+	if you want to change the random-probability-generation mechanism, do
+	something like:
+	
+	Nondeterminism::probability_generator = Proc.new { ... }
+	
+	or
+	
+	Nondeterminism::probability_generator = my_obj
+	
+	just make sure my_obj responds to #call or #to_proc and only returns
+	numbers in [0.0, 1.0]
+
+
+Using a custom random integer generator:
+	if you want to change the random-integer-generation mechanism, do
+	something like:
+	
+	Nondeterminism::integer_generator = Proc.new { |low, high| ... }
+	
+	or
+	
+	Nondeterminism::integer_generator = Proc.new { |low, high| ... }
+	
+	just make sure my_obj responds to #to_proc, the proc has #arity = 2
+	(or < -2), and only returns numbers in [low, high]

data/lib/nondeterminism.rb

@@ -0,0 +1,52 @@
+require 'nondeterminism/probability/kernel'
+require 'nondeterminism/probability/numeric'
+require 'nondeterminism/array'
+require 'nondeterminism/range'
+
+module Nondeterminism
+  
+    DEFAULT_PROBABILITY_GENERATOR = Proc.new { Kernel.rand }
+    
+    @@probability_generator = DEFAULT_PROBABILITY_GENERATOR
+    
+    def self.probability_generator
+      @@probability_generator
+    end
+  
+    def self.probability_generator=(generator)
+      raise ArgumentError.new('generator must respond to #to_proc') unless generator.respond_to?(:to_proc)
+      @@probability_generator = generator.to_proc
+    end
+  
+    def self.random_probability
+      result = probability_generator.call
+      raise "generator (#{probability_generator}) generated invalid probability: #{result}" unless result >= 0.0 && result <= 1.0
+      result
+    end
+    
+    
+    DEFAULT_INTEGER_GENERATOR = Proc.new { |low, high| Kernel.rand * high + low }
+    
+    @@integer_generator = DEFAULT_PROBABILITY_GENERATOR
+    
+    def self.integer_generator
+      @@integer_generator
+    end
+  
+    def self.integer_generator=(generator)
+      raise ArgumentError.new('generator must respond to #to_proc') unless generator.respond_to?(:to_proc)
+      proc = generator.to_proc
+      raise ArgumentError.new('generator must have arity == 2 or < -2') unless proc.arity == 2 || proc.arity < -2
+      @@integer_generator = proc
+    end
+  
+    def self.random_integer(range)
+      self.random_integer(range.first, range.last)
+    end
+    
+    def self.random_integer(low, high)
+      result = integer_generator.call(low, high).to_i
+      raise "generator (#{integer_generator}) generated invalid integer: #{result}" unless result >= low && result <= high
+      result
+    end
+end

data/test/array_test.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/test_helper'
+
+class ArrayTest < Test::Unit::TestCase
+
+  def setup
+    Nondeterminism::integer_generator = Proc.new { |x, y| x }
+  end
+  
+  def test_rand
+    assert_equal 'a', ['a', 'b', 'c'].rand
+  end
+  
+  def test_rand_when_empty
+    assert_nil [].rand
+  end
+  
+end

data/test/integer_generator_test.rb

@@ -0,0 +1,45 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/test_helper'
+
+
+class NoToProc
+end
+
+class ToProcArityZero
+  def to_proc
+    Proc.new { nil }
+  end
+end
+
+class ToProcArityTwoReturnsFour
+  def to_proc
+    Proc.new { |x, y| 4 }
+  end
+end
+
+class ToProcArityTwoReturnsAverage
+  def to_proc
+    Proc.new { |x, y| ((x + y) / 2).to_i }
+  end
+end
+
+class IntegerGeneratorTest < Test::Unit::TestCase
+
+  def test_generator_must_define_to_proc
+    assert_raises(ArgumentError) { Nondeterminism::integer_generator = NoToProc.new }
+  end
+  
+  def test_generator_must_have_arity_2
+    assert_raises(ArgumentError) do
+      Nondeterminism::integer_generator = ToProcArityZero.new
+    end
+  end
+  
+  def test_generator_must_return_integers_in_bounds
+    Nondeterminism::integer_generator = ToProcArityTwoReturnsFour.new
+    assert_raises(RuntimeError) do
+      Nondeterminism::random_integer(5, 9)
+    end
+  end
+  
+end

data/test/percent_probability_test.rb

@@ -0,0 +1,42 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/test_helper'
+
+class PercentProbabilisticTest < Test::Unit::TestCase
+
+  def setup
+    Nondeterminism::probability_generator = Proc.new { 0.5 }
+  end
+  
+  def test_negative_percent_raises_argument_error
+    assert_raises(ArgumentError) { -4.percent_of_the_time { nil } }
+  end
+
+  def test_percent_over_100_raises_argument_error
+    assert_raises(ArgumentError) { 110.percent_of_the_time { nil } }
+  end
+  
+  def test_simple_percent_probability
+    i = 0
+    50.percent_of_the_time { i = 1 }
+    assert_equal 1, i
+    
+    49.9.percent_of_the_time { i = 2 }
+    assert_equal 1, i
+    
+    51.0001.percent_of_the_time { i = 3 }
+    assert_equal 3, i
+  end
+
+  def test_percent_probability_with_else
+    i = 0
+    50.percent_of_the_time { i = 1 }.else { i = 2 }
+    assert_equal 1, i
+    
+    49.9.percent_of_the_time { i = 3 }.else { i = 4 }
+    assert_equal 4, i
+    
+    51.0001.percent_of_the_time { i = 5 }.else { i = 6 }
+    assert_equal 5, i
+  end
+  
+end

data/test/probability_event_chain_test.rb

@@ -0,0 +1,43 @@
+require 'test/unit'
+require 'nondeterminism/probability/event_chain'
+require File.dirname(__FILE__) + '/test_helper'
+
+class ProbabilityEventChainTest < Test::Unit::TestCase
+  
+  def new_chain(*args)
+    Nondeterminism::Probability::EventChain.new(*args)
+  end
+  
+  def test_initialize_probability
+    assert_equal 0.0, new_chain.total_probability
+    assert_equal 0.2, new_chain(0.2, 0.7).total_probability
+  end
+  
+  def test_initialize_random
+    assert new_chain.random_value >= 0.0
+    assert new_chain.random_value <= 1.0
+    assert_equal 0.75, new_chain(0.2, 0.75).random_value
+  end
+  
+  def test_completed
+    assert_equal false, new_chain(0.6, 0.7).completed?
+    assert_equal true,  new_chain(0.8, 0.7).completed?
+  end
+  
+  def test_else_requires_block
+    assert_raises(ArgumentError) { new_chain.else }
+  end
+  
+  def test_else_with_probability_requires_block
+    assert_raises(ArgumentError) { new_chain.else_with_probability(0.9) }
+  end
+  
+  def test_else_else_raises_error
+    assert_raises(NoMethodError) { 5.percent_of_the_time { nil }.else { nil }.else { nil } }
+  end
+  
+  def test_else_else_with_probability_raises_error
+    assert_raises(NoMethodError) { 5.percent_of_the_time { nil }.else { nil }.else_with_probability(0.1) { nil } }
+  end
+  
+end

data/test/probability_generator_test.rb

@@ -0,0 +1,39 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/test_helper'
+
+
+class NoToProc
+end
+
+class ToProcReturnsNegativeOne
+  def to_proc
+    Proc.new { -1 }
+  end
+end
+
+
+class ToProcReturnsFour
+  def to_proc
+    Proc.new { 4 }
+  end
+end
+
+class ProbabilityGeneratorTest < Test::Unit::TestCase
+
+  def test_generator_must_define_to_proc
+    assert_raises(ArgumentError) { Nondeterminism::probability_generator = NoToProc.new }
+  end
+  
+  def test_generator_must_return_integers_in_bounds
+    Nondeterminism::probability_generator = ToProcReturnsNegativeOne.new
+    assert_raises(RuntimeError) do
+      Nondeterminism::random_probability
+    end
+    
+    Nondeterminism::probability_generator = ToProcReturnsFour.new
+    assert_raises(RuntimeError) do
+      Nondeterminism::random_probability
+    end
+  end
+  
+end

data/test/range_test.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/test_helper'
+
+class RangeTest < Test::Unit::TestCase
+
+  def setup
+    Nondeterminism::integer_generator = Proc.new { |x, y| y }
+  end
+  
+  def test_n_times
+    i = 0
+    (6..9).times { i += 1 }
+    assert_equal 9, i
+  end
+  
+  def test_upper_bound
+    i = 0
+    (1...8).times { i += 1 }
+    assert_equal 7, i
+  end
+  
+  def test_negative_value_raises_error
+    Nondeterminism::integer_generator = Proc.new { |x, y| x }
+    i = 0
+    assert_raises(RuntimeError) { (-4..2).times { i += 1 } }
+  end
+  
+end

data/test/ratio_probability_test.rb

@@ -0,0 +1,96 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/test_helper'
+
+class RatioProbabilisticTest < Test::Unit::TestCase
+
+  def setup
+    Nondeterminism::probability_generator = Proc.new { 0.5 }
+  end
+
+  def test_negative_ratio_raises_argument_error
+    assert_raises(ArgumentError) { with_probability(-2.2) { nil } }
+  end
+
+  def test_ratio_over_one_raises_argument_error
+    assert_raises(ArgumentError) { with_probability(1.07) { nil } }
+  end
+  
+  def test_simple_ratio_probability
+    i = 0
+    with_probability(0.3) { i = 1 }
+    assert_equal 0, i
+    
+    with_probability(0.5) { i = 1 }
+    assert_equal 1, i
+    
+    with_probability(1.0) { i = 10 }
+    assert_equal 10, i
+  end
+  
+  def test_else
+    i = 0
+    with_probability(0.3) { i = 1 }.else { i = 2 }
+    assert_equal 2, i
+    
+    with_probability(0.5) { i = 3 }.else { i = 4 }
+    assert_equal 3, i
+    
+    with_probability(1.0) { i = 5 }.else { i = 6 }
+    assert_equal 5, i
+  end
+  
+  def test_else_with_probability
+    i = 0
+    with_probability(0.2) do
+      i = 1
+    end.else_with_probability(0.2999) do
+      i = 2
+    end.else_with_probability(0.0002) do
+      i = 3
+    end.else_with_probability(0.15) do
+      i = 4
+    end
+    
+    assert_equal 3, i
+  end
+  
+  def test_chain_percent_over_100_raises_argument_error
+    assert_raises(ArgumentError) do
+      with_probability(0.9) do
+        nil
+      end.else.with_probability(0.09) do
+        nil
+      end.else.with_probability(0.05) do
+        nil
+      end
+    end
+  end
+  
+  def test_long_chain
+    i = 0
+    with_probability(0.11) do
+      i = 1
+    end.else_with_probability(0.1) do
+      i = 2
+    end.else_with_probability(0.1) do
+      i = 3
+    end.else_with_probability(0.1) do
+      i = 4
+    end.else_with_probability(0.1) do
+      i = 5
+    end.else_with_probability(0.1) do
+      i = 6
+    end.else_with_probability(0.1) do
+      i = 7
+    end.else_with_probability(0.1) do
+      i = 8
+    end.else_with_probability(0.1) do
+      i = 9
+    end.else do
+      i = 100000
+    end
+    
+    assert_equal 5, i
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1 @@
+require 'nondeterminism'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: nondeterminism
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- James Rosen
+autorequire: nondeterminism
+bindir: bin
+cert_chain: []
+
+date: 2008-01-30 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: james @nospam@ universal-presence.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/nondeterminism.rb
+- test/array_test.rb
+- test/integer_generator_test.rb
+- test/percent_probability_test.rb
+- test/probability_event_chain_test.rb
+- test/probability_generator_test.rb
+- test/range_test.rb
+- test/ratio_probability_test.rb
+- test/test_helper.rb
+- README
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: A package for nondeterministic and probabilistic programming.
+test_files: []
+