Author: bugman Date: Sun Apr 13 20:46:37 2008 New Revision: 5653 URL: http://svn.gna.org/viewcvs/relax?rev=5653&view=rev Log: Converted the aicc() docstring to epydoc format. Modified: 1.3/generic_fns/model_selection.py Modified: 1.3/generic_fns/model_selection.py URL: http://svn.gna.org/viewcvs/relax/1.3/generic_fns/model_selection.py?rev=5653&r1=5652&r2=5653&view=diff ============================================================================== --- 1.3/generic_fns/model_selection.py (original) +++ 1.3/generic_fns/model_selection.py Sun Apr 13 20:46:37 2008 @@ -53,16 +53,21 @@ def aicc(chi2, k, n): """Small sample size corrected AIC. - The formula is: + The formula is:: 2k(k + 1) AICc = chi2 + 2k + --------- n - k - 1 - where: - chi2 is the minimised chi-squared value. - k is the number of parameters in the model. - n is the dimension of the relaxation data set. + + @param chi2: The minimised chi-squared value. + @type chi2: float + @param k: The number of parameters in the model. + @type k: int + @param n: The dimension of the relaxation data set. + @type n: int + @return: The AIC value. + @rtype: float """ return chi2 + 2.0*k + 2.0*k*(k + 1.0) / (n - k - 1.0)