octave: scripts/statistics/run

annotate scripts/statistics/run_count.m @ 33617:ec2635a02328 bytecode-interpreter tip

maint: Merge default to bytecode-interpreter.

author	Markus Mützel <markus.muetzel@gmx.de>
date	Tue, 21 May 2024 18:29:03 +0200
parents	2e484f9f1f18
children

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 31706 diff changeset	3 ## Copyright (C) 1995-2024 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	7 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3456 diff changeset	8 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3456 diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3456 diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## (at your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	14 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3456 diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	19 ##
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6547 diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	25
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	26 ## -- texinfo --
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	27 ## @deftypefn {} {@var{cnt} =} run_count (@var{x}, @var{n})
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	28 ## @deftypefnx {} {@var{cnt} =} run_count (@var{x}, @var{n}, @var{dim})
20174 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	29 ## Count the upward runs along the first non-singleton dimension of @var{x}
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	30 ## of length 1, 2, @dots{}, @var{n}-1 and greater than or equal to @var{n}.
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	31 ##
20174 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	32 ## If the optional argument @var{dim} is given then operate along this
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	33 ## dimension.
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	34 ## @seealso{runlength}
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	35 ## @end deftypefn
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	36
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	37 function cnt = run_count (x, n, dim)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	38
28789 28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27984 diff changeset	39 if (nargin < 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5307 diff changeset	40 print_usage ();
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	41 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	42
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	43 if (! (isnumeric (x) \|\| islogical (x)))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	44 error ("run_count: X must be a numeric vector or matrix");
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	45 endif
cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	46
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	47 if (! (isscalar (n) && n == fix (n) && n > 0))
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	48 error ("run_count: N must be a positive integer");
cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	49 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	50
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	51 nd = ndims (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	52 sz = size (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	53 if (nargin != 3)
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	54 ## Find the first non-singleton dimension.
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	55 (dim = find (sz > 1, 1)) \|\| (dim = 1);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	56 else
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	57 if (!(isscalar (dim) && dim == fix (dim))
11149 fe3c3dfc07eb style fix: break lines before && and \|\|, not after John W. Eaton <jwe@octave.org> parents: 10669 diff changeset	58 \|\| !(1 <= dim && dim <= nd))
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	59 error ("run_count: DIM must be an integer and a valid dimension");
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	60 endif
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	61 endif
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	62
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	63 ## Algorithm works on rows. Permute array if necessary, ipermute back at end
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	64 if (dim != 1)
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	65 perm = [1 : nd];
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	66 perm(1) = dim;
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	67 perm(dim) = 1;
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	68 x = permute (x, perm);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	69 endif
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	70
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	71 sz = size (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	72 idx = cell ();
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	73 for i = 1 : nd
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	74 idx{i} = 1 : sz(i);
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	75 endfor
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	76 c = sz(1);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	77 tmp = zeros ([c + 1, sz(2 : end)]);
10540 952d4df5b686 Eliminate NaNones and Infones constructs and just use Nan() and Inf() Rik <code@nomad.inbox5.com> parents: 9245 diff changeset	78 infvec = Inf ([1, sz(2 : end)]);
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	79
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	80 ind = find (diff ([infvec; x; -infvec]) < 0);
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	81 tmp(ind(2:end) - 1) = diff (ind);
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	82 tmp = tmp(idx{:});
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	83
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	84 sz(1) = n;
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	85 cnt = zeros (sz);
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	86 for k = 1 : (n-1)
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	87 idx{1} = k;
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	88 cnt(idx{:}) = sum (tmp == k);
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	89 endfor
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	90 idx{1} = n;
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	91 cnt(idx{:}) = sum (tmp >= n);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	92
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	93 if (dim != 1)
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	94 cnt = ipermute (cnt, perm);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	95 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	96
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	97 endfunction
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	98
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	99
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	100 %!assert (run_count (magic (3), 4), [1,0,1;1,0,1;0,1,0;0,0,0])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	101 %!assert (run_count (magic (3), 4, 2), [1,0,1;1,0,1;0,1,0;0,0,0]')
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	102 %!assert (run_count (5:-1:1, 5), [5, 0, 0, 0, 0])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	103 %!assert (run_count (ones (3), 4), [0,0,0;0,0,0;1,1,1;0,0,0])
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	104
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	105 ## Test input validation
28886 d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 28789 diff changeset	106 %!error <Invalid call> run_count ()
d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 28789 diff changeset	107 %!error <Invalid call> run_count (1)
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	108 %!error run_count ({1, 2}, 3)
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	109 %!error run_count (['A'; 'A'; 'B'], 3)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	110 %!error run_count (1:5, ones (2,2))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	111 %!error run_count (1:5, 1.5)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	112 %!error run_count (1:5, -2)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	113 %!error run_count (1:5, 3, ones (2,2))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	114 %!error run_count (1:5, 3, 1.5)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	115 %!error run_count (1:5, 3, 0)

Mercurial > octave

annotate scripts/statistics/run_count.m @ 33617:ec2635a02328 bytecode-interpreter tip