random_variable 1.0.0 → 1.0.1

data/lib/distros.rb

@@ -0,0 +1,96 @@
+################################################################################
+#                                                                              #
+# File:     distros.rb                                                         #
+#                                                                              #
+################################################################################
+#                                                                              #
+# Author:   Jorge F.M. Rinaldi                                                 #
+# Contact:  jorge.madronal.rinaldi@gmail.com                                   #
+#                                                                              #
+################################################################################
+#                                                                              #
+# Date:     2012/11/28                                                         #
+#                                                                              #
+################################################################################
+
+module RandomVariable
+	class Bernoulli
+		# create a new <i>Bernoulli Random Variable</i> with 
+		# parameter +p+
+		def self.new(p)
+			intern_new(p)
+		end
+	end
+
+	class Beta
+		# create a new <i>Beta Random Variable</i> with parameters 
+		# +alpha+ and +beta+
+		def self.new(alpha, beta)
+			intern_new(alpha, beta)
+		end
+	end
+
+	class Binomial
+		# create a new <i>Binomial Random Variable</i> with parameters 
+		# +n+ and +p+
+		def self.new(n, p)
+			intern_new(n, p)
+		end
+	end
+
+	class ContinuousUniform
+		# create a new <i>Continuous Uniform Random Variable</i> with 
+		# parameters +a+ and +b+
+		def self.new(a, b)
+			intern_new(a, b)
+		end	
+	end
+
+	class DiscreteUniform
+		# create a new <i>Discrete Uniform Random Variable</i> with 
+		# parameters +a+ and +b+
+		def self.new(a, b)
+			intern_new(a, b)
+		end
+	end
+
+	class Exponential
+		# create a new <i>Exponential Random Variable</i> with a mean of
+		# +mean+
+		def self.new(mean)
+			intern_new(mean)
+		end
+	end
+
+	class F
+		# create a new <i>F Random Variable</i> with parameters 
+		# +d1+ and +d2+
+		def self.new(d1, d2)
+			intern_new(d1, d2)
+		end
+	end
+
+	class Normal
+		# create a new <i>Normal Random Variable</i> with parameters
+		# +mu+ and +sigma+
+		def self.new(mu = 0.0, sigma = 1.0)
+			intern_new(mu, sigma)
+		end
+	end
+
+	class Poisson
+		# create a new <i>Poisson Random Variable</i> with a mean of
+		# +mean+
+		def self.new(mean)
+			intern_new(mean)
+		end
+	end
+
+	class Rayleigh	
+		# create a new <i>Rayleigh Random Variable</i> with parameter
+		# +sigma+
+		def self.new(sigma)
+			intern_new(sigma)
+		end
+	end
+end

data/lib/ext/random_variable.c

@@ -97,10 +97,10 @@ typedef struct {
 		struct { long n; double p; } binomial;
 		struct { double a,b; } continuous_uniform;
 		struct { long a,b; } discrete_uniform;
-		struct { double lambda; } exponential;
+		struct { double mean; } exponential;
 		struct { double d1, d2; } f;
 		struct { double mu, sigma; } normal;
-		struct { double lambda; } poisson;
+		struct { double mean; } poisson;
 		struct { double sigma; } rayleigh;
 	} RANDVAR_DATA;	/* union */
 } randvar_t;
@@ -177,8 +177,8 @@ CREATE_RANDVAR_OUTCOME_FUNC2(discrete_uniform, ignuin, long, a, b)
 CREATE_RANDVAR_RB_OUTCOME(discrete_uniform, LONG2NUM)
 /* exponential */
 RV_NR_PARAMS(exponential, 1)
-CREATE_RANDVAR_ACCESSOR(exponential, lambda, double)
-CREATE_RANDVAR_OUTCOME_FUNC1(exponential, gen_exponential , double, lambda)
+CREATE_RANDVAR_ACCESSOR(exponential, mean, double)
+CREATE_RANDVAR_OUTCOME_FUNC1(exponential, genexp , double, mean)
 CREATE_RANDVAR_RB_OUTCOME(exponential, DBL2NUM)
 /* f */
 RV_NR_PARAMS(f, 2)
@@ -194,8 +194,8 @@ CREATE_RANDVAR_OUTCOME_FUNC2(normal, gennor, double, mu, sigma)
 CREATE_RANDVAR_RB_OUTCOME(normal, DBL2NUM)
 /* poisson */
 RV_NR_PARAMS(poisson, 1)
-CREATE_RANDVAR_ACCESSOR(poisson,lambda, double)
-CREATE_RANDVAR_OUTCOME_FUNC1(poisson, ignpoi, long, lambda)
+CREATE_RANDVAR_ACCESSOR(poisson, mean, double)
+CREATE_RANDVAR_OUTCOME_FUNC1(poisson, ignpoi, long, mean)
 CREATE_RANDVAR_RB_OUTCOME(poisson, LONG2NUM)
 /* rayleigh */
 RV_NR_PARAMS(rayleigh, 1)
@@ -423,20 +423,20 @@ VALUE rb_create_instance(VALUE rb_obj, ...)
 		CASE_END
 
 		CASE(exponential)
-			VALUE rb_lambda;
-			double lambda;
+			VALUE rb_mean;
+			double mean;
 
 			SET_KLASS(exponential);
 
-			rb_lambda = GET_NEXT_ARG(ap);
-			lambda = NUM2DBL(rb_lambda);
+			rb_mean = GET_NEXT_ARG(ap);
+			mean = NUM2DBL(rb_mean);
 
-			/* lambda > 0 */
-			CHECK_POSITIVE(lambda);
+			/* mean > 0 */
+			CHECK_POSITIVE(mean);
 
-			/* lambda parameter correct */
+			/* mean parameter correct */
 			RANDVAR_INIT(exponential);
-			SET_PARAM(exponential, lambda);
+			SET_PARAM(exponential, mean);
 		CASE_END
 
 		CASE(f)
@@ -483,19 +483,19 @@ VALUE rb_create_instance(VALUE rb_obj, ...)
 		CASE_END		
 
 		CASE(poisson)
-			VALUE rb_lambda;
-			double lambda;
+			VALUE rb_mean;
+			double mean;
 			
 			SET_KLASS(poisson);
 
-			rb_lambda = GET_NEXT_ARG(ap);
-			lambda = NUM2DBL(rb_lambda); 
-			/* lambda > 0 */
-			CHECK_POSITIVE(lambda);
+			rb_mean = GET_NEXT_ARG(ap);
+			mean = NUM2DBL(rb_mean); 
+			/* mean > 0 */
+			CHECK_POSITIVE(mean);;
 			
-			/* lambda parameter correct */
+			/* mean parameter correct */
 			RANDVAR_INIT(poisson);
-			SET_PARAM(poisson, lambda);
+			SET_PARAM(poisson, mean);;
 		CASE_END
 	
 		CASE(rayleigh)
@@ -584,17 +584,25 @@ VALUE rb_outcomes(VALUE rb_obj, VALUE rb_nr_times)
 /******************************************************************************/
 #define CREATE_RANDOM_VARIABLE_CLASS(rb_name, name)			\
 	do {								\
-		VALUE *rb_objp = &rb_cRandomVariables[rv_type_ ##name]; \
+		VALUE *rb_objp;						\
+		VALUE rb_metaclass;					\
+									\
+		rb_objp = &rb_cRandomVariables[rv_type_ ##name]; 	\
 									\
 		*rb_objp = rb_define_class_under(rb_mRandomVariable,	\
 			rb_name, rb_cRandomVariables[rv_type_generic]);	\
 									\
-		rb_define_singleton_method(*rb_objp, "new", 		\
+		rb_metaclass = rb_singleton_class(*rb_objp);		\
+									\
+		rb_define_private_method(rb_metaclass, "intern_new", 	\
 			(VALUE (*) (ANYARGS)) rb_create_instance,	\
 			rv_ ##name ##_nr_params);			\
 									\
 		rb_define_method(*rb_objp, "outcome" , rb_outcome,  0);	\
+		rb_define_alias(*rb_objp, "sample", "outcome");		\
+									\
 		rb_define_method(*rb_objp, "outcomes", rb_outcomes, 1);	\
+		rb_define_alias(*rb_objp, "samples", "outcomes");	\
 		outcome_func[rv_type_ ##name] = 			\
 				randvar_ ##name ##_rb_outcome;		\
 	} while (0)

data/lib/ext/xrandlib.c

@@ -47,11 +47,6 @@ int gen_bernoulli(double p)
 	return 1;
 }
 
-double gen_exponential(double lambda)
-{
-	return genexp(1.0 / lambda);
-}
-
 /* Rayleigh */
 double gen_rayleigh(double sigma)
 {

data/lib/random_variable.rb

@@ -68,22 +68,29 @@ module RandomVariable
 		end
 	end
 
+	# obtain a single outcome from the random variable
 	def outcome
 		@blk.call
 	end
+	alias :sample :outcome
 
-	def outcomes(times)
+	# obtain +number+ outcomes from the random variable
+	def outcomes(number)
 		ary = []
-		times.times do
+		number.times do
 			ary << @blk.call
 		end
 		ary	
 	end
+	alias :samples :outcomes
 	
 
 end
 end
 
+require_relative 'distros.rb'
+
+=begin
 module Math
 
 	functions = [:acos, :acosh, :asin, :asinh, :atan, :atanh, :cbrt,
@@ -105,5 +112,6 @@ module Math
 	end
 
 end
+=end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: random_variable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies: []
 description: Create and operate with random variables in Ruby
 email: jorge.madronal.rinaldi@gmail.com
@@ -20,9 +20,9 @@ extra_rdoc_files: []
 files:
 - lib/random_variable.rb
 - lib/ext/extconf.rb
+- lib/distros.rb
 - LICENSE
 - COPYING
-- lib/test.rb
 - lib/ext/random_variable.c
 - lib/ext/randlib.c
 - lib/ext/randlib.h
@@ -30,7 +30,6 @@ files:
 - lib/ext/xrandlib.h
 - lib/ext/linpack.c
 - lib/ext/com.c
-- lib/test/test_poisson_rv.rb
 homepage: http://mrinaldi.net/random_variable
 licenses:
 - GPLv3
@@ -43,7 +42,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/test/test_poisson_rv.rb

@@ -1,48 +0,0 @@
-################################################################################
-#                                                                              #
-# File:     test_poisson_rv.rb                                                 #
-#                                                                              #
-################################################################################
-#                                                                              #
-# Author:   Jorge F.M. Rinaldi                                                 #
-# Contact:  jorge.madronal.rinaldi@gmail.com                                   #
-#                                                                              #
-################################################################################
-#                                                                              #
-# Date:     2012/10/27                                                         #
-#                                                                              #
-################################################################################
-
-class TestPoissonRV < Test::Unit::TestCase
-	def test_no_parameter
-		assert_raise(ArgumentError) { PoissonRV.new }
-	end
-
-	def test_infinite_parameter
-		assert_raise(ArgumentError) { PoissonRV.new(113.0 / 0) }
-		x = 2**65536
-		assert_raise(ArgumentError) { PoissonRV.new(x) }
-	end
-	
-	def test_nan_parameter
-		assert_raise(ArgumentError) { PoissonRV.new(0.0 / 0) }
-	end
-
-	def test_invalid_finite_paramter
-		assert_raise(ArgumentError) { PoissonRV.new(-7) }
-		assert_raise(ArgumentError) { PoissonRV.new(-0.0000001) }
-		assert_raise(ArgumentError) { PoissonRV.new(0) }
-		lambda_param = 2 * PoissonRV.lambda_max 
-		assert_raise(ArgumentError) { PoissonRV.new(lambda_param) }
-		
-	end
-
-	def test_max_lambda_produces_good_results
-		lambda_max = PoissonRV.lambda_max
-		x = PoissonRV.new(lambda_max)
-		outcomes = x.outcomes(10_000_000)
-		outcomes.each do |e|
-			assert(e > 0)
-		end
-	end
-end

data/lib/test.rb

@@ -1,9 +0,0 @@
-# whole project
-require 'random_variable'
-
-# gems for testing
-require 'test/unit'
-
-# unary tests...
-require 'test/test_poisson_rv'
-require 'test/test_rayleigh_rv'