num4tststatistic2 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 985be5e18949d9700b7a090374a2b2f85ec1caa6551f9659e11156e8d3a02f21
-  data.tar.gz: 860c8e0145f0c045ef2fab8fe7bc84cbf3365ad026e6ccebcee3f092d9996048
+  metadata.gz: 60785711542acd092cb1688f03e95bb31b372dab71e52048ec6adec7fcc2bcf5
+  data.tar.gz: fc3dd84abfa51c591061cde8e4ebad3e56985dbb0ae30928f8456a2488aa9c42
 SHA512:
-  metadata.gz: 3b39c6635a935546f966682151337005a240d53b8869190022b13a550cbfd5f06b04ba3d4202438a406258ba6d44f169fe9a0c336416cd2bf8e409bd7023f903
-  data.tar.gz: 4cb404897944e4aa2ed7a608b292316ce4f2ce38c0771116890f4e025908fddfb4908885f59c3368ca30201138fd6a846fe8afc2c0130f5285589d8da6d18e04
+  metadata.gz: bccb6876cf7adb09a192dd34faf6fbd4f29652974e1cced0ae49bde5e30ce19c9c9a171db5744e2cd4128a3bbaf2a9d56c43720825693348c056bfe84b81e68b
+  data.tar.gz: 1f8c945bc94f924990b7451d809ed883c0e7dee6ab4b25ab1c08c822314d7a4c9e1a4ba5d8f0c749369efd319e579aedc83d3cd7c1abaa37dc54ea2acf69c9b3

data/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 ## Unreleased
 
-## [0.0.1] - 2023-11-11
+## [0.1.1] - 2024-05-06
+
+### add
+- add function of diffPopulationMean2.
+- add CorreFact.
+
+## [0.0.2] - 2024-04-22
+
+### add
+- add version in Gemfile.
+- add raise function.
+
+## [0.0.1] - 2024-04-20
 
 ### Fixed
 - fix first fixed.

data/Gemfile

@@ -1,7 +1,8 @@
 source "https://rubygems.org"
 
 platforms :jruby do
-    gem "num4tststatistic"
-    gem "num4hypothtst"   
+    gem "rake-compiler",    ">= 1.2.5"
+    gem "num4tststatistic", ">= 0.2.2"
+    gem "num4hypothtst"   , ">= 0.1.1"
 end
 

data/lib/decorrtest.rb

@@ -0,0 +1,22 @@
+class DecorrTestIF
+    def pearsoCorrelation(x, y, a)
+        raise NotImplementedError.new("#{self.class}##{__method__} が実装されていません")
+    end
+    def spearmanscorr(x, y, a)
+        raise NotImplementedError.new("#{self.class}##{__method__} が実装されていません")
+    end
+    def kendallscorr(x, y, a)
+        raise NotImplementedError.new("#{self.class}##{__method__} が実装されていません")
+    end
+end
+class CorreFactIF
+    def pearsoCorrelation(x, y, rth0, a)
+        raise NotImplementedError.new("#{self.class}##{__method__} が実装されていません")
+    end
+    def spearmanscorr(x, y, rth0, a)
+        raise NotImplementedError.new("#{self.class}##{__method__} が実装されていません")
+    end
+    def kendallscorr(x, y, rth0, a)
+        raise NotImplementedError.new("#{self.class}##{__method__} が実装されていません")
+    end
+end

data/lib/num4tststatistic2.rb

@@ -1,8 +1,10 @@
 require 'num4tststatistic'
 require 'hypothTest3'
+require_relative('decorrtest')
 
 # 統計的仮説検定
 module Num4TstStatistic2Lib
+    # パラメトリック検定
     class ParametrixTestLib
         def initialize(hypothTest3)
             @hypothTest3 = hypothTest3
@@ -16,12 +18,14 @@ module Num4TstStatistic2Lib
         #   @param  [double] a  有意水準
         #   @return [boolean] 検定結果(true:棄却域内 false:棄却域外)
         # @example
-        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
         #   xi = [15.5, 15.7, 15.4, 15.4, 15.6, 15.4, 15.6, 15.5, 15.4]
-        #   paraTest = Num4TstStatisticLib::ParametrixTestLib.new(hypothTest)
+        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
+        #   paraTest = Num4TstStatistic2Lib::ParametrixTestLib.new(hypothTest)
         #   paraTest.populationMean(xi, 15.4, 0.05)
         #   => true
         def populationMean(xi, m0, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             df = xi.size - 1
             statistic = @paraTest.populationMean(xi, m0)
             return @hypothTest3.tDistTest(statistic, df, a)
@@ -41,11 +45,13 @@ module Num4TstStatistic2Lib
         #   paraTest.populationVar(xi, sd*sd, 0.05)
         #   => true
         def populationVar(xi, sig0, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             df = xi.size - 1
             statistic = @paraTest.populationVar(xi, sig0)
             return @hypothTest3.chi2DistTest(statistic, df, a)
         end
-        # 母比率の検定量
+        # 母比率の検定
         #
         # @overload populationRatio(m, n, p0, a)
         #   @param [int]     m m値
@@ -59,11 +65,34 @@ module Num4TstStatistic2Lib
         #   paraTest.populationRatio(29, 346, 0.12, 0.05)
         #   => true
         def populationRatio(m, n, p0, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             statistic = @paraTest.populationRatio(m, n, p0)
             return @hypothTest3.normDistTest(statistic, a)
         end
-        # 2つの母平均の差の検定量
-        # (等分散性を仮定)
+        # 2つの母平均の差の検定
+        #
+        # @overload diffPopulationMean2(xi1, xi2, a)
+        #   @param [Array] xi1 x1のデータ(double[])
+        #   @param [Array] xi2 x2のデータ(double[])
+        #   @param  [double] a  有意水準
+        #   @return [boolean] 検定結果(true:棄却域内 false:棄却域外)
+        # @example
+        #   xi1 = [165, 130, 182, 178, 194, 206, 160, 122, 212, 165, 247, 195]
+        #   xi2 = [180, 180, 235, 270, 240, 285, 164, 152]
+        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
+        #   paraTest = Num4TstStatistic2Lib::ParametrixTestLib.new(hypothTest)
+        #   paraTest.diffPopulationMean2(xi1, xi2, 0.05)
+        #   => false
+        def diffPopulationMean2(xi1, xi2, a)
+            bRet = diffPopulationVar(xi1, xi2, a)
+            if bRet == true # 等分散ではない
+                return diffPopulationMean2UnEquVar(xi1, xi2, a)
+            else            # 等分散性
+                return diffPopulationMean2EquVar(xi1, xi2, a)
+            end
+        end
+        # 2つの母平均の差の検定(等分散性を仮定)
         #
         # @overload diffPopulationMean2EquVar(xi1, xi2, a)
         #   @param [Array] xi1 x1のデータ(double[])
@@ -78,14 +107,15 @@ module Num4TstStatistic2Lib
         #   paraTest.diffPopulationMean2EquVar(xi1, xi2, 0.05)
         #   => false
         def diffPopulationMean2EquVar(xi1, xi2, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             n1 = xi1.size
             n2 = xi2.size
             df = n1 + n2 - 2
             statistic = @paraTest.diffPopulationMean2EquVar(xi1, xi2)
             return @hypothTest3.tDistTest(statistic, df, a)
         end
-        # 2つの母平均の差の検定量
-        # (不等分散性を仮定)
+        # 2つの母平均の差の検定(不等分散性を仮定)
         #
         # @overload diffPopulationMean2UnEquVar(xi1, xi2, a)
         #   @param [Array] xi1 x1のデータ(double[])
@@ -100,6 +130,8 @@ module Num4TstStatistic2Lib
         #   paraTest.diffPopulationMean2UnEquVar(xi1, xi2, 0.05)
         #   => false
         def diffPopulationMean2UnEquVar(xi1, xi2, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             df = @paraTest.df4welch(xi1, xi2)
             statistic = @paraTest.diffPopulationMean2UnEquVar(xi1, xi2)
             return @hypothTest3.tDistTest(statistic, df, a)
@@ -119,12 +151,14 @@ module Num4TstStatistic2Lib
         #   paraTest.diffPopulationMean(xi1, xi2, 0.05)
         #   => true
         def diffPopulationMean(xi1, xi2, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             n = xi1.size
             df = n - 1
             statistic = @paraTest.diffPopulationMean(xi1, xi2)
             return @hypothTest3.tDistTest(statistic, df, a)
         end
-        # 2つの母分散の差の検定量
+        # 2つの母分散の差の検定
         #
         # @overload diffPopulationVar(xi1, xi2, a)
         #   @param [Array] xi1 x1のデータ(double[])
@@ -139,12 +173,14 @@ module Num4TstStatistic2Lib
         #   paraTest.diffPopulationVar(xi1, xi2, 0.05)
         #   => false
         def diffPopulationVar(xi1, xi2, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             nf = xi1.size - 1
             df = xi2.size - 1
             statistic = @paraTest.diffPopulationVar(xi1, xi2)
             return @hypothTest3.fDistTest(statistic, nf, df, a)
         end
-        # 2つの母比率の差の検定量
+        # 2つの母比率の差の検定
         #
         # @overload diffPopulationRatio(m1, n1, m2, n2, a)
         #   @param [int] m1 m1値
@@ -159,10 +195,12 @@ module Num4TstStatistic2Lib
         #   paraTest.diffPopulationRatio(469, 1200, 308, 900, 0.05)
         #   => true
         def diffPopulationRatio(m1, n1, m2, n2, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             statistic = @paraTest.diffPopulationRatio(m1, n1, m2, n2)
             return @hypothTest3.normDistTest(statistic, a)
         end
-        # 適合度の検定量
+        # 適合度の検定
         #
         # @overload fidelity(fi, pi, a)
         #   @param [Array] fi 実測度数(double[])
@@ -177,11 +215,13 @@ module Num4TstStatistic2Lib
         #   paraTest.fidelity(fi, pi, 0.05)
         #   => false
         def fidelity(fi, pi, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             df = fi.size - 1
             statistic = @paraTest.fidelity(fi, pi)
             return @hypothTest3.chi2DistTest(statistic, df, a)
         end
-        # 独立性の検定量
+        # 独立性の検定
         #
         # @overload independency(fij, a)
         #   @param [Array] fij 実測度数(double[][])
@@ -197,6 +237,8 @@ module Num4TstStatistic2Lib
         #   paraTest.independency(fij, 0.05)
         #   => true
         def independency(fij, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             m = fij.size
             n = fij[0].size
             df = (m - 1) * (n - 1)
@@ -204,6 +246,7 @@ module Num4TstStatistic2Lib
             return @hypothTest3.chi2DistTest(statistic, df, a)
         end
     end
+    # ノンパラメトリック検定
     class NonParametrixTestLib
         def initialize(hypothTest3)
             @hypothTest3 = hypothTest3
@@ -217,13 +260,15 @@ module Num4TstStatistic2Lib
         #   @param  [double] a  有意水準
         #   @return [boolean] 検定結果(true:棄却域内 false:棄却域外)
         # @example
-        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
         #   x = [165, 130, 182, 178, 194, 206, 160, 122, 212, 165, 247, 195]
         #   y = [180, 180, 235, 270, 240, 285, 164, 152]
+        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
         #   nonParaTest = Num4TstStatistic2Lib::NonParametrixTestLib.new(hypothTest)
         #   nonParaTest.utest(x, y, 0.05)
         #   => true
         def utest(x, y, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             statistic = @nonParaTest.utest(x, y)
             return @hypothTest3.normDistTest(statistic, a)
         end
@@ -235,13 +280,15 @@ module Num4TstStatistic2Lib
         #   @param  [double] a  有意水準
         #   @return [boolean] 検定結果(true:棄却域内 false:棄却域外)
         # @example
-        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
         #   x = [37.1, 36.2, 36.6, 37.4, 36.8, 36.7, 36.9, 37.4, 36.6, 36.7]
         #   y = [36.8, 36.6, 36.5, 37.0, 36.0, 36.5, 36.6, 37.1, 36.4, 36.7]
+        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
         #   nonParaTest = Num4TstStatistic2Lib::NonParametrixTestLib.new(hypothTest)
         #   nonParaTest.wilcoxon(x, y, 0.05)
         #   => true
         def wilcoxon(x, y, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             statistic = @nonParaTest.wilcoxon(x, y)
             return @hypothTest3.normDistTest(statistic, a)
         end
@@ -253,22 +300,25 @@ module Num4TstStatistic2Lib
         #   @param [double] a         有意水準
         #   @return [boolean] 検定結果(true:棄却域内 false:棄却域外)
         # @example
-        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
         #   xi1 = [165, 130, 182, 178, 194, 206, 160, 122, 212, 165, 247, 195]
         #   xi2 = [180, 180, 235, 270, 240, 285, 164, 152]
-        #   nonParaTest = Num4TstStatisticLib::NonParametrixTestLib.new(hypothTest)
+        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
+        #   nonParaTest = Num4TstStatistic2Lib::NonParametrixTestLib.new(hypothTest)
         #   nonParaTest.ks2test(xi1, xi2, 0.05)
         #   => false
         def ks2test(xi1, xi2, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+
             return @nonParaTest.ks2test(xi1, xi2, a)
         end
     end
+    # 外れ値検定
     class OutlierLib
         def initialize
             @outlier = Num4TstStatisticLib::OutlierLib.new
             @hypothTest2 = Num4HypothTestLib::GrubbsTestLib.new
         end
-        # グラプス・スミルノフの外れ値の検定量
+        # グラプス・スミルノフの外れ値の検定
         #
         # @overload grubbs(xi, xk, a)
         #   @param [Array] xi xiのデータ(double[])
@@ -276,7 +326,7 @@ module Num4TstStatistic2Lib
         #   @return [double] 検定統計量
         # @example
         #   xi = [3.4, 3.5, 3.3, 2.2, 3.3, 3.4, 3.6, 3.2]
-        #   outlier = Num4TstStatisticLib::OutlierLib.new
+        #   outlier = Num4TstStatistic2Lib::OutlierLib.new
         #   outlier.grubbs(xi, 2.2, 0.05)
         #   => true
         def grubbs(xi, xk, a)
@@ -292,22 +342,24 @@ module Num4TstStatistic2Lib
         #   @return [void]  errbar.jpegファイルを出力
         # @example
         #   xi = [3.4, 3.5, 3.3, 2.2, 3.3, 3.4, 3.6, 3.2]
-        #   outlier = Num4TstStatisticLib::OutlierLib.new
+        #   outlier = Num4TstStatistic2Lib::OutlierLib.new
         #   outlier.grubbs("LDH", xi)
         #   => errbar.jpeg
         def errbar(dname, xi)
             @outlier.errbar(dname, xi)
         end
     end
+end
+# 相関検定
+module DecorrTestLib
     # 無相関の検定
-    class DecorrTestLib
+    class UnDecorrTestLib < DecorrTestIF
         def initialize
             @paraTest = Num4TstStatisticLib::ParametrixTestLib.new
             @nonParaTest = Num4TstStatisticLib::NonParametrixTestLib.new
             @hypothTest = Num4HypothTestLib::DecorrTestLib.new
         end
         # ピアソン相関係数
-        #  (相関係数の検定)
         #
         # @overload pearsoCorrelation(x, y, a)
         #   @param [Array] x xのデータ(double[])
@@ -317,8 +369,8 @@ module Num4TstStatistic2Lib
         # @example
         #   x = [113, 64, 16, 45, 28, 19, 30, 82, 76]
         #   y = [31, 5, 2, 17, 18, 2, 9, 25, 13]
-        #   paraTest = Num4TstStatistic2Lib::DecorrTestLib.new
-        #   paraTest.pearsoCorrelation(x, y, 0.05)
+        #   decorrTest = DecorrTestLib::UnDecorrTestLib.new
+        #   decorrTest.pearsoCorrelation(x, y, 0.05)
         #   => true
         def pearsoCorrelation(x, y, a)
             df = x.size - 2
@@ -335,8 +387,8 @@ module Num4TstStatistic2Lib
         # @example
         #   x = [113, 64, 16, 45, 28, 19, 30, 82, 76]
         #   y = [31, 5, 2, 17, 18, 2, 9, 25, 13]
-        #   paraTest = Num4TstStatistic2Lib::DecorrTestLib.new
-        #   paraTest.spearmanscorr(x, y, 0.05)
+        #   decorrTest = DecorrTestLib::UnDecorrTestLib.new
+        #   decorrTest.spearmanscorr(x, y, 0.05)
         #   => true
         def spearmanscorr(x, y, a)
             df = x.size - 2
@@ -353,8 +405,8 @@ module Num4TstStatistic2Lib
         # @example
         #   x = [113, 64, 16, 45, 28, 19, 30, 82, 76]
         #   y = [31, 5, 2, 17, 18, 2, 9, 25, 13]
-        #   paraTest = Num4TstStatistic2Lib::DecorrTestLib.new
-        #   paraTest.kendallscorr(x, y, 0.05)
+        #   decorrTest = DecorrTestLib::UnDecorrTestLib.new
+        #   decorrTest.kendallscorr(x, y, 0.05)
         #   => false
         def kendallscorr(x, y, a)
             df = x.size - 2
@@ -362,5 +414,72 @@ module Num4TstStatistic2Lib
             return @hypothTest.twoSideTest(statistic, df, a)
         end
     end
+    # 相関係数の検定
+    class CorreFactLib < CorreFactIF
+        def initialize(hypothTest3)
+            @hypothTest3 = hypothTest3
+            @paraTest = Num4TstStatisticLib::ParametrixTestLib.new
+            @nonParaTest = Num4TstStatisticLib::NonParametrixTestLib.new
+        end
+        # ピアソン相関係数
+        #
+        # @overload pearsoCorrelation(x, y, rth0, a)
+        #   @param [Array] x xのデータ(double[])
+        #   @param [Array] y yのデータ(double[])
+        #   @param [double] rth0 母相関係数
+        #   @param  [double] a  有意水準
+        #   @return [boolean] 検定結果(true:棄却域内 false:棄却域外)
+        # @example
+        #   x = [113, 64, 16, 45, 28, 19, 30, 82, 76]
+        #   y = [31, 5, 2, 17, 18, 2, 9, 25, 13]
+        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
+        #   decorrTest = DecorrTestLib::CorreFactLib.new(hypothTest)
+        #   decorrTest.pearsoCorrelation(x, y,  -0.3, 0.05)
+        #   => true
+        def pearsoCorrelation(x, y, rth0, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+            statistic = @paraTest.pearsoCorrelation(x, y)
+            return @hypothTest3.populationCorre(statistic, x.size, rth0, a)
+        end
+        # スピアマンの順位相関係数
+        #
+        # @overload spearmanscorr(x, y, rth0, a)
+        #   @param [Array] x xのデータ(double[])
+        #   @param [Array] y yのデータ(double[])
+        #   @param [double] rth0 母相関係数
+        #   @param  [double] a  有意水準
+        #   @return [boolean] 検定結果(true:棄却域内 false:棄却域外)
+        # @example
+        #   x = [113, 64, 16, 45, 28, 19, 30, 82, 76]
+        #   y = [31, 5, 2, 17, 18, 2, 9, 25, 13]
+        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
+        #   decorrTest = DecorrTestLib::CorreFactLib.new(hypothTest)
+        #   decorrTest.spearmanscorr(x, y, -0.3, 0.05)
+        #   => true
+        def spearmanscorr(x, y, rth0, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+            statistic = @nonParaTest.spearmanscorr(x, y)
+            return @hypothTest3.populationCorre(statistic, x.size, rth0, a)
+        end
+        # ケンドールの順位相関係数
+        #
+        # @overload kendallscorr(x, y, rth0, a)
+        #   @param [Array] x xのデータ(double[])
+        #   @param [Array] y yのデータ(double[])
+        #   @param [double] rth0 母相関係数
+        #   @param  [double] a  有意水準
+        #   @return [boolean] 検定結果(true:棄却域内 false:棄却域外)
+        # @example
+        #   x = [113, 64, 16, 45, 28, 19, 30, 82, 76]
+        #   y = [31, 5, 2, 17, 18, 2, 9, 25, 13]
+        #   hypothTest = Num4HypothTestLib::TwoSideTestLib.new
+        #   decorrTest = DecorrTestLib::CorreFactLib.new(hypothTest)
+        #   decorrTest.kendallscorr(x, y, -0.3, 0.05)
+        #   => true
+        def kendallscorr(x, y, rth0, a)
+            raise TypeError unless @hypothTest3.kind_of?(HypothTest3IF)
+            statistic = @nonParaTest.kendallscorr(x, y)
+            return @hypothTest3.populationCorre(statistic, x.size, rth0, a)
+        end
+    end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: num4tststatistic2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - siranovel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-20 00:00:00.000000000 Z
+date: 2024-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: num4tststatistic
@@ -59,8 +59,9 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
+- lib/decorrtest.rb
 - lib/num4tststatistic2.rb
-homepage: http://github.com/siranovel/num4tststatistic2
+homepage: https://github.com/siranovel/num4tststatistic2
 licenses:
 - MIT
 metadata: {}