Mercurial > octave-nkf

annotate scripts/deprecated/weibrnd.m @ 7696:0a362fa8f3c8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add warning to rest of deprecated functions
author David Bateman <dbateman@free.fr>
date Fri, 04 Apr 2008 10:18:35 -0400
parents 8e5371d47da6
children 1cdb42b372e8 72830070a17b
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) 2006, 2007 John W. Eaton
5693
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
2 ##
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
4 ##
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
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: 5693
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: 5693
diff changeset
8 ## your option) any later version.
5693
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
9 ##
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
14 ##
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
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: 5693
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: 5693
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5693
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
18
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {} weibrnd (@var{scale}, @var{shape}, @var{r}, @var{c})
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefnx {Function File} {} weibrnd (@var{scale}, @var{shape}, @var{sz})
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
22 ## Return an @var{r} by @var{c} matrix of random samples from the
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
23 ## Weibull distribution with parameters @var{scale} and @var{shape}
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
24 ## which must be scalar or of size @var{r} by @var{c}. Or if @var{sz}
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
25 ## is a vector return a matrix of size @var{sz}.
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
26 ##
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
27 ## If @var{r} and @var{c} are omitted, the size of the result matrix is
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
28 ## the common size of @var{alpha} and @var{sigma}.
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
29 ## @end deftypefn
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
30
7693
8e5371d47da6 note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
31 ## Deprecated in version 3.0
8e5371d47da6 note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
32
5693
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
33 function rnd = weibrnd (varargin)
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
34
7696
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
35 persistent warned = false;
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
36 if (! warned)
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
37 warned = true;
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
38 warning ("Octave:deprecated-function",
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
39 ["weibrnd is obsolete and will be removed from a future\n",
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
40 "version of Octave, please use wblrnd instead"]);
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
41 endif
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
42
5693
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
43 rnd = wblrnd (varargin{:});
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
44
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
45 endfunction
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
46