changeset 11765:9f1b322fe0a9 release-3-0-x

updated help for tcdf and tinv
author jstickel@jstickel-10631s.nrel.gov
date Tue, 29 Apr 2008 02:10:04 -0400
parents 41ae2c287e3a
children 1434a2687447
files scripts/ChangeLog scripts/statistics/distributions/tcdf.m scripts/statistics/distributions/tinv.m
diffstat 3 files changed, 13 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/ChangeLog	Thu Apr 24 15:44:05 2008 -0400
+++ b/scripts/ChangeLog	Tue Apr 29 02:10:04 2008 -0400
@@ -1,3 +1,8 @@
+2008-04-29  Jonathan Stickel  <jjstickel@vcn.com>
+
+	* statistics/distributions/tcdf.m, statistics/distributions/tinv.m:
+	Doc fix.
+
 2008-04-21  John W. Eaton  <jwe@octave.org>
 
 	Version 3.0.1 released.
--- a/scripts/statistics/distributions/tcdf.m	Thu Apr 24 15:44:05 2008 -0400
+++ b/scripts/statistics/distributions/tcdf.m	Tue Apr 29 02:10:04 2008 -0400
@@ -18,9 +18,9 @@
 
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} tcdf (@var{x}, @var{n})
-## For each element of @var{x}, compute the CDF at @var{x} of the
-## t (Student) distribution with @var{n} degrees of freedom, i.e.,
-## PROB (t(@var{n}) <= @var{x}).
+## For each element of @var{x}, compute the cumulative distribution
+## function (CDF) at @var{x} of the t (Student) distribution with
+## @var{n} degrees of freedom, i.e., PROB (t(@var{n}) <= @var{x}).
 ## @end deftypefn
 
 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/tinv.m	Thu Apr 24 15:44:05 2008 -0400
+++ b/scripts/statistics/distributions/tinv.m	Tue Apr 29 02:10:04 2008 -0400
@@ -18,9 +18,11 @@
 
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} tinv (@var{x}, @var{n})
-## For each component of @var{x}, compute the quantile (the inverse of
-## the CDF) at @var{x} of the t (Student) distribution with parameter
-## @var{n}.
+## For each probability value @var{x}, compute the the inverse of the
+## cumulative distribution function (CDF) of the t (Student)
+## distribution with degrees of freedom @var{n}.  This function is
+## analagous to looking in a table for the t-value of a single-tailed
+## distribution.
 ## @end deftypefn
 
 ## For very large n, the "correct" formula does not really work well,