Mercurial > hg > octave-terminal
changeset 14740:c827d74a643b
doc: Add additional calling form of quantile() to docstring.
quantile.m: Add additional calling form to docstring.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 05 Jun 2012 16:31:02 -0700 |
parents | 31e2c4248664 |
children | 0ab3dd0fad18 |
files | scripts/statistics/base/quantile.m |
diffstat | 1 files changed, 4 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/statistics/base/quantile.m +++ b/scripts/statistics/base/quantile.m @@ -17,7 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{q} =} quantile (@var{x}, @var{p}) +## @deftypefn {Function File} {@var{q} =} quantile (@var{x}) +## @deftypefnx {Function File} {@var{q} =} quantile (@var{x}, @var{p}) ## @deftypefnx {Function File} {@var{q} =} quantile (@var{x}, @var{p}, @var{dim}) ## @deftypefnx {Function File} {@var{q} =} quantile (@var{x}, @var{p}, @var{dim}, @var{method}) ## For a sample, @var{x}, calculate the quantiles, @var{q}, corresponding to @@ -28,6 +29,8 @@ ## return them in a matrix, such that the i-th row of @var{q} contains ## the @var{p}(i)th quantiles of each column of @var{x}. ## +## If @var{p} is unspecified, return the quantiles for +## @code{[0.00 0.25 0.50 0.75 1.00]}. ## The optional argument @var{dim} determines the dimension along which ## the quantiles are calculated. If @var{dim} is omitted, and @var{x} is ## a vector or matrix, it defaults to 1 (column-wise quantiles). If