Mercurial > hg > octave-lyh
annotate scripts/statistics/distributions/geornd.m @ 11523:fd0a3ac60b0e
update copyright notices
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Fri, 14 Jan 2011 05:47:45 -0500 |
| parents | 1740012184f9 |
| children | abc71e3148ac |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 1995-2011 Kurt Hornik |
| 5410 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 5410 | 9 ## |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 5410 | 18 |
| 19 ## -*- texinfo -*- | |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
20 ## @deftypefn {Function File} {} geornd (@var{p}, @var{r}, @var{c}) |
| 5411 | 21 ## @deftypefnx {Function File} {} geornd (@var{p}, @var{sz}) |
| 5410 | 22 ## Return an @var{r} by @var{c} matrix of random samples from the |
| 23 ## geometric distribution with parameter @var{p}, which must be a scalar | |
| 24 ## or of size @var{r} by @var{c}. | |
| 25 ## | |
| 26 ## If @var{r} and @var{c} are given create a matrix with @var{r} rows and | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
7017
diff
changeset
|
27 ## @var{c} columns. Or if @var{sz} is a vector, create a matrix of size |
| 5410 | 28 ## @var{sz}. |
| 29 ## @end deftypefn | |
| 30 | |
| 5428 | 31 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
| 5410 | 32 ## Description: Random deviates from the geometric distribution |
| 33 | |
| 5411 | 34 function rnd = geornd (p, r, c) |
| 5410 | 35 |
| 36 if (nargin == 3) | |
| 37 if (! (isscalar (r) && (r > 0) && (r == round (r)))) | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
38 error ("geornd: R must be a positive integer"); |
| 5410 | 39 endif |
| 40 if (! (isscalar (c) && (c > 0) && (c == round (c)))) | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
41 error ("geornd: C must be a positive integer"); |
| 5410 | 42 endif |
| 43 sz = [r, c]; | |
| 44 | |
|
11149
fe3c3dfc07eb
style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents:
11094
diff
changeset
|
45 if (any (size (p) != 1) |
|
fe3c3dfc07eb
style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents:
11094
diff
changeset
|
46 && ((length (size (p)) != length (sz)) || any (size (p) != sz))) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
47 error ("geornd: P must be scalar or of size [R, C]"); |
| 5410 | 48 endif |
| 49 elseif (nargin == 2) | |
| 50 if (isscalar (r) && (r > 0)) | |
| 51 sz = [r, r]; | |
| 52 elseif (isvector(r) && all (r > 0)) | |
| 53 sz = r(:)'; | |
| 54 else | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
55 error ("geornd: R must be a positive integer or vector"); |
| 5410 | 56 endif |
| 57 | |
|
11149
fe3c3dfc07eb
style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents:
11094
diff
changeset
|
58 if (any (size (p) != 1) |
|
fe3c3dfc07eb
style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents:
11094
diff
changeset
|
59 && ((length (size (p)) != length (sz)) || any (size (p) != sz))) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
60 error ("geornd: n must be scalar or of size SZ"); |
| 5410 | 61 endif |
| 62 elseif (nargin == 1) | |
| 63 sz = size(n); | |
| 64 elseif (nargin != 1) | |
| 6046 | 65 print_usage (); |
| 5410 | 66 endif |
| 67 | |
| 68 | |
| 69 if (isscalar (p)) | |
|
11094
add5beb3b845
avoid use of | and & in IF conditions in statistics distribution functions
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
70 if (p < 0 || p > 1) |
|
10525
3306cfcb856e
Replace constructs like "NaN * one()" with "NaN()" and "Inf * ones ()" with "Inf()"
David Bateman <dbateman@free.fr>
parents:
9245
diff
changeset
|
71 rnd = NaN (sz); |
| 5410 | 72 elseif (p == 0) |
|
10525
3306cfcb856e
Replace constructs like "NaN * one()" with "NaN()" and "Inf * ones ()" with "Inf()"
David Bateman <dbateman@free.fr>
parents:
9245
diff
changeset
|
73 rnd = Inf (sz); |
|
11094
add5beb3b845
avoid use of | and & in IF conditions in statistics distribution functions
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
74 elseif (p > 0 && p < 1); |
| 6350 | 75 rnd = floor (- rande(sz) ./ log (1 - p)); |
| 5410 | 76 else |
| 77 rnd = zeros (sz); | |
| 78 endif | |
| 79 else | |
| 6350 | 80 rnd = floor (- rande(sz) ./ log (1 - p)); |
| 5410 | 81 |
| 82 k = find (!(p >= 0) | !(p <= 1)); | |
| 83 if (any (k)) | |
|
10525
3306cfcb856e
Replace constructs like "NaN * one()" with "NaN()" and "Inf * ones ()" with "Inf()"
David Bateman <dbateman@free.fr>
parents:
9245
diff
changeset
|
84 rnd(k) = NaN (1, length (k)); |
| 5410 | 85 endif |
| 86 | |
| 87 k = find (p == 0); | |
| 88 if (any (k)) | |
|
10525
3306cfcb856e
Replace constructs like "NaN * one()" with "NaN()" and "Inf * ones ()" with "Inf()"
David Bateman <dbateman@free.fr>
parents:
9245
diff
changeset
|
89 rnd(k) = Inf (1, length (k)); |
| 5410 | 90 endif |
| 91 endif | |
| 92 | |
| 93 endfunction |