Mercurial > octave-antonio
annotate scripts/statistics/distributions/exprnd.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 | c792872f8942 |
| 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} {} exprnd (@var{lambda}, @var{r}, @var{c}) |
| 5411 | 21 ## @deftypefnx {Function File} {} exprnd (@var{lambda}, @var{sz}) |
| 5410 | 22 ## Return an @var{r} by @var{c} matrix of random samples from the |
|
7604
90c9038170bf
doc fix for exp distribution functions
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
23 ## exponential distribution with mean @var{lambda}, which must be a |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
24 ## scalar or of size @var{r} by @var{c}. Or if @var{sz} is a vector, |
| 5410 | 25 ## create a matrix of size @var{sz}. |
| 26 ## | |
| 27 ## If @var{r} and @var{c} are omitted, the size of the result matrix is | |
| 28 ## the size of @var{lambda}. | |
| 29 ## @end deftypefn | |
| 30 | |
| 5428 | 31 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
| 5410 | 32 ## Description: Random deviates from the exponential distribution |
| 33 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
34 function rnd = exprnd (lambda, 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:
11469
diff
changeset
|
38 error ("exprnd: 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:
11469
diff
changeset
|
41 error ("exprnd: C must be a positive integer"); |
| 5410 | 42 endif |
| 43 sz = [r, c]; | |
| 44 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
45 if (any (size (lambda) != 1) |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
46 && (length (size (lambda)) != length (sz) || any (size (lambda) != 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:
11469
diff
changeset
|
47 error ("exprnd: LAMBDA 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:
11469
diff
changeset
|
55 error ("exprnd: R must be a positive integer or vector"); |
| 5410 | 56 endif |
| 57 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
58 if (any (size (lambda) != 1) |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
59 && ((length (size (lambda)) != length (sz)) || any (size (lambda) != 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:
11469
diff
changeset
|
60 error ("exprnd: LAMBDA must be scalar or of size SZ"); |
| 5410 | 61 endif |
| 62 elseif (nargin == 1) | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
63 sz = size (lambda); |
| 5410 | 64 else |
| 6046 | 65 print_usage (); |
| 5410 | 66 endif |
| 67 | |
| 68 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
69 if (isscalar (lambda)) |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
70 if ((lambda > 0) && (lambda < Inf)) |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
71 rnd = rande(sz) * lambda; |
| 5410 | 72 else |
|
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 = NaN (sz); |
| 5410 | 74 endif |
| 75 else | |
| 76 rnd = zeros (sz); | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
77 k = find (!(lambda > 0) | !(lambda < Inf)); |
| 5410 | 78 if (any (k)) |
| 79 rnd(k) = NaN; | |
| 80 endif | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
81 k = find ((lambda > 0) & (lambda < Inf)); |
| 5410 | 82 if (any (k)) |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
83 rnd(k) = rande(size(k)) .* lambda(k); |
| 5410 | 84 endif |
| 85 endif | |
| 86 | |
| 87 endfunction |