Mercurial > hg > octave-lyh

annotate scripts/deprecated/pascal_rnd.m @ 8519:68aa5abfd136

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Trivial doc fixes
author sh@sh-laptop
date Thu, 15 Jan 2009 00:28:42 -0500
parents 1cdb42b372e8
children eb63fbe60fab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1995, 1996, 1997, 2007 Kurt Hornik
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
2 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
4 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
6 ## 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: 6349
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6349
diff changeset
8 ## your option) any later version.
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
9 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
14 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
15 ## 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: 6349
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6349
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
18
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
20 ## @deftypefn {Function File} {} pascal_rnd (@var{n}, @var{p}, @var{r}, @var{c})
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
21 ## @deftypefnx {Function File} {} pascal_rnd (@var{n}, @var{p}, @var{sz})
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
22 ## Return an @var{r} by @var{c} matrix of random samples from the Pascal
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
23 ## (negative binomial) distribution with parameters @var{n} and @var{p}.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
24 ## Both @var{n} and @var{p} must be scalar or of size @var{r} by @var{c}.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
25 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
26 ## If @var{r} and @var{c} are omitted, the size of the result matrix is
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
27 ## the common size of @var{n} and @var{p}. Or if @var{sz} is a vector,
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
28 ## create a matrix of size @var{sz}.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
29 ## @end deftypefn
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
30
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
31 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
32 ## Description: Random deviates from the Pascal distribution
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
33
7693
8e5371d47da6 note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
34 ## Deprecated in version 3.0
8e5371d47da6 note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
35
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
36 function rnd = pascal_rnd (varargin)
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
37
7696
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
38 persistent warned = false;
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
39 if (! warned)
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
40 warned = true;
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
41 warning ("Octave:deprecated-function",
7704
1cdb42b372e8 don't embed newline in warning messages in deprecated functions
John W. Eaton <jwe@octave.org>
parents: 7696
diff changeset
42 "pascal_rnd is obsolete and will be removed from a future version of Octave; please use nbinrnd instead");
7696
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
43 endif
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
44
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
45 rnd = nbinrnd (varargin{:});
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
46
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
47 endfunction