r5654 - /1.3/generic_fns/model_selection.py -- April 13, 2008 - 21:07

Author: bugman
Date: Sun Apr 13 20:47:12 2008
New Revision: 5654

URL: http://svn.gna.org/viewcvs/relax?rev=5654&view=rev
Log:
Converted the bic() 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=5654&r1=5653&r2=5654&view=diff
==============================================================================
--- 1.3/generic_fns/model_selection.py (original)
+++ 1.3/generic_fns/model_selection.py Sun Apr 13 20:47:12 2008
@@ -76,14 +76,19 @@
 def bic(chi2, k, n):
     """Bayesian or Schwarz Information Criteria.
 
-    The formula is:
+    The formula is::
 
         BIC = chi2 + k ln n
 
-    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 + k * log(n)