001    /*
002     * Copyright (C) 2008-2010 by Holger Arndt
003     *
004     * This file is part of the Universal Java Matrix Package (UJMP).
005     * See the NOTICE file distributed with this work for additional
006     * information regarding copyright ownership and licensing.
007     *
008     * UJMP is free software; you can redistribute it and/or modify
009     * it under the terms of the GNU Lesser General Public License as
010     * published by the Free Software Foundation; either version 2
011     * of the License, or (at your option) any later version.
012     *
013     * UJMP is distributed in the hope that it will be useful,
014     * but WITHOUT ANY WARRANTY; without even the implied warranty of
015     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
016     * GNU Lesser General Public License for more details.
017     *
018     * You should have received a copy of the GNU Lesser General Public
019     * License along with UJMP; if not, write to the
020     * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
021     * Boston, MA  02110-1301  USA
022     */
023    
024    package org.ujmp.core.doublematrix.calculation.general.statistical;
025    
026    import org.ujmp.core.Matrix;
027    import org.ujmp.core.doublematrix.calculation.AbstractDoubleCalculation;
028    import org.ujmp.core.exceptions.MatrixException;
029    import org.ujmp.core.util.MathUtil;
030    
031    public class Corrcoef extends AbstractDoubleCalculation {
032            private static final long serialVersionUID = 879653499852789474L;
033    
034            private Matrix mean = null;
035    
036            private boolean ignoreNaN = false;
037    
038            public Corrcoef(boolean ignoreNaN, Matrix matrix) {
039                    super(matrix);
040                    this.ignoreNaN = ignoreNaN;
041            }
042    
043            
044            public double getDouble(long... coordinates) throws MatrixException {
045                    double sumSqX = 0.0;
046                    double sumSqY = 0.0;
047                    double sumProd = 0.0;
048                    double deltaX = 0.0;
049                    double deltaY = 0.0;
050                    long rows = getSource().getRowCount();
051                    long N = 0;
052    
053                    if (ignoreNaN && coordinates[ROW] == coordinates[COLUMN]) {
054                            return 1.0;
055                    }
056    
057                    if (mean == null) {
058                            mean = new Mean(ROW, ignoreNaN, getSource()).calc(Ret.NEW);
059                    }
060    
061                    if (ignoreNaN) {
062    
063                            for (int i = 0; i < rows; i++) {
064                                    deltaX = getSource().getAsDouble(i, coordinates[ROW])
065                                                    - mean.getAsDouble(0, coordinates[ROW]);
066                                    deltaY = getSource().getAsDouble(i, coordinates[COLUMN])
067                                                    - mean.getAsDouble(0, coordinates[COLUMN]);
068    
069                                    if (!MathUtil.isNaNOrInfinite(deltaX) && !MathUtil.isNaNOrInfinite(deltaY)) {
070                                            N++;
071                                            sumSqX += deltaX * deltaX;
072                                            sumSqY += deltaY * deltaY;
073                                            sumProd += deltaX * deltaY;
074                                    }
075    
076                            }
077    
078                    } else {
079    
080                            N = rows;
081                            for (int i = 0; i < rows; i++) {
082                                    deltaX = getSource().getAsDouble(i, coordinates[ROW])
083                                                    - mean.getAsDouble(0, coordinates[ROW]);
084                                    deltaY = getSource().getAsDouble(i, coordinates[COLUMN])
085                                                    - mean.getAsDouble(0, coordinates[COLUMN]);
086                                    sumSqX += deltaX * deltaX;
087                                    sumSqY += deltaY * deltaY;
088                                    sumProd += deltaX * deltaY;
089                            }
090    
091                    }
092    
093                    double sdX = Math.sqrt(sumSqX / (N - 1));
094                    double sdY = Math.sqrt(sumSqY / (N - 1));
095                    double cov = sumProd / (N - 1);
096                    double corr = cov / (sdX * sdY);
097    
098                    return corr;
099            }
100    
101            
102            public long[] getSize() {
103                    return new long[] { getSource().getColumnCount(), getSource().getColumnCount() };
104            }
105    
106    }