Mercurial > hg > octave-lyh
comparison scripts/statistics/base/mode.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | eb63fbe60fab |
children | 634274aaa183 |
comparison
equal
deleted
inserted
replaced
9044:656ad518f385 | 9051:1bf0ce0930be |
---|---|
16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {[@var{m}, @var{f}, @var{c}] =} mode (@var{x}, @var{dim}) | 20 ## @deftypefn {Function File} {[@var{m}, @var{f}, @var{c}] =} mode (@var{x}, @var{dim}) |
21 ## Count the most frequently appearing value. @code{mode} counts the | 21 ## Count the most frequently appearing value. @code{mode} counts the |
22 ## frequency along the first non-singleton dimension and if two or more | 22 ## frequency along the first non-singleton dimension and if two or more |
23 ## values have te same frequency returns the smallest of the two in | 23 ## values have te same frequency returns the smallest of the two in |
24 ## @var{m}. The dimension along which to count can be specified by the | 24 ## @var{m}. The dimension along which to count can be specified by the |
25 ## @var{dim} parameter. | 25 ## @var{dim} parameter. |
26 ## | 26 ## |
27 ## The variable @var{f} counts the frequency of each of the most frequently | 27 ## The variable @var{f} counts the frequency of each of the most frequently |
28 ## occurring elements. The cell array @var{c} contains all of the elements | 28 ## occurring elements. The cell array @var{c} contains all of the elements |
29 ## with the maximum frequency . | 29 ## with the maximum frequency . |
30 ## @end deftypefn | 30 ## @end deftypefn |
31 | 31 |
32 function [m, f, c] = mode (x, dim) | 32 function [m, f, c] = mode (x, dim) |
33 | 33 |