Mercurial > hg > octave-lyh

annotate scripts/deprecated/gammai.m @ 11151:0c38b45ab49c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Deprecate betai, gammai, is_global functions.
author Rik <octave@nomad.inbox5.com>
date Sun, 24 Oct 2010 07:28:43 -0700
parents scripts/specfun/gammai.m@a1dbe9d80eee
children fd0a3ac60b0e
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) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2005, 2006,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2007 John W. Eaton
3133
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
3 ##
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
5 ##
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
7 ## 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: 6046
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
9 ## your option) any later version.
3133
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
10 ##
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
14 ## General Public License for more details.
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
15 ##
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
16 ## 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: 6046
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
18 ## <http://www.gnu.org/licenses/>.
3133
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
19
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3444
diff changeset
20 ## -*- texinfo -*-
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3444
diff changeset
21 ## @deftypefn {Function File} {} gammai (@var{a}, @var{x})
3444
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3426
diff changeset
22 ## This function is provided for compatibility with older versions of
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3444
diff changeset
23 ## Octave. New programs should use @code{gammainc} instead.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
24 ##
11151
0c38b45ab49c Deprecate betai, gammai, is_global functions.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
25 ## @code{gammai (@var{a}, @var{x})} is the same as
0c38b45ab49c Deprecate betai, gammai, is_global functions.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
26 ## @code{gammainc (@var{x}, @var{a})}.
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3444
diff changeset
27 ## @end deftypefn
3133
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
28
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
29 ## Author: jwe
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
30 ## Created: 30 Jan 1998
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
31
11151
0c38b45ab49c Deprecate betai, gammai, is_global functions.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
32 ## Deprecated in version 3.4
0c38b45ab49c Deprecate betai, gammai, is_global functions.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
33
3133
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
34 function retval = gammai (a, x)
11151
0c38b45ab49c Deprecate betai, gammai, is_global functions.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
35 persistent warned = false;
0c38b45ab49c Deprecate betai, gammai, is_global functions.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
36 if (! warned)
0c38b45ab49c Deprecate betai, gammai, is_global functions.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
37 warned = true;
0c38b45ab49c Deprecate betai, gammai, is_global functions.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
38 warning ("Octave:deprecated-function",
0c38b45ab49c Deprecate betai, gammai, is_global functions.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
39 "gammai is obsolete and will be removed from a future version of Octave; please use gammainc instead");
0c38b45ab49c Deprecate betai, gammai, is_global functions.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
40 endif
3133
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
41
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
42 if (nargin == 2)
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
43 retval = gammainc (x, a);
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
44 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
45 print_usage ();
3133
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
46 endif
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
47
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
48 endfunction