Mercurial > hg > octave-nkf
annotate scripts/deprecated/exponential_rnd.m @ 11797:8d0795fedf4a release-3-0-x
Makefile.in (header-msg): Mention GNU Make; update GCC version info
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Mon, 04 Aug 2008 14:27:36 -0400 |
| parents | eb0a86b3deb9 |
| children |
| rev | line source |
|---|---|
| 11740 | 1 ## Copyright (C) 1995, 1996, 1997, 2005, 2007, 2008 Kurt Hornik |
| 5411 | 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. | |
| 5411 | 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/>. | |
| 5411 | 18 |
| 19 ## -*- texinfo -*- | |
| 20 ## @deftypefn {Function File} {} exponential_rnd (@var{lambda}, @var{r}, @var{c}) | |
| 21 ## @deftypefnx {Function File} {} exponential_rnd (@var{lambda}, @var{sz}) | |
| 22 ## Return an @var{r} by @var{c} matrix of random samples from the | |
| 23 ## exponential distribution with parameter @var{lambda}, which must be a | |
| 24 ## scalar or of size @var{r} by @var{c}. Or if @var{sz} is a vector, | |
| 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> |
| 5411 | 32 ## Description: Random deviates from the exponential distribution |
| 33 | |
|
11736
9d412bc1d54f
note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
34 ## Deprecated in version 3.0 |
|
9d412bc1d54f
note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
35 |
| 5411 | 36 function rnd = exponential_rnd (varargin) |
| 37 | |
|
11737
dd93a39fa8fe
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
11736
diff
changeset
|
38 persistent warned = false; |
|
dd93a39fa8fe
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
11736
diff
changeset
|
39 if (! warned) |
|
dd93a39fa8fe
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
11736
diff
changeset
|
40 warned = true; |
|
dd93a39fa8fe
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
11736
diff
changeset
|
41 warning ("Octave:deprecated-function", |
|
11744
eb0a86b3deb9
don't embed newline in warning messages in deprecated functions
John W. Eaton <jwe@octave.org>
parents:
11740
diff
changeset
|
42 "exponential_rnd is obsolete and will be removed from a future version of Octave; please use exprnd instead"); |
|
11737
dd93a39fa8fe
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
11736
diff
changeset
|
43 endif |
|
dd93a39fa8fe
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
11736
diff
changeset
|
44 |
| 6777 | 45 if (nargin > 0) |
| 46 varargin{1} = 1 ./ varargin{1}; | |
| 47 endif | |
| 48 | |
| 5411 | 49 rnd = exprnd (varargin{:}); |
| 50 | |
| 51 endfunction |