stat.h File Reference

---

Detailed Description

Definitions for functions that perform common statistical operations on Scythe Matrix objects.

Note:

As is the case throughout the library, we provide both general and default template definitions of the Matrix-returning functions in this file, explicitly providing documentation for only the general template versions.

#include "scythestat/matrix.h"
#include "scythestat/algorithm.h"
#include "scythestat/error.h"
#include <numeric>
#include <set>

Include dependency graph for stat.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	scythe
Defines
#define	SCYTHE_STATMETH_COL(NAME)
Functions
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::sum (const Matrix< T, PO, PS > &A)
	Calculate the sum of a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::sumc (const Matrix< T, PO, PS > &A)
	Calculate the sum of each column in a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::sumc (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::prod (const Matrix< T, PO, PS > &A)
	Calculate the product of a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::prodc (const Matrix< T, PO, PS > &A)
	Calculate the product of each column of a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::prodc (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::mean (const Matrix< T, PO, PS > &A)
	Calculate the mean of a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::meanc (const Matrix< T, PO, PS > &A)
	Calculate the mean of each column of a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::meanc (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::median (const Matrix< T, PO, PS > &A)
	Calculate the median of a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::medianc (const Matrix< T, PO, PS > &A)
	Calculate the median of each column a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::medianc (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::mode (const Matrix< T, PO, PS > &A)
	Calculate the mode of a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::modec (const Matrix< T, PO, PS > &A)
	Calculate the mode of the columns of a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::modec (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::var (const Matrix< T, PO, PS > &A)
	Calculate the variance of a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::varc (const Matrix< T, PO, PS > &A)
	Calculate the variance of each column of a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::varc (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::var (const Matrix< T, PO, PS > &A, T mu)
	Calculate the variance of a Matrix.
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::sd (const Matrix< T, PO, PS > &A)
	Calculate the standard deviation of a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::sdc (const Matrix< T, PO, PS > &A)
	Calculate the standard deviation of each column of a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::sdc (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::sd (const Matrix< T, PO, PS > &A, T mu)
	Calculate the standard deviation of a Matrix.
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::skew (const Matrix< T, PO, PS > &A)
	Calculate the skew of a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::skewc (const Matrix< T, PO, PS > &A)
	Calculate the skew of each column of a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::skewc (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::kurtosis (const Matrix< T, PO, PS > &A)
	Calculate the kurtosis of a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::kurtosisc (const Matrix< T, PO, PS > &A)
	Calculate the kurtosis of each column of a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::kurtosisc (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::max (const Matrix< T, PO, PS > &A)
	Calculate the maximum element in a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::maxc (const Matrix< T, PO, PS > &A)
	Calculate the maximum of each column of a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::maxc (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
T	scythe::min (const Matrix< T, PO, PS > &A)
	Calculate the maximum element in a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::minc (const Matrix< T, PO, PS > &A)
	Calculate the minimum of each column of a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::minc (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
unsigned int	scythe::maxind (const Matrix< T, PO, PS > &A)
	Calculate the index of the maximum element in a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::maxindc (const Matrix< T, PO, PS > &A)
	Calculate the index of the maximum for each column of a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::maxindc (const Matrix< T, O, S > &A)
template<typename T, matrix_order PO, matrix_style PS>
unsigned int	scythe::minind (const Matrix< T, PO, PS > &A)
	Calculate the index of the minimum element in a Matrix.
template<matrix_order RO, matrix_style RS, typename T, matrix_order PO, matrix_style PS>
Matrix< T, RO, RS >	scythe::minindc (const Matrix< T, PO, PS > &A)
	Calculate the index of the minimum for each column of a Matrix.
template<typename T, matrix_order O, matrix_style S>
Matrix< T, O, Concrete >	scythe::minindc (const Matrix< T, O, S > &A)
Variables
T	constant_
T2	divisor_
T	exponent_

---