cppannotations/yo/stl/chisquared.yo
Frank B. Brokken 8a2b5ca51e Ready for 8.3.0
git-svn-id: https://cppannotations.svn.sourceforge.net/svnroot/cppannotations/trunk@475 f6dd340e-d3f9-0310-b409-bdd246841980
2010-09-03 10:31:16 +00:00

34 lines
1.1 KiB
Text

The ti(chi_squared_distribution<RealType = double>) with tt(n) degrees of
freedom is the distribution of a sum of the squares of tt(n) independent
standard normal random variables.
The chi-squared distribution is used, e.g., when testing the goodness of fit
of an observed distribution to a theoretical one.
Defined types:
verb(
typedef RealType result_type;
struct param_type
{
explicit param_type(RealType n = RealType(1));
RealType n() const;
};
)
Constructor, members and example:
itemization(
itt(chi_squared_distribution(RealType n = 1))
constructs a chi_squared distribution with specified number of degrees
of freedom.
itt(chi_squared_distribution(param_type const &param))
constructs a chi_squared distribution according to the value stored in
the tt(param) struct;
itt(IntType n() const)nl()
returns the distribution's degrees of freedom;
itt(result_type min() const)nl()
returns 0;
itt(result_type max() const)nl()
returns the maximum value of tt(result_type);
)