/*
 * Copyright (c) 2009 The openGion Project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.opengion.penguin.math.statistics;

import org.apache.commons.math3.linear.MatrixUtils;
import org.apache.commons.math3.linear.RealMatrix;
import org.apache.commons.math3.stat.correlation.PearsonsCorrelation;

/**
 * apache.commons.mathを利用した相関計算及びその周辺機能を利用するためのクラスです。
 *
 * とりあえず通常のピアソン積率相関のみを利用可能としておきます。
 *
 */
// 8.5.5.1 (2024/02/29) spotbugs CT_CONSTRUCTOR_THROW(ｺﾝｽﾄﾗｸﾀで、Excweptionを出さない) class を final にすれば、警告は消える。
// public class HybsCorrelation {
public final class HybsCorrelation {
        private String[]        names;
        final private RealMatrix        corrMatrix;

        /**
         * 名称と、データマトリクスを指定するコンストラクタ。
         * 与えたデータマトリクスを元にピアソン積率相関を計算します。
         * 名称 = { "数学" , "英語", "国語" }
         * データ = { { 90 ,60 ,70 }, {70, 90, 80 } }
         * のような形としてデータを与えます。
         *
         * @param name          名称
         * @param matrix        データマトリクス
         */
        public HybsCorrelation( final String[] name, final double[][] matrix ) {
                // 一応元データをセットしておく
                this.names = name;

                // ここで相関係数行列を作成してしまう
                corrMatrix = new PearsonsCorrelation().computeCorrelationMatrix( matrix );              // 6.9.7.0 (2018/05/14) PMD Useless parentheses.
        }

        /**
         * 相関係数行列を指定したコンストラクタ。
         * 計算後の相関係数行列をdouble[][]型で直接与えられるようにしておきます。
         * 以前に計算した行列を使って行列の積を算出する場合に利用します。
         *
         * @param matrix 相関係数行列
         */
        public HybsCorrelation( final double[][] matrix ) {
                corrMatrix = MatrixUtils.createRealMatrix( matrix );
        }

        /**
         * コンストラクタで算出した相関値行列に対して与えた行列を掛け算します。
         * 例えば以下のような算出を行う事が可能です。
         * 各商品を何回購入したかというデータを人数分用意し、相関係数行列を作成し、
         * 　それに対してある人の今まで購入した履歴を掛け算する事で相関の高い商品を導出します。
         * 　つまり、購入した事のないもので有意な相関係数を持つものは購入可能性が高いと言えます。
         *
         * @param data 掛け算する行列
         * @return 行列積の結果マトリクス
         */
        public double[][] multiply( final double[][] data ) {
                final RealMatrix dataMatrix = MatrixUtils.createRealMatrix( data );
            final RealMatrix scores = dataMatrix.multiply( corrMatrix );

                return scores.getData();
        }

        /**
         * 相関値行列取得。
         *
         * @return 相関マトリクス
         */
        public double[][] getCorrMatrix() {
                return corrMatrix.getData();
        }

        /**
         * 指定行の相関値配列取得。
         *
         * @param row ROW番号
         * @return 行方向の相関ベクトル
         */
        public double[] getCorrMatrixRow( final int row ) {
                return corrMatrix.getRow( row );
        }

        /**
         * 指定列の相関値配列取得。
         *
         * @param col COL番号
         * @return 列方向の相関ベクトル
         */
        public double[] getCorrMatrixCol( final int col ) {
                return corrMatrix.getColumn( col );
        }

        /**
         * 名称配列の取得。
         *
         * @return 名称配列
         */
        public String[] getNames() {
                return names;
        }

        /**
         * 名称配列のセット。
         *
         * @param name 名称配列
         */
        public void setNames( final String[] name ) {
                this.names = name;
        }

        // ここまでが本体

        /** ここからテスト用mainメソッド 。
         *
         * @param args 引数
         */
        public static void main( final String [] args ) {
                final String[] name = {"A", "B", "C", "D","E"};
                final double[][] data = {
                        {3, 1, 0, 0 , 1},
                        {1, 0, 0, 0 , 1},
                        {0, 0, 2, 2 , 2},
                        {2, 2, 1, 0 , 0},
                        {1, 0, 2, 4 , 1},
                };

                final HybsCorrelation rtn = new HybsCorrelation( name,data );

                for( int i = 0; i< rtn.getCorrMatrix().length; i++ ) {
                        System.out.println( java.util.Arrays.toString( rtn.getCorrMatrix()[i] ) );
                }

                // オススメ度計算
                System.out.println( java.util.Arrays.toString(rtn.multiply( new double[][] {{0, 1, 0, 0 , 0}} ) [0] ) );
        }
}