Mercurial > hg > octave-lyh
annotate scripts/deprecated/geometric_rnd.m @ 11740:72830070a17b release-3-0-x
update copyright dates
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 07 Apr 2008 13:40:38 -0400 |
parents | dd93a39fa8fe |
children | eb0a86b3deb9 |
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} {} geometric_rnd (@var{p}, @var{r}, @var{c}) | |
21 ## @deftypefnx {Function File} {} geometric_rnd (@var{p}, @var{sz}) | |
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 | |
27 ## @var{c} columns. Or if @var{sz} is a vector, create a matrix of size | |
28 ## @var{sz}. | |
29 ## @end deftypefn | |
30 | |
5428 | 31 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
5411 | 32 ## Description: Random deviates from the geometric 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 = geometric_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", |
dd93a39fa8fe
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
11736
diff
changeset
|
42 ["geometric_rnd is obsolete and will be removed from a future\n", |
dd93a39fa8fe
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
11736
diff
changeset
|
43 "version of Octave, please use geornd instead"]); |
dd93a39fa8fe
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
11736
diff
changeset
|
44 endif |
dd93a39fa8fe
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
11736
diff
changeset
|
45 |
5411 | 46 rnd = geornd (varargin{:}); |
47 | |
48 endfunction |