Mercurial > forge
changeset 11156:b77277405ff3 octave-forge
gamfit: fix documentation. Closes bug #147
author | carandraug |
---|---|
date | Tue, 23 Oct 2012 02:24:44 +0000 |
parents | a22ce516e0fc |
children | cf1eacc6d137 |
files | main/statistics/inst/gamfit.m |
diffstat | 1 files changed, 8 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/main/statistics/inst/gamfit.m Mon Oct 22 21:46:08 2012 +0000 +++ b/main/statistics/inst/gamfit.m Tue Oct 23 02:24:44 2012 +0000 @@ -2,8 +2,13 @@ ## This program is granted to the public domain. ## -*- texinfo -*- -## @deftypefn {Function File} {} [A B] = gamfit (@var{R}) -## Finds the maximumlikelihood estimator for the Gamma distribution for R +## @deftypefn {Function File} {@var{MLE} =} gamfit (@var{data}) +## Calculate gamma distribution parameters. +## +## Find the maximum likelihood estimators (@var{mle}s) of the Gamma distribution +## of @var{data}. @var{MLE} is a two element vector with shape parameter +## @var{A} and scale @var{B}. +## ## @seealso{gampdf, gaminv, gamrnd, gamlike} ## @end deftypefn @@ -14,6 +19,7 @@ ## for the search takes one parameter, calculates the other and then returns ## the value of gamlike. +## FIXME is this still true??? ## Note: Octave uses the inverse scale parameter, which is the opposite of ## Matlab. To work for Matlab, value of b needs to be inverted in a few ## places (marked with **)