ChiSquared Class Reference

#include <ChiSquared.h>

Public Member Functions
	ChiSquared (float value, float ndf)
float	degreesOfFreedom () const
float	lnProbability () const
float	probability () const
float	value () const

Private Attributes
float	theNDF
float	theValue

Detailed Description

Constructed with total chi-squared value value and number of degrees of freedom ndf.

Computes chi-squared upper tail probability, i.e. the probability that an observation, correctly described by a model with nrDOF, will give rise to a chi-squared larger than the one observed. From this, one can interpret this probability as how likely it is to observe as high (or higher) a chi-squared.

Also computes the natural logarithm of that probability, useful to compare very unlikely events, for which the probability is rounded off to 0.

Definition at line 19 of file ChiSquared.h.

Constructor & Destructor Documentation

ChiSquared()

ChiSquared::ChiSquared ( float  value, float  ndf  )

inline

Definition at line 21 of file ChiSquared.h.

: theValue(value), theNDF(ndf) {}

Member Function Documentation

degreesOfFreedom()

float ChiSquared::degreesOfFreedom

(

)

const

Definition at line 6 of file ChiSquared.cc.

{ return theNDF; }

References theNDF.

Referenced by lnProbability(), and probability().

lnProbability()

float ChiSquared::lnProbability

(

)

const

Definition at line 10 of file ChiSquared.cc.

{ return LnChiSquaredProbability(value(), degreesOfFreedom()); }

References degreesOfFreedom(), LnChiSquaredProbability(), and value().

probability()

float ChiSquared::probability

(

)

const

Definition at line 8 of file ChiSquared.cc.

{ return ChiSquaredProbability(value(), degreesOfFreedom()); }

References ChiSquaredProbability(), degreesOfFreedom(), and value().

value()

float ChiSquared::value

(

)

const

Definition at line 4 of file ChiSquared.cc.

{ return theValue; }

References theValue.

Referenced by Types.int32::__nonzero__(), Types.uint32::__nonzero__(), Types.int64::__nonzero__(), Types.uint64::__nonzero__(), Types.double::__nonzero__(), Types.bool::__nonzero__(), Types.string::__nonzero__(), average.Average::average(), Types.string::configValue(), Types.FileInPath::configValue(), Mixins.UsingBlock::dumpPython(), Mixins.UsingBlock::insertInto(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Types.double::insertInto(), Types.bool::insertInto(), Types.string::insertInto(), Types.FileInPath::insertInto(), Types.vint32::insertInto(), Types.vuint32::insertInto(), Types.vint64::insertInto(), Types.vuint64::insertInto(), Types.vdouble::insertInto(), Types.vbool::insertInto(), Types.vstring::insertInto(), lnProbability(), and probability().

Member Data Documentation

theNDF

float ChiSquared::theNDF

private

Definition at line 29 of file ChiSquared.h.

Referenced by degreesOfFreedom().

theValue

float ChiSquared::theValue

private

Definition at line 29 of file ChiSquared.h.

Referenced by value().