changeset 2098:439467e95227 octave-forge

Clarify docs for control parameter 1-alpha
author pkienzle
date Tue, 01 Nov 2005 15:39:44 +0000
parents ba09956b7eab
children 07dce9aebeba
files main/optim/polyconf.m
diffstat 1 files changed, 8 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/main/optim/polyconf.m	Mon Oct 31 21:18:34 2005 +0000
+++ b/main/optim/polyconf.m	Tue Nov 01 15:39:44 2005 +0000
@@ -19,9 +19,10 @@
 ##
 ## polyconf(...,1-alpha)
 ##
-##   The width of the prediction interval. The default is .05 for
-##   a 95% prediction interval, or erfc(1/sqrt(2)) for a one
-##   standard deviation confidence interval.
+##   Control the width of the interval. If asking for the prediction
+##   interval 'pi', the default is .05 for the 95% prediction interval.
+##   If asking for the confidence interval 'ci', the default is
+##   erfc(1/sqrt(2)) for a one standard deviation confidence interval.
 ##
 ## Example:
 ##  [p,s] = polyfit(x,y,1);
@@ -98,9 +99,10 @@
 ##
 ## confidence(...,1-alpha)
 ##
-##   The width of the confidence interval. The default is .05 for
-##   a 95% prediction interval, or erfc(1/sqrt(2)) for a one
-##   standard deviation confidence interval.
+##   Control the width of the interval. If asking for the prediction
+##   interval 'pi', the default is .05 for the 95% prediction interval.
+##   If asking for the confidence interval 'ci', the default is
+##   erfc(1/sqrt(2)) for a one standard deviation confidence interval.
 ##
 ## Confidence intervals for linear system are given by:
 ##    x' p +/- sqrt( Finv(1-a,1,df) var(x' p) )