jidt/java/source/infodynamics/utils/ChiSquareMeasurementDistrib...

48 lines
1.6 KiB
Java
Executable File

/*
* Java Information Dynamics Toolkit (JIDT)
* Copyright (C) 2012, Joseph T. Lizier
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package infodynamics.utils;
/**
* Class to represent analytic distributions of info theoretic measurements under
* some null hypothesis of a relationship between the variables, where that
* distribution is a Chi Square distribution.
*
* @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
* <a href="http://lizier.me/joseph/">www</a>)
*/
public class ChiSquareMeasurementDistribution extends
AnalyticMeasurementDistribution {
/**
* Number of degrees of freedom for the distribution
*/
protected int degreesOfFreedom;
/**
* Construct the distribution
*
* @param actualValue actual observed value
* @param degreesOfFreedom degrees of freedom for the distribution
*/
public ChiSquareMeasurementDistribution(double actualValue, int degreesOfFreedom) {
super(actualValue, 1 - MathsUtils.chiSquareCdf(actualValue, degreesOfFreedom));
this.degreesOfFreedom = degreesOfFreedom;
}
}