Mercurial > hg > octave-lyh
annotate scripts/deprecated/chisquare_rnd.m @ 8920:eb63fbe60fab
update copyright notices
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Sat, 07 Mar 2009 10:41:27 -0500 |
parents | 1cdb42b372e8 |
children |
rev | line source |
---|---|
8920 | 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} {} chisquare_rnd (@var{n}, @var{r}, @var{c}) | |
21 ## @deftypefnx {Function File} {} chisquare_rnd (@var{n}, @var{sz}) | |
22 ## Return an @var{r} by @var{c} or a @code{size (@var{sz})} matrix of | |
23 ## random samples from the chisquare distribution with @var{n} degrees | |
24 ## of freedom. @var{n} must be a scalar or of size @var{r} by @var{c}. | |
25 ## | |
26 ## If @var{r} and @var{c} are omitted, the size of the result matrix is | |
27 ## the size of @var{n}. | |
28 ## @end deftypefn | |
29 | |
5428 | 30 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
5411 | 31 ## Description: Random deviates from the chi-square distribution |
32 | |
7693
8e5371d47da6
note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
33 ## Deprecated in version 3.0 |
8e5371d47da6
note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
34 |
5411 | 35 function rnd = chisquare_rnd (varargin) |
36 | |
7696
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
37 persistent warned = false; |
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
38 if (! warned) |
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
39 warned = true; |
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
40 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
|
41 "chisquare_rnd is obsolete and will be removed from a future version of Octave; please use chi2rnd instead"); |
7696
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
42 endif |
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
43 |
5411 | 44 rnd = chi2rnd (varargin{:}); |
45 | |
46 endfunction |