stat_c 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd7506aea370251a6f91d5e6b6dd7dec6f8e6662
-  data.tar.gz: 17bc1d29da62b1a7308c054d832a089cc0ae4d2a
+  metadata.gz: d1b08af1cb1a9851bd0f686e5c07caaba4c54c7f
+  data.tar.gz: bb31ab302a6c65a1c52d6d24a1e244505f02a6ac
 SHA512:
-  metadata.gz: 07d8a9391e1c0c24bc8f52fd85019996e3fde773fb6e4c487d0656ce4b7d2039d117b1b424941c2fb405a21866c7fefc2c09465d2cb371235af43c1aa5c7528c
-  data.tar.gz: 6b374a44fa989f01c1c6369c6358b3255418325500a11ea80855226e147a796e338e05bf6d3399ec2a7cbc57fb75c44f3132c062a237f00be72451efc08b96ca
+  metadata.gz: 61cfacdfb80f683eb7731c56544ec2351ed951a612b916ec27f060055b2860ae26d1d62787e1f44ed7ee94a8c33844c7be6808967078c0773e725a1d281199b3
+  data.tar.gz: 7db9a53a35b78cc6e918d0d060697c78ea2a690394b83bfeb742f745fe0fbb93a2606469872e170a22ea7f5ef2256f79505d8d0178d2169855b90c04bcef033b

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 lib/stat_c/stat_c.bundle
+todo.md

data/README.md

@@ -4,6 +4,8 @@
 
 Fast, well documented C stats extension for Ruby.
 
+Pronounce it like "Statsie" and you will feel all warm and fuzzy inside!
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/ext/stat_c/stat_c.c

@@ -26,10 +26,14 @@ along with StatC.  If not, see <http://www.gnu.org/licenses/>.
 /* based on NIL_P in ruby.h */
 #define FALSE_P(v) !((VALUE)(v) != Qfalse)
 
-/* classes and modules */
+/* modules */
 VALUE sc_mStatC;
 VALUE sc_mArray;
 VALUE sc_mError;
+VALUE sc_mTest;
+VALUE sc_mT;
+
+/* classes */
 VALUE sc_eError;
 
 /* @private */
@@ -185,6 +189,112 @@ static VALUE sc_se(int argc, VALUE* argv, VALUE obj)
   return DBL2NUM(sd / sqrt(len));
 }
 
+/* Calculate Welch's t statistic
+
+@param mean1 [Numeric] mean of sample 1
+@param var1  [Numeric] sample variance of sample 1
+@param len1  [Numeric] size of sample 1
+@param mean2 [Numeric] mean of sample 2
+@param var2  [Numeric] sample variance of sample 2
+@param len1  [Numeric] size of sample 2
+
+@example Get Welch's t stat for two samples
+  StatC::Test::T.t_stat_welch(-0.1, 2.3, 5, 2.42, 1.282, 5).round(2) #=> -2.98
+
+@raise [StatC::Error::Error] if divide by zero error
+
+@return [Numeric] Welch's t statistic
+
+*/
+static VALUE
+sc_t_stat_welch(VALUE obj,
+                VALUE mean1, VALUE var1, VALUE len1,
+                VALUE mean2, VALUE var2, VALUE len2)
+{
+  double m1, v1, l1, m2, v2, l2, val;
+
+  m1 = NUM2DBL(mean1);
+  v1 = NUM2DBL(var1);
+  l1 = NUM2DBL(len1);
+
+  m2 = NUM2DBL(mean2);
+  v2 = NUM2DBL(var2);
+  l2 = NUM2DBL(len2);
+
+  if (l1 <= 0 || l2 <= 0) {
+    rb_raise(sc_eError, "Sample sizes must be > 0");
+  }
+
+  val = (v1 / l1) + (v2 / l2);
+
+  if (val == 0.0) {
+    rb_raise(sc_eError, "Divide by zero error");
+  }
+
+  return DBL2NUM((m1 - m2) / sqrt(val));
+}
+
+/* Calculate degrees of freedom for Welch's t statistic
+
+@note Uses non pooled variance
+
+@param var1  [Numeric] sample variance of sample 1
+@param len1  [Numeric] size of sample 1
+@param var2  [Numeric] sample variance of sample 2
+@param len1  [Numeric] size of sample 2
+
+@example Get dof for two samples
+  StatC::Test::T.dof_welch(2.3, 5, 1.282, 5).round(2) #=> 7.40
+
+@raise [StatC::Error::Error] if divide by zero error
+
+@return [Numeric] dof
+
+*/
+static VALUE
+sc_dof_welch(VALUE obj,
+             VALUE var1, VALUE len1,
+             VALUE var2, VALUE len2)
+{
+  double v1, l1, v2, l2, num, denom, val, d1, d2;
+
+  v1 = NUM2DBL(var1);
+  l1 = NUM2DBL(len1);
+
+  v2 = NUM2DBL(var2);
+  l2 = NUM2DBL(len2);
+
+  if (l1 <= 0 || l2 <= 0) {
+    rb_raise(sc_eError, "Sample sizes must be > 0");
+  }
+
+  num = pow( (v1 / l1) + (v2 / l2), 2);
+
+  d1 = pow(l1, 2) * (l1 - 1);
+  d2 = pow(l2, 2) * (l2 - 1);
+
+  if (d1 == 0|| d2 == 0) {
+    rb_raise(sc_eError, "Divide by zero error");
+  }
+
+  denom =
+    (pow(v1, 2) / d1) + (pow(v2, 2) / d2);
+
+  if (denom == 0) {
+    rb_raise(sc_eError, "Divide by zero error");
+  }
+
+  val = num / denom;
+
+  return DBL2NUM(val);
+
+}
+/*********************************************************************
+
+Initializers
+
+*********************************************************************/
+
 /* Document-module: StatC::Array
 
 Statistical methods operating on the values of an array
@@ -225,6 +335,30 @@ static void sc_init_eError(void)
   sc_eError = rb_define_class_under(sc_mError, "Error", rb_eStandardError);
 }
 
+/* Document-module: StatC::Test
+
+Module containing various statistical tests.
+
+*/
+static void sc_init_mTest(void)
+{
+  sc_mTest = rb_define_module_under(sc_mStatC, "Test");
+}
+
+
+/* Document-module: StatC::Test::T
+
+Module containing T test methods.
+
+*/
+static void sc_init_mT(void)
+{
+  sc_mT = rb_define_module_under(sc_mTest, "T");
+
+  rb_define_singleton_method(sc_mT, "t_stat_welch", sc_t_stat_welch, 6);
+  rb_define_singleton_method(sc_mT, "dof_welch", sc_dof_welch, 4);
+}
+
 /* Document-module: StatC
 
 C stats module for Ruby.
@@ -235,6 +369,10 @@ void Init_stat_c(void)
   sc_mStatC = rb_define_module("StatC");
 
   sc_init_mArray();
+
   sc_init_mError();
   sc_init_eError();
+
+  sc_init_mTest();
+  sc_init_mT();
 }

data/lib/stat_c/version.rb

@@ -1,4 +1,4 @@
 module StatC
   # module version number
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stat_c
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ryan Moore
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-04 00:00:00.000000000 Z
+date: 2016-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler