theplu::yat::statistics Namespace Reference

Statistical methods, classes, and functions. More...

Classes
class	AUC
	Class calculating Area Under ROC Curve. More...
struct	Average
	Functor to take average of a range. More...
class	Averager
	Class to calculate simple (first and second moments) averages. More...
struct	averager_traits
struct	theplu::yat::statistics::averager_traits< utility::unweighted_iterator_tag >
struct	theplu::yat::statistics::averager_traits< utility::weighted_iterator_tag >
struct	averager
struct	averager_pair
class	AveragerPair
	Class for taking care of mean and covariance of two variables. More...
class	AveragerPairWeighted
	Class for taking care of mean and covariance of two variables in a weighted manner. More...
class	AveragerWeighted
	Class to calulate averages with weights. More...
struct	EuclideanDistance
	Calculates the Euclidean distance between two points given by elements of ranges. More...
class	Fisher
	Fisher's exact test. More...
class	FoldChange
	Score given by the difference by the group means. More...
class	Histogram
	Histograms provide a convenient way of presenting the distribution of a set of data. More...
class	KolmogorovSmirnov
	Kolmogow Smirnov Test. More...
class	Pearson
	Class for calculating Pearson correlation. More...
class	PearsonCorrelation
	Class for calculating Pearson correlation. More...
struct	PearsonDistance
	Calculates the Pearson correlation distance between two points given by elements of ranges. More...
class	Percentiler
	Functor to calculate percentile of a range. More...
class	ROC
	Class for Reciever Operating Characteristic. More...
class	SAMScore
	Class for score used in Significance Analysis of Microarrays (SAM). More...
class	Score
	Interface Class for score classes. More...
class	Smoother
	Estimating a distribution in a smooth fashion. More...
class	SNRScore
	Class for score based on signal-to-noise ratio (SNRScore). More...
class	tScore
	Class for Fisher's t-test. More...
class	tTest
	Class for Student's t-test. More...
struct	VectorFunction
	Interface Class for vector functors. More...
struct	Max
	Larget element. More...
struct	Median
	Median element. More...
struct	Mean
	Mean element. More...
struct	Min
	Smallest element. More...
class	Nth_Element
class	WilcoxonFoldChange
	WilcoxonFoldChange. More...
Functions
template<typename Iter>
void	add (Averager &a, Iter first, Iter last)
	adding a range of values to Averager a
template<class Iter1, class Iter2>
void	add (AveragerPair &ap, Iter1 first1, Iter1 last1, Iter2 first2)
	adding data from two ranges to AveragerPair ap
template<class Iter1, class Iter2>
void	add (AveragerPairWeighted &ap, Iter1 first1, Iter1 last1, Iter2 first2)
	adding a ranges of values to AveragerPairWeighted ap
template<class Iter1, class Iter2, class Iter3, class Iter4>
void	add (AveragerPairWeighted &ap, Iter1 x, Iter1 xlast, Iter2 y, Iter3 wx, Iter4 wy)
	adding four ranges of values to AveragerPairWeighted ap
template<typename Iter>
void	add (AveragerWeighted &a, Iter first, Iter last)
	adding a range of values to AveragerWeighted a
template<typename Iter1, typename Iter2>
void	add (AveragerWeighted &a, Iter1 first1, Iter1 last1, Iter2 first2)
	add values from two ranges to AveragerWeighted a
template<typename ForwardIterator>
void	add (Histogram &h, ForwardIterator first, ForwardIterator last)
std::ostream &	operator<< (std::ostream &s, const Histogram &)
std::ostream &	operator<< (std::ostream &, const KolmogorovSmirnov &)
	output operator
template<typename ForwardIterator>
void	add (Smoother &h, ForwardIterator first, ForwardIterator last)
std::ostream &	operator<< (std::ostream &s, const Smoother &)
template<typename T, typename ForwardIterator>
void	add (T &o, ForwardIterator first, ForwardIterator last, const classifier::Target &target)
double	cdf_hypergeometric_P (unsigned int k, unsigned int n1, unsigned int n2, unsigned int t)
double	pearson_p_value (double r, unsigned int n)
	one-sided p-value
double	kurtosis (const utility::VectorBase &)
	Computes the kurtosis of the data in a vector.
template<class T>
double	mad (T first, T last, const bool sorted=false)
	Median absolute deviation from median.
template<class T>
double	median (T first, T last, const bool sorted=false)
template<class RandomAccessIterator>
double	percentile (RandomAccessIterator first, RandomAccessIterator last, double p, bool sorted=false) YAT_DEPRECATE
template<class RandomAccessIterator>
double	percentile2 (RandomAccessIterator first, RandomAccessIterator last, double p, bool sorted=false)
double	skewness (const utility::VectorBase &)
	Computes the skewness of the data in a vector.

---

Detailed Description

Statistical methods, classes, and functions.

All classes and functions related to statistical methods or functions are defined within this namespace. See Weighted Statistics
.

---

Function Documentation

template<typename T, typename ForwardIterator>

void theplu::yat::statistics::add	(	T &	o,
		ForwardIterator	first,
		ForwardIterator	last,
		const classifier::Target &	target
	)			[inline]

Adding a range [first, last) into an object of type T. The requirements for the type T is to have an add(double, bool, double) function.

template<typename ForwardIterator>

void theplu::yat::statistics::add	(	Smoother &	h,
		ForwardIterator	first,
		ForwardIterator	last
	)			[inline]

Add a range [first, last) of values to Smoother.

template<typename ForwardIterator>

void theplu::yat::statistics::add	(	Histogram &	h,
		ForwardIterator	first,
		ForwardIterator	last
	)			[inline]

Add a range [first, last) of values to Histogram.

template<typename Iter1, typename Iter2>

void theplu::yat::statistics::add	(	AveragerWeighted &	a,
		Iter1	first1,
		Iter1	last1,
		Iter2	first2
	)			[inline]

add values from two ranges to AveragerWeighted a

Add data from range [first1, last1) with their corresponding weight in range [first2, first2 + distance(first, last) ).

Requirement: Iter1 and Iter2 are unweighted iterators.

template<typename Iter>

void theplu::yat::statistics::add	(	AveragerWeighted &	a,
		Iter	first,
		Iter	last
	)			[inline]

adding a range of values to AveragerWeighted a

If iterator is non-weighted unitary weights are used.

double theplu::yat::statistics::cdf_hypergeometric_P	(	unsigned int	k,
		unsigned int	n1,
		unsigned int	n2,
		unsigned int	t
	)

Calculates the probability to get k or smaller from a hypergeometric distribution with parameters n1 n2 t. Hypergeomtric situation you get in the following situation: Let there be n1 ways for a "good" selection and n2 ways for a "bad" selection out of a total of possibilities. Take t samples without replacement and k of those are "good" samples. k will follow a hypergeomtric distribution.

Returns:

cumulative hypergeomtric distribution functions P(k).

double theplu::yat::statistics::kurtosis

(

const utility::VectorBase &

)

Computes the kurtosis of the data in a vector.

The kurtosis measures how sharply peaked a distribution is, relative to its width. The kurtosis is normalized to zero for a gaussian distribution.

template<class T>

double theplu::yat::statistics::mad	(	T	first,
		T	last,
		const bool	sorted = false
	)			[inline]

Median absolute deviation from median.

Function is non-mutable function

template<class T>

double theplu::yat::statistics::median	(	T	first,
		T	last,
		const bool	sorted = false
	)			[inline]

Median is defined to be value in the middle. If number of values is even median is the average of the two middle values. the median value is given by p equal to 50. If sorted is false (default), the range is copied, the copy is sorted, and then used to calculate the median.

Function is a non-mutable function, i.e., first and last can be const_iterators.

Requirements: T should either be unweighted with value type convertible to double or T should be weighted with value type convertible to utility::DataWeight

Returns:

median of range

std::ostream& theplu::yat::statistics::operator<<	(	std::ostream &	s,
		const Smoother &
	)

The Smoother output operator

std::ostream& theplu::yat::statistics::operator<<	(	std::ostream &	s,
		const Histogram &
	)

The Histogram output operator

double theplu::yat::statistics::pearson_p_value	(	double	r,
		unsigned int	n
	)

one-sided p-value

This function uses the t-distribution to calculate the one-sided p-value. Given that the true correlation is zero (Null hypothesis) the estimated correlation, r, after a transformation is t-distributed:

Returns:

Probability that correlation is larger than r by chance when having n samples. For r larger or equal to 1.0, 0.0 is returned. For r smaller or equal to -1.0, 1.0 is returned.

template<class RandomAccessIterator>

double theplu::yat::statistics::percentile	(	RandomAccessIterator	first,
		RandomAccessIterator	last,
		double	p,
		bool	sorted = false
	)			[inline]

The percentile is determined by the p, a number between 0 and 100. The percentile is found by interpolation, using the formula where p is floor and is .Thus the minimum value of the vector is given by p equal to zero, the maximum is given by p equal to 100 and the median value is given by p equal to 50. If sorted is false (default), the vector is copied, the copy is sorted, and then used to calculate the median.

Function is a non-mutable function, i.e., first and last can be const_iterators.

Requirements: RandomAccessIterator is an iterator over a range of doubles (or any type being convertable to double).

Returns:

p'th percentile of range

Deprecated:

percentile2 will replace this function in the future

Note:

the definition of percentile used here is not identical to that one used in percentile2 and Percentile. The difference is smaller for large ranges.

template<class RandomAccessIterator>

double theplu::yat::statistics::percentile2	(	RandomAccessIterator	first,
		RandomAccessIterator	last,
		double	p,
		bool	sorted = false
	)			[inline]

See also:

Percentiler

Since:

new in yat 0.5

double theplu::yat::statistics::skewness

(

const utility::VectorBase &

)

Computes the skewness of the data in a vector.

The skewness measures the asymmetry of the tails of a distribution.