normal_distribution 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcab113574f1fccfbfdb5652468461ffc009a5f6
-  data.tar.gz: 877e57cd9026fcad6049d06b3a5824ccadd6314b
+  metadata.gz: e57048774793d77b8c736134cfe7a6f966c25e31
+  data.tar.gz: 69366dc447c98ecf257c02e5e4ee93dc9fa67540
 SHA512:
-  metadata.gz: a702d3cf3623a7b75e64804ce481abacec2d7d202a5b9fcd8a445cddb4a23227d18dc98ba338683954d80158fe69a2f1b13447b891e88dc410ca73483aa85a61
-  data.tar.gz: e8f18576f23f92172678618ed42a1b782816dd13587fedea8a2f32cc428c8350b427e95421ae24062fb65c3baa9d771ea73dd6700dd83ba28adaef28de5d2864
+  metadata.gz: 2731bf134df4c0c4e86ebfd8ece0d5877005523a133aac6e21c6ca94fb071d8be8b4a7443b5c2c84974fcc195cfdb656228892adc4dd8213f7fcbed1bc5acb45
+  data.tar.gz: 33acb859a3e228c8c041e40e4244a7ee052e9d81e836197f43c35af72560a05d759205c8b7195ba1ecb6352b64b083b7923b6c711565e3d93824c89f6bed8410

data/ext/normal_distribution/confidence_interval.c

@@ -0,0 +1,41 @@
+#include "confidence_interval.h"
+
+static VALUE t_init( VALUE self, VALUE lower_bound, VALUE upper_bound ) {
+	double lower = NUM2DBL( lower_bound );
+	double upper = NUM2DBL( upper_bound );
+
+	if ( lower > upper ) {
+		rb_raise( rb_eArgError, "lower bound must not be greater then upper bound" );
+	}
+
+	rb_iv_set( self, "@lower_bound", lower_bound );
+	rb_iv_set( self, "@upper_bound", upper_bound );
+
+	return self;
+}
+
+static VALUE t_attr_get_upper_bound( VALUE self ) {
+	return rb_iv_get( self, "@upper_bound" );
+}
+
+static VALUE t_attr_get_lower_bound( VALUE self ) {
+	return rb_iv_get( self, "@lower_bound" );
+}
+
+static VALUE t_include( VALUE self, VALUE value ) {
+	double lower = NUM2DBL( rb_iv_get( self, "@lower_bound" ) );
+	double upper = NUM2DBL( rb_iv_get( self, "@upper_bound" ) );
+	double v = NUM2DBL( value );
+
+	return v < lower || v > upper ? Qfalse : Qtrue;
+}
+
+void Init_confidence_interval( void ) {
+	VALUE rb_mNormalDistribution = rb_path2class( "NormalDistribution" );
+	VALUE rb_cConfidenceInterval = rb_define_class_under( rb_mNormalDistribution, "ConfidenceInterval", rb_cObject );
+
+	rb_define_method( rb_cConfidenceInterval, "initialize", t_init, 2 );
+	rb_define_method( rb_cConfidenceInterval, "lower_bound", t_attr_get_lower_bound, 0 );
+	rb_define_method( rb_cConfidenceInterval, "upper_bound", t_attr_get_upper_bound, 0 );
+	rb_define_method( rb_cConfidenceInterval, "include?", t_include, 1 );
+}

data/ext/normal_distribution/confidence_interval.h

@@ -0,0 +1,8 @@
+#ifndef NORMAL_DISTRIBUTION_CONFIDENCE_INTERVAL_H
+#define NORMAL_DISTRIBUTION_CONFIDENCE_INTERVAL_H
+
+#include "ruby.h"
+
+void Init_confidence_interval( void );
+
+#endif //NORMAL_DISTRIBUTION_CONFIDENCE_INTERVAL_H

data/ext/normal_distribution/erf_inv.h

@@ -7,6 +7,6 @@
 
 #include <math.h>
 
-long double t_erf_inv(long double x);
+long double t_erf_inv( long double x );
 
 #endif //NORMAL_DISTRIBUTION_ERF_INV_H

data/ext/normal_distribution/model.c

@@ -0,0 +1,111 @@
+#include "model.h"
+
+static double t_parse_percentage( VALUE percentage ) {
+	double perc = NUM2DBL( percentage );
+
+	if ( perc > 100 || perc < 0 ) {
+		rb_raise( rb_eArgError, "percentage must be between 0 and 100" );
+	}
+
+	return perc;
+}
+
+static double t_mean( double * data, long size ) {
+	double sum = .0;
+
+	for ( long i = 0 ; i < size ; ++ i ) {
+		sum += data[i];
+	}
+
+	return sum / size;
+}
+
+static double t_z_score( double percentage ) {
+	return sqrt( 2 ) * t_erf_inv( percentage / 100 );
+}
+
+static double t_variance( double * data, long size, double mean ) {
+	double * squared_diff = ALLOC_N( double, size );
+
+	for ( long i = 0 ; i < size ; ++ i ) {
+		squared_diff[i] = pow( mean - data[i], 2 );
+	}
+
+	double variance = t_mean( squared_diff, size );
+	free( squared_diff );
+
+	return variance;
+}
+
+static double t_stddev( double * data, long size, double mean ) {
+	return sqrt( t_variance( data, size, mean ) );
+}
+
+static double * t_parse_dbl_ary( VALUE ary, long * size ) {
+	Check_Type( ary, T_ARRAY );
+	long len = RARRAY_LEN( ary );
+
+	if ( len == 0 ) {
+		rb_raise( rb_eArgError, "data must not be empty" );
+	}
+
+	VALUE * values = RARRAY_PTR( ary );
+	double * d_data = ALLOC_N( double, len );
+
+	for ( int i = 0 ; i < len ; ++ i ) {
+		d_data[i] = NUM2DBL( values[i] );
+	}
+
+	*size = len;
+
+	return d_data;
+}
+
+static VALUE t_init( VALUE self, VALUE values ) {
+	long size;
+	double * data = t_parse_dbl_ary( values, &size );
+	double mean = t_mean( data, size );
+	double stddev = t_stddev( data, size, mean );
+
+	rb_iv_set( self, "@mean", rb_float_new( mean ) );
+	rb_iv_set( self, "@standard_deviation", rb_float_new( stddev ) );
+	xfree( data );
+
+	return self;
+}
+
+static VALUE t_confidence_interval( VALUE self, VALUE percentage ) {
+	double perc = t_parse_percentage( percentage );
+	double z = t_z_score( perc );
+	double stddev = NUM2DBL( rb_iv_get( self, "@standard_deviation" ) );
+	double mean = NUM2DBL( rb_iv_get( self, "@mean" ) );
+	double lower_bound = - z * stddev + mean;
+	double upper_bound = z * stddev + mean;
+
+	VALUE rb_cConfidenceInterval = rb_path2class( "NormalDistribution::ConfidenceInterval" );
+	VALUE interval = rb_funcall(
+			rb_cConfidenceInterval, rb_intern( "new" ), 2,
+			rb_float_new( lower_bound ),
+			rb_float_new( upper_bound )
+	);
+
+	return interval;
+}
+
+static VALUE t_attr_mean( VALUE self ) {
+	return rb_iv_get( self, "@mean" );
+}
+
+static VALUE t_attr_stddev( VALUE self ) {
+	return rb_iv_get( self, "@standard_deviation" );
+}
+
+void Init_model( void ) {
+	VALUE rb_mNormalDistribution = rb_path2class( "NormalDistribution" );
+	VALUE rb_cModel = rb_define_class_under( rb_mNormalDistribution, "Model", rb_cObject );
+
+	rb_define_method( rb_cModel, "initialize", t_init, 1 );
+	rb_define_method( rb_cModel, "confidence_interval", t_confidence_interval, 1 );
+	rb_define_method( rb_cModel, "mean", t_attr_mean, 0 );
+	rb_define_method( rb_cModel, "standard_deviation", t_attr_stddev, 0 );
+}

data/ext/normal_distribution/model.h

@@ -0,0 +1,10 @@
+#ifndef NORMAL_DISTRIBUTION_MODEL_H
+#define NORMAL_DISTRIBUTION_MODEL_H
+
+#include "ruby.h"
+#include "erf_inv.h"
+#include "confidence_interval.h"
+
+void Init_model( void );
+
+#endif //NORMAL_DISTRIBUTION_MODEL_H

data/ext/normal_distribution/normal_distribution.c

@@ -1,108 +1,8 @@
 #include "normal_distribution.h"
 
-static double t_parse_percentage(VALUE percentage) {
-    double perc = NUM2DBL( percentage );
-
-    if (perc > 100 || perc < 0) {
-        rb_raise(rb_eArgError, "percentage must be between 0 and 100");
-    }
-
-    return perc;
-}
-
-static double t_mean( double * data, long size ) {
-	double sum = .0;
-
-	for ( long i = 0 ; i < size ; ++ i ) {
-		sum += data[i];
-	}
-
-	return sum / size;
-}
-
-static double t_z_score( double percentage ) {
-	return sqrt( 2 ) * t_erf_inv( percentage / 100 );
-}
-
-static double t_variance( double * data, long size, double mean ) {
-	double * squared_diff = ALLOC_N( double, size );
-
-	for ( long i = 0 ; i < size ; ++ i ) {
-		squared_diff[i] = pow( mean - data[i], 2 );
-	}
-
-	double variance = t_mean( squared_diff, size );
-	free( squared_diff );
-
-	return variance;
-}
-
-static double t_stddev( double * data, long size, double mean ) {
-	return sqrt( t_variance( data, size, mean ) );
-}
-
-static double * t_parse_dbl_ary( VALUE ary, long * size ) {
-    Check_Type(ary, T_ARRAY);
-	long len = RARRAY_LEN( ary );
-
-	if (len == 0) {
-	    rb_raise(rb_eArgError, "data must not be empty");
-	}
-
-	VALUE * values = RARRAY_PTR( ary );
-	double * d_data = ALLOC_N( double, len );
-
-	for ( int i = 0 ; i < len ; ++ i ) {
-		d_data[i] = NUM2DBL( values[i] );
-	}
-
-	*size = len;
-
-	return d_data;
-}
-
-static VALUE t_init( VALUE self, VALUE values ) {
-	long size;
-	double * data = t_parse_dbl_ary( values, &size );
-	double mean = t_mean( data, size );
-	double stddev = t_stddev( data, size, mean );
-
-	rb_iv_set( self, "@mean", rb_float_new( mean ) );
-	rb_iv_set( self, "@standard_deviation", rb_float_new( stddev ) );
-	free( data );
-
-	return self;
-}
-
-static VALUE t_confidence_interval( VALUE self, VALUE percentage ) {
-    double perc = t_parse_percentage( percentage );
-	double z = t_z_score( perc );
-	double stddev = NUM2DBL( rb_iv_get( self, "@standard_deviation" ) );
-	double mean = NUM2DBL( rb_iv_get( self, "@mean" ) );
-	double lower_bound = - z * stddev + mean;
-	double upper_bound = z * stddev + mean;
-
-	VALUE pair = rb_ary_new();
-	rb_ary_push( pair, rb_float_new( lower_bound ) );
-	rb_ary_push( pair, rb_float_new( upper_bound ) );
-
-	return pair;
-}
-
-static VALUE t_attr_mean( VALUE self ) {
-	return rb_iv_get( self, "@mean" );
-}
-
-static VALUE t_attr_stddev( VALUE self ) {
-	return rb_iv_get( self, "@standard_deviation" );
-}
-
 void Init_normal_distribution( void ) {
-	VALUE module = rb_define_module( "NormalDistribution" );
-	VALUE model = rb_define_class_under( module, "Model", rb_cObject );
+	rb_define_module( "NormalDistribution" );
 
-	rb_define_method( model, "initialize", t_init, 1 );
-	rb_define_method( model, "confidence_interval", t_confidence_interval, 1 );
-	rb_define_method( model, "mean", t_attr_mean, 0 );
-	rb_define_method( model, "standard_deviation", t_attr_stddev, 0 );
+	Init_confidence_interval();
+	Init_model();
 }

data/ext/normal_distribution/normal_distribution.h

@@ -1,10 +1,7 @@
 #ifndef NORMAL_DISTRIBUTION_H
-#define NORMAL_DISTRIBUTION_H 1
+#define NORMAL_DISTRIBUTION_H
 
-#include <stdio.h>
-#include <stdlib.h>
-#include <math.h>
-#include "ruby.h"
-#include "erf_inv.h"
+#include "model.h"
+#include "confidence_interval.h"
 
-#endif /* NORMAL_DISTRIBUTION_H */
+#endif //NORMAL_DISTRIBUTION_H

data/lib/normal_distribution/confidence_interval.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module NormalDistribution
+  # Confidence interval of normal distribution
+  #
+  # @since 0.2.0
+  class ConfidenceInterval
+    # @!parse [ruby]
+    #
+    #   # @return [Float] lower bound of confidence interval
+    #   attr_reader :lower_bound
+    #
+    #   # @return [Float] upper bound of confidence interval
+    #   attr_reader :upper_bound
+    #
+    #   # Initializes confidence interval
+    #   #
+    #   # @param lower_bound [Numeric] lower bound of confidence interval
+    #   # @param upper_bound [Numeric] upper bound of confidence interval
+    #   def initialize(lower_bound, upper_bound)
+    #      # This is stub used for indexing
+    #   end
+    #
+    #   # Decides, whether value is from the interval
+    #   #
+    #   # @param value [Numeric] value to be compared with interval bounds
+    #   # @return [Boolean] true if value is from the interval. Otherwise returns false.
+    #   def include?(value)
+    #      # This is stub used for indexing
+    #   end
+  end
+end

data/lib/normal_distribution/model.rb

@@ -20,10 +20,12 @@ module NormalDistribution
     #      # This is stub used for indexing
     #   end
     #
-    #   # Calculates confidence interval for given percentage
+    #   # Calculates confidence interval for given probability in percentage
     #   #
-    #   # @param percentage [Numeric] a number in interval <0, 100> representing probability
-    #   # @return [Array<Float>] an array containing 2 values, lower bound and upper_bound of confidence interval
+    #   # @param percentage [Numeric] a number in interval <0, 100> representing probability in percentage
+    #   # @return [ConfidenceInterval] an instance of ConfidenceInterval class
+    #   #
+    #   # @since 0.2.0
     #   def confidence_interval(percentage)
     #      # This is stub used for indexing
     #   end

data/lib/normal_distribution/version.rb

@@ -2,5 +2,5 @@
 
 module NormalDistribution
   # Current version of NormalDistribution gem
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: normal_distribution
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dominik Čermák
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2020-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,12 +104,17 @@ extensions:
 - ext/normal_distribution/extconf.rb
 extra_rdoc_files: []
 files:
+- ext/normal_distribution/confidence_interval.c
+- ext/normal_distribution/confidence_interval.h
 - ext/normal_distribution/erf_inv.c
 - ext/normal_distribution/erf_inv.h
 - ext/normal_distribution/extconf.rb
+- ext/normal_distribution/model.c
+- ext/normal_distribution/model.h
 - ext/normal_distribution/normal_distribution.c
 - ext/normal_distribution/normal_distribution.h
 - lib/normal_distribution.rb
+- lib/normal_distribution/confidence_interval.rb
 - lib/normal_distribution/model.rb
 - lib/normal_distribution/version.rb
 homepage: https://github.com/domcermak/normal_distribution