random_variable 1.2.1 → 1.2.2

data/lib/ext/gen.c

@@ -15,37 +15,56 @@
 
 #include <ruby.h>
 
+/* The Ruby "Random" class */
 extern VALUE rb_cRandom;
 
-/* the random number generator */
+/* the random number generator (instance) */
 static VALUE rb_RandGen = Qnil;
 
+/* For returning a random number at the C level */
 #define GET_RB_RANF	rb_funcall(rb_RandGen, rb_intern("rand"), 0)
 double ranf(void)
 {
 	return NUM2DBL(GET_RB_RANF);
 }
 
+/* For returning a random number at the Ruby level */
 VALUE rb_ranf(void)
 {
 	return GET_RB_RANF;
 }
 #undef GET_RB_RANF
 
+/******************************************************************************/
+/* Functions at C level	*/
+/******************************************************************************/
+
+/* get the current seed */
 VALUE rv_gen_get_seed(void)
 {
 	return rb_funcall(rb_RandGen, rb_intern("seed"), 0);
 }
 
+/* set the current seed */
 void rv_gen_set_seed(VALUE rb_seed)
 {
+	/* memory leak?! */
 	rb_RandGen = rb_funcall(rb_cRandom, rb_intern("new"), 1, rb_seed);
 }
 
-/* Must be called before any kind ranf() call */
-void rv_init_gen(void)
+VALUE rv_gen_new_seed(void)
 {
 	rb_RandGen = rb_funcall(rb_cRandom, rb_intern("new"), 0);
+	return rv_gen_get_seed();
+}
+/******************************************************************************/
+
+
+/* Must be called BEFORE any kind ranf() call !! */
+void rv_init_gen(void)
+{
+	/* create an instance of the random generator */
+	rv_gen_new_seed();
 
 	/* tell the GC not to collect the random generator */
 	rb_gc_register_address(&rb_RandGen);

data/lib/ext/gen.h

@@ -21,6 +21,7 @@
 
 void rv_init_gen(void);
 double ranf(void);
+VALUE rv_gen_new_seed(void);
 void rv_gen_set_seed(VALUE);
 VALUE rv_gen_get_seed(void);
 

data/lib/ext/random_variable.c

@@ -768,6 +768,14 @@ VALUE rb_outcomes(VALUE rb_obj, VALUE rb_nr_times)
 }
 #undef GET_DATA
 
+/******************************************************************************/
+/* set and geet the seed at Ruby level */
+/******************************************************************************/
+static VALUE rb_seed_new(VALUE self)
+{
+	return rv_gen_new_seed();		
+}
+
 static VALUE rb_seed_get(VALUE self)
 {
 	return rv_gen_get_seed();
@@ -778,6 +786,8 @@ static VALUE rb_seed_set(VALUE self, VALUE rb_seed)
 	rv_gen_set_seed(rb_seed);
 	return rb_seed;
 }
+/******************************************************************************/
+
 
 /******************************************************************************/
 /* macros for the extension entry point */
@@ -818,6 +828,7 @@ void Init_random_variable(void)
 
 	/* Generator */
 	rb_mGenerator = rb_define_module_under(rb_mRandomVariable, "Generator");
+	rb_define_singleton_method(rb_mGenerator, "new_seed", rb_seed_new, 0);
 	rb_define_singleton_method(rb_mGenerator, "seed", rb_seed_get, 0);
 	rb_define_singleton_method(rb_mGenerator, "seed=", rb_seed_set, 1);
 

data/lib/random_variable.rb

@@ -35,6 +35,13 @@ require_relative 'ext/random_variable'
 require_relative 'sampleable'
 
 module RandomVariable 
+	# obtain and set an arbitrary new seed 
+	#
+	# @return [Numeric] the new seed
+	def self.new_seed
+		Generator::new_seed
+	end
+
 	# obtain the current seed in use
 	#
 	# @return [Numeric] the current seed

data/lib/test.rb

@@ -0,0 +1,21 @@
+################################################################################
+#                                                                              #
+# File:     test.rb                                                            #
+#                                                                              #
+################################################################################
+#                                                                              #
+# Author:   Jorge F.M. Rinaldi                                                 #
+# Contact:  jorge.madronal.rinaldi@gmail.com                                   #
+#                                                                              #
+################################################################################
+#                                                                              #
+# Date:     2012/12/22                                                         #
+#                                                                              #
+################################################################################
+
+require 'random_variable'
+
+module RandomVariable::Tests
+end
+
+require_relative 'tests/poisson.rb'

data/lib/tests/common.rb

@@ -0,0 +1,27 @@
+################################################################################
+#                                                                              #
+# File:     common.rb                                                          #
+#                                                                              #
+################################################################################
+#                                                                              #
+# Author:   Jorge F.M. Rinaldi                                                 #
+# Contact:  jorge.madronal.rinaldi@gmail.com                                   #
+#                                                                              #
+################################################################################
+#                                                                              #
+# Date:     2012/12/22                                                         #
+#                                                                              #
+################################################################################
+
+# Attemps to require the gem denoted by +name+, otherwise it displays an
+# error message and exits
+def required_gem(name)
+	begin
+		require name
+	rescue LoadError # 'rescue' only rescues StandardError without args
+		abort("Gem '#{name}' required in order to work properly, " +
+			"please install the required gem and try again.\n" +
+			"\tThe installation is usually done as follows:\n" +
+			"\t\tgem install #{name}");
+	end
+end

data/lib/tests/poisson.rb

@@ -0,0 +1,87 @@
+################################################################################
+#                                                                              #
+# File:     poisson.rb                                                         #
+#                                                                              #
+################################################################################
+#                                                                              #
+# Author:   Jorge F.M. Rinaldi                                                 #
+# Contact:  jorge.madronal.rinaldi@gmail.com                                   #
+#                                                                              #
+################################################################################
+#                                                                              #
+# Date:     2012/12/22                                                         #
+#                                                                              #
+################################################################################
+
+require_relative 'common.rb'
+
+require 'test/unit'
+
+required_gem 'shoulda'
+required_gem 'random_variable'
+
+class RandomVariable::Tests::Poisson < Test::Unit::TestCase
+	include RandomVariable
+
+	should "fail instantiating with no parameter" do
+		assert_raise(ArgumentError) { Poisson.new }	
+	end
+
+	should "fail instantiating with a NaN parameter" do
+		assert_raise(ArgumentError) { Poisson.new(0.0/0) }
+		assert_raise(ArgumentError) { Poisson.new(0/0.0) }
+	end
+
+	should "fail instantiating with a Infinty parameter" do
+		assert_raise(ArgumentError) { Poisson.new(0.0/1) }
+		assert_raise(ArgumentError) { Poisson.new(-0.0/1) }
+	
+		huge_number = 2**1024
+		assert_raise(ArgumentError) { Poisson.new(huge_number) }
+	end
+
+	should "fail instantiating with a negative parameter" do
+		assert_raise(ArgumentError) { Poisson.new(-0.0001) }
+		assert_raise(ArgumentError) { Poisson.new(-1) }
+		assert_raise(ArgumentError) { Poisson.new(-113) }
+		assert_raise(ArgumentError) { Poisson.new(-10_000) }
+	end
+
+	should "fail instantiating with zero as the parameter" do
+		assert_raise(ArgumentError) { Poisson.new(0) }
+		assert_raise(ArgumentError) { Poisson.new(-0) }
+		assert_raise(ArgumentError) { Poisson.new(0.0) }
+		assert_raise(ArgumentError) { Poisson.new(-0.0) }
+	end
+
+	should "instantiate with a valid parameter" do
+		Poisson.new 0.001
+		Poisson.new 0.1
+		Poisson.new 1
+		Poisson.new 100
+		Poisson.new 10_000
+	end
+
+	should "provide greater or equal to zero outcomes" do
+		[0.001, 0.1, 1, 100, 10_000, 10_000_000].each do |param|
+			x = Poisson.new param
+			samples = x.outcomes 100_000
+			samples.each do |sample|
+				assert(sample >= 0)
+			end
+		end	
+	end
+
+	should "reproduce the same outcomes for the same seed value" do
+		seed = RandomVariable::new_seed
+		x = Poisson.new 113
+		samples = x.outcomes 10
+		RandomVariable::seed = seed
+		new_samples = x.outcomes 10
+		samples.length.times do |i|
+			puts "#{samples[i]} ?= #{new_samples[i]}"
+			assert_equal(samples[i], new_samples[i])
+		end	
+	end	
+	
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: random_variable
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000 Z
+date: 2012-12-23 00:00:00.000000000 Z
 dependencies: []
 description: ! 'random variables for a wide variety of probability distributions such
   as: Binomial, Beta, Chi-Squared, Normal, Pareto, Poisson, etc.'
@@ -26,6 +26,9 @@ files:
 - lib/distros.rb
 - LICENSE
 - COPYING
+- lib/test.rb
+- lib/tests/common.rb
+- lib/tests/poisson.rb
 - lib/ext/random_variable.c
 - lib/ext/gen.c
 - lib/ext/gen.h