octave-nkf: scripts/statistics/distributions/poissrnd.m annotate

annotate scripts/statistics/distributions/poissrnd.m @ 14593:f4acb362b513

maint: Periodic merge of stable to default

author	Jordi Gutiérrez Hermoso <jordigh@octave.org>
date	Thu, 03 May 2012 00:50:03 -0400
parents	f3d52523cde1 89504d0a5c5b
children	57569a35765c

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13171 diff changeset	1 ## Copyright (C) 2012 Rik Wehbring
72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13171 diff changeset	2 ## Copyright (C) 1995-2012 Kurt Hornik
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	3 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	4 ## This file is part of Octave.
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	5 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	7 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	9 ## your option) any later version.
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	10 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	14 ## General Public License for more details.
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	15 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	16 ## 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: 7007 diff changeset	17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	18 ## <http://www.gnu.org/licenses/>.
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	19
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	20 ## -- texinfo --
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	21 ## @deftypefn {Function File} {} poissrnd (@var{lambda})
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	22 ## @deftypefnx {Function File} {} poissrnd (@var{lambda}, @var{r})
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	23 ## @deftypefnx {Function File} {} poissrnd (@var{lambda}, @var{r}, @var{c}, @dots{})
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	24 ## @deftypefnx {Function File} {} poissrnd (@var{lambda}, [@var{sz}])
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	25 ## Return a matrix of random samples from the Poisson distribution with
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	26 ## parameter @var{lambda}.
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	27 ##
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	28 ## When called with a single size argument, return a square matrix with
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	29 ## the dimension specified. When called with more than one scalar argument the
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	30 ## first two arguments are taken as the number of rows and columns and any
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	31 ## further arguments specify additional matrix dimensions. The size may also
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	32 ## be specified with a vector of dimensions @var{sz}.
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	33 ##
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	34 ## If no size arguments are given then the result matrix is the size of
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	35 ## @var{lambda}.
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	36 ## @end deftypefn
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	37
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5411 diff changeset	38 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	39 ## Description: Random deviates from the Poisson distribution
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	40
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	41 function rnd = poissrnd (lambda, varargin)
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	42
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	43 if (nargin < 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5428 diff changeset	44 print_usage ();
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	45 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	46
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	47 if (nargin == 1)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	48 sz = size (lambda);
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	49 elseif (nargin == 2)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	50 if (isscalar (varargin{1}) && varargin{1} >= 0)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	51 sz = [varargin{1}, varargin{1}];
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	52 elseif (isrow (varargin{1}) && all (varargin{1} >= 0))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	53 sz = varargin{1};
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	54 else
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	55 error ("poissrnd: dimension vector must be row vector of non-negative integers");
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	56 endif
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	57 elseif (nargin > 2)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	58 if (any (cellfun (@(x) (!isscalar (x) \|\| x < 0), varargin)))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	59 error ("poissrnd: dimensions must be non-negative integers");
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	60 endif
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	61 sz = [varargin{:}];
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	62 endif
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	63
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	64 if (!isscalar (lambda) && !isequal (size (lambda), sz))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	65 error ("poissrnd: LAMBDA must be scalar or of size SZ");
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	66 endif
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	67
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	68 if (iscomplex (lambda))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	69 error ("poissrnd: LAMBDA must not be complex");
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	70 endif
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	71
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	72 if (isa (lambda, "single"))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	73 cls = "single";
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	74 else
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	75 cls = "double";
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	76 endif
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	77
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	78 if (isscalar (lambda))
14583 89504d0a5c5b poissrnd should return zero when lambda = 0. (Bug # 36326) Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	79 if (lambda >= 0 && lambda < Inf)
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	80 rnd = randp (lambda, sz);
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	81 if (strcmp (cls, "single"))
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	82 rnd = single (rnd);
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	83 endif
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	84 else
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	85 rnd = NaN (sz, cls);
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	86 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	87 else
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	88 rnd = NaN (sz, cls);
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	89
14583 89504d0a5c5b poissrnd should return zero when lambda = 0. (Bug # 36326) Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	90 k = (lambda >= 0) & (lambda < Inf);
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	91 rnd(k) = randp (lambda(k));
5410 56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	92 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	93
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe] jwe parents: diff changeset	94 endfunction
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	95
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	96
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	97 %!assert (size (poissrnd (2)), [1, 1])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	98 %!assert (size (poissrnd (ones (2,1))), [2, 1])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	99 %!assert (size (poissrnd (ones (2,2))), [2, 2])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	100 %!assert (size (poissrnd (1, 3)), [3, 3])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	101 %!assert (size (poissrnd (1, [4 1])), [4, 1])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	102 %!assert (size (poissrnd (1, 4, 1)), [4, 1])
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	103
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	104 %% 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	105 %!assert (class (poissrnd (2)), "double")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	106 %!assert (class (poissrnd (single (2))), "single")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	107 %!assert (class (poissrnd (single ([2 2]))), "single")
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	108
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	109 %% Test input validation
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	110 %!error poissrnd ()
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	111 %!error poissrnd (1, -1)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	112 %!error poissrnd (1, ones (2))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	113 %!error poissrnd (1, 2, ones (2))
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	114 %!error poissrnd (i)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	115 %!error poissrnd (1, 2, -1)
19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	116 %!error poissrnd (1, [2 -1 2])
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	117 %!error poissrnd (ones (2,2), 3)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	118 %!error poissrnd (ones (2,2), [3, 2])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	119 %!error poissrnd (ones (2,2), 2, 3)
13171 19b9f17d22af Overhaul of statistical distribution functions Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	120
14583 89504d0a5c5b poissrnd should return zero when lambda = 0. (Bug # 36326) Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	121 %!assert (poissrnd (0, 1, 1), 0)
89504d0a5c5b poissrnd should return zero when lambda = 0. (Bug # 36326) Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	122 %!assert (poissrnd ([0, 0, 0], [1, 3]), [0 0 0])
89504d0a5c5b poissrnd should return zero when lambda = 0. (Bug # 36326) Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	123

Mercurial > octave-nkf

annotate scripts/statistics/distributions/poissrnd.m @ 14593:f4acb362b513