Mercurial > octave-antonio
comparison scripts/sparse/spstats.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 04 May 2015 14:22:02 -0700 |
| parents | 4197fc428c7d |
| children |
comparison
equal
deleted
inserted
replaced
| 20163:075a5e2e1ba5 | 20164:df437a52bcaf |
|---|---|
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{S}) | 20 ## @deftypefn {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{S}) |
| 21 ## @deftypefnx {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{S}, @var{j}) | 21 ## @deftypefnx {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{S}, @var{j}) |
| 22 ## Return the stats for the nonzero elements of the sparse matrix @var{S}. | 22 ## Return the stats for the nonzero elements of the sparse matrix @var{S}. |
| 23 ## @var{count} is the number of nonzeros in each column, @var{mean} | |
| 24 ## is the mean of the nonzeros in each column, and @var{var} is the | |
| 25 ## variance of the nonzeros in each column. | |
| 26 ## | 23 ## |
| 27 ## Called with two input arguments, if @var{S} is the data and @var{j} | 24 ## @var{count} is the number of nonzeros in each column, @var{mean} is the mean |
| 28 ## is the bin number for the data, compute the stats for each bin. In | 25 ## of the nonzeros in each column, and @var{var} is the variance of the |
| 29 ## this case, bins can contain data values of zero, whereas with | 26 ## nonzeros in each column. |
| 27 ## | |
| 28 ## Called with two input arguments, if @var{S} is the data and @var{j} is the | |
| 29 ## bin number for the data, compute the stats for each bin. In this case, | |
| 30 ## bins can contain data values of zero, whereas with | |
| 30 ## @code{spstats (@var{S})} the zeros may disappear. | 31 ## @code{spstats (@var{S})} the zeros may disappear. |
| 31 ## @end deftypefn | 32 ## @end deftypefn |
| 32 | 33 |
| 33 function [count, mean, var] = spstats (S, j) | 34 function [count, mean, var] = spstats (S, j) |
| 34 | 35 |