theplu::yat::statistics::PearsonCorrelation Class Reference

Class for calculating Pearson correlation. More...

#include </scratch/bob/jari/tmp/pristine/yat-0.10.x/yat/statistics/PearsonCorrelation.h>

List of all members.

Public Member Functions
	PearsonCorrelation (void)
	The default constructor.
virtual	~PearsonCorrelation (void)
	The destructor.
void	add (double value, bool target, double weight=1.0)
double	score (void) const
	correlation

Related Functions
(Note that these are not member functions.)
double	p_value_one_sided () const

---

Detailed Description

Class for calculating Pearson correlation.

---

Member Function Documentation

void theplu::yat::statistics::PearsonCorrelation::add	(	double	value,
		bool	target,
		double	weight = 1.0
	)

Adding a data value to PearsonCorrelation.

double theplu::yat::statistics::PearsonCorrelation::score

(

void

)

const

correlation

Correlation is calculated as implemented in AveragerPairWeighted

Returns:

Pearson correlation.

---

Friends And Related Function Documentation

double p_value_one_sided ( ) const

related

The p-value is the probability of getting a correlation as large (or larger) as the observed value by random chance, when the true correlation is zero (and the data is Gaussian).

P-value is calculated using function pearson_p_value(double, unsigned int) where degrees of freedom is calculated using n(void) in AveragerPairWeighted.

Returns:

one-sided p-value

---

The documentation for this class was generated from the following file:

• /scratch/bob/jari/tmp/pristine/yat-0.10.x/yat/statistics/PearsonCorrelation.h