Mercurial > hg > octave-lyh
diff scripts/sparse/spstats.m @ 11469:c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 09 Jan 2011 12:41:21 -0800 |
parents | be55736a0783 |
children | fd0a3ac60b0e |
line wrap: on
line diff
--- a/scripts/sparse/spstats.m +++ b/scripts/sparse/spstats.m @@ -17,17 +17,17 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{s}) -## @deftypefnx {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{s}, @var{j}) -## Return the stats for the non-zero elements of the sparse matrix @var{s}. +## @deftypefn {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{S}) +## @deftypefnx {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{S}, @var{j}) +## Return the stats for the non-zero elements of the sparse matrix @var{S}. ## @var{count} is the number of non-zeros in each column, @var{mean} ## is the mean of the non-zeros in each column, and @var{var} is the ## variance of the non-zeros in each column. ## -## Called with two input arguments, if @var{s} is the data and @var{j} +## Called with two input arguments, if @var{S} is the data and @var{j} ## is the bin number for the data, compute the stats for each bin. In ## this case, bins can contain data values of zero, whereas with -## @code{spstats (@var{s})} the zeros may disappear. +## @code{spstats (@var{S})} the zeros may disappear. ## @end deftypefn function [count, mean, var] = spstats (S, j) @@ -57,6 +57,7 @@ endfunction + %!test %! [n,m,v] = spstats([1 2 1 2 3 4],[2 2 1 1 1 1]); %! assert(n,sparse([4,2]));