Mercurial > octave-nkf

annotate scripts/deprecated/weibcdf.m @ 14138:72c96de7a403 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents fd0a3ac60b0e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
1 ## Copyright (C) 2006-2012 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} {} weibcdf (@var{x}, @var{scale}, @var{shape})
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
21 ## Compute the cumulative distribution function (CDF) at @var{x} of the
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
22 ## Weibull distribution with shape parameter @var{scale} and scale
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
23 ## parameter @var{shape}, which is
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
24 ##
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
25 ## @example
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
26 ## 1 - exp(-(x/shape)^scale)
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
27 ## @end example
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
28 ##
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
29 ## @noindent
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10221
diff changeset
30 ## for @var{x} @geq{} 0.
5693
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
31 ## @end deftypefn
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
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
10221
9b4d35fd1897 delete functions deprecated in version 3.0.0
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
34 ## Matlab still has this function, so don't remove just yet.
7693
8e5371d47da6 note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
35
5693
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
36 function cdf = weibcdf (varargin)
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
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 "weibcdf is obsolete and will be removed from a future version of Octave; please use wblcdf 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
5693
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
45 cdf = wblcdf (varargin{:});
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
46
446b28529300 [project @ 2006-03-17 18:16:03 by jwe]
jwe
parents:
diff changeset
47 endfunction