octave: scripts/statistics/discrete

annotate scripts/statistics/discrete_cdf.m @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	1 ## Copyright (C) 2010-2020 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	2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	5 ##
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	6 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3837 diff changeset	7 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3837 diff changeset	8 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23084 diff changeset	9 ## 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: 3837 diff changeset	10 ## 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: 23084 diff changeset	11 ## 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	12 ## (at your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	13 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3837 diff changeset	14 ## Octave is distributed in the hope that it will be useful, but
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## GNU General Public License for more details.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	18 ##
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	19 ## 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: 6046 diff changeset	20 ## 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: 23084 diff changeset	21 ## <https://www.gnu.org/licenses/>.
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	22
3456 434790acb067 [project @ 2000-01-19 06:58:51 by jwe] jwe parents: 3426 diff changeset	23 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20174 diff changeset	24 ## @deftypefn {} {} discrete_cdf (@var{x}, @var{v}, @var{p})
20174 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	25 ## For each element of @var{x}, compute the cumulative distribution function
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	26 ## (CDF) at @var{x} of a univariate discrete distribution which assumes the
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	27 ## values in @var{v} with probabilities @var{p}.
3456 434790acb067 [project @ 2000-01-19 06:58:51 by jwe] jwe parents: 3426 diff changeset	28 ## @end deftypefn
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	29
3456 434790acb067 [project @ 2000-01-19 06:58:51 by jwe] jwe parents: 3426 diff changeset	30 function cdf = discrete_cdf (x, v, p)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	31
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	32 if (nargin != 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5448 diff changeset	33 print_usage ();
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	34 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	35
4030 22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe] jwe parents: 3922 diff changeset	36 if (! isvector (v))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 10524 diff changeset	37 error ("discrete_cdf: V must be a vector");
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	38 elseif (any (isnan (v)))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	39 error ("discrete_cdf: V must not have any NaN elements");
4030 22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe] jwe parents: 3922 diff changeset	40 elseif (! isvector (p) \|\| (length (p) != length (v)))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 10524 diff changeset	41 error ("discrete_cdf: P must be a vector with length (V) elements");
3456 434790acb067 [project @ 2000-01-19 06:58:51 by jwe] jwe parents: 3426 diff changeset	42 elseif (! (all (p >= 0) && any (p)))
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	43 error ("discrete_cdf: P must be a nonzero, non-negative vector");
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	44 endif
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	45
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	46 p = p(:) / sum (p); # Reshape and normalize probability vector
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	47
26268 6dd232798997 maint: Remove useless ';' from end of for, if, while, etc. statements. Rik <rik@octave.org> parents: 25166 diff changeset	48 if (isa (x, "single") \|\| isa (v, "single") \|\| isa (p, "single"))
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	49 cdf = NaN (size (x), "single");
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	50 else
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	51 cdf = NaN (size (x));
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	52 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	53
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	54 k = ! isnan (x);
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	55 [vs, vi] = sort (v);
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	56 cdf(k) = [0 ; cumsum(p(vi))](lookup (vs, x(k)) + 1);
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	57
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	58 endfunction
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	59
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	60
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	61 %!shared x,v,p,y
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	62 %! x = [-1 0.1 1.1 1.9 3];
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	63 %! v = 0.1:0.2:1.9;
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	64 %! p = 1/length(v) * ones (1, length(v));
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	65 %! y = [0 0.1 0.6 1 1];
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	66 %!assert (discrete_cdf ([x, NaN], v, p), [y, NaN], eps)
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	67
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	68 ## Test class of input preserved
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	69 %!assert (discrete_cdf (single ([x, NaN]), v, p), single ([y, NaN]), 2*eps ("single"))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	70 %!assert (discrete_cdf ([x, NaN], single (v), p), single ([y, NaN]), 2*eps ("single"))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	71 %!assert (discrete_cdf ([x, NaN], v, single (p)), single ([y, NaN]), 2*eps ("single"))
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	72
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	73 ## Test input validation
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	74 %!error discrete_cdf ()
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	75 %!error discrete_cdf (1)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	76 %!error discrete_cdf (1,2)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	77 %!error discrete_cdf (1,2,3,4)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	78 %!error discrete_cdf (1, ones (2), ones (2,1))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	79 %!error discrete_cdf (1, [1 ; NaN], ones (2,1))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	80 %!error discrete_cdf (1, ones (2,1), ones (1,1))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	81 %!error discrete_cdf (1, ones (2,1), [1 -1])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	82 %!error discrete_cdf (1, ones (2,1), [1 NaN])
21562 6c2fd62db1f7 maint: Eliminate accidental double spaces in code. Rik <rik@octave.org> parents: 20852 diff changeset	83 %!error discrete_cdf (1, ones (2,1), [0 0])

Mercurial > octave

annotate scripts/statistics/discrete_cdf.m @ 27919:1891570abac8