パッケージ org.opengion.penguin.math.statistics

## クラス HybsCorrelation

- java.lang.Object
- - org.opengion.penguin.math.statistics.HybsCorrelation

-     public class HybsCorrelation
      extends java.lang.Object

  apache.commons.mathを利用した相関計算及びその周辺機能を利用するためのクラスです。 とりあえず通常のピアソン積率相関のみを利用可能としておきます。

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタ | 説明
    --- | ---
    `HybsCorrelation​(double[][] matrix)` | 相関係数行列を指定したコンストラクタ。
    `HybsCorrelation​(java.lang.String[] name, double[][] matrix)` | 名称と、データマトリクスを指定するコンストラクタ。

  - ### メソッドの概要

    すべてのメソッド staticメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッド | 説明
    --- | --- | ---
    `double[][]` | `getCorrMatrix()` | 相関値行列取得。
    `double[]` | `getCorrMatrixCol​(int col)` | 指定列の相関値配列取得。
    `double[]` | `getCorrMatrixRow​(int row)` | 指定行の相関値配列取得。
    `java.lang.String[]` | `getNames()` | 名称配列の取得。
    `static void` | `main​(java.lang.String[] args)` | ここからテスト用mainメソッド 。
    `double[][]` | `multiply​(double[][] data)` | コンストラクタで算出した相関値行列に対して与えた行列を掛け算します。
    `void` | `setNames​(java.lang.String[] name)` | 名称配列のセット。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### HybsCorrelation

          public HybsCorrelation​(java.lang.String[] name,
                                 double[][] matrix)

      名称と、データマトリクスを指定するコンストラクタ。 与えたデータマトリクスを元にピアソン積率相関を計算します。 名称 = { "数学" , "英語", "国語" } データ = { { 90 ,60 ,70 }, {70, 90, 80 } } のような形としてデータを与えます。
      パラメータ:
        `name` - 名称
        `matrix` - データマトリクス

    - #### HybsCorrelation

          public HybsCorrelation​(double[][] matrix)

      相関係数行列を指定したコンストラクタ。 計算後の相関係数行列をdouble[][]型で直接与えられるようにしておきます。 以前に計算した行列を使って行列の積を算出する場合に利用します。
      パラメータ:
        `matrix` - 相関係数行列

  - ### メソッドの詳細

    - #### multiply

          public double[][] multiply​(double[][] data)

      コンストラクタで算出した相関値行列に対して与えた行列を掛け算します。 例えば以下のような算出を行う事が可能です。 各商品を何回購入したかというデータを人数分用意し、相関係数行列を作成し、 　それに対してある人の今まで購入した履歴を掛け算する事で相関の高い商品を導出します。 　つまり、購入した事のないもので有意な相関係数を持つものは購入可能性が高いと言えます。
      パラメータ:
        `data` - 掛け算する行列
      戻り値:
        行列積の結果マトリクス

    - #### getCorrMatrix

          public double[][] getCorrMatrix()

      相関値行列取得。
      戻り値:
        相関マトリクス

    - #### getCorrMatrixRow

          public double[] getCorrMatrixRow​(int row)

      指定行の相関値配列取得。
      パラメータ:
        `row` - ROW番号
      戻り値:
        行方向の相関ベクトル

    - #### getCorrMatrixCol

          public double[] getCorrMatrixCol​(int col)

      指定列の相関値配列取得。
      パラメータ:
        `col` - COL番号
      戻り値:
        列方向の相関ベクトル

    - #### getNames

          public java.lang.String[] getNames()

      名称配列の取得。
      戻り値:
        名称配列

    - #### setNames

          public void setNames​(java.lang.String[] name)

      名称配列のセット。
      パラメータ:
        `name` - 名称配列

    - #### main

          public static void main​(java.lang.String[] args)

      ここからテスト用mainメソッド 。
      パラメータ:
        `args` - 引数