octave_packages/m/deprecated/gammai.m

   1 ## Copyright (C) 1994-2012 John W. Eaton
   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
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   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
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} gammai (@var{a}, @var{x})
  21 ## This function is provided for compatibility with older versions of
  22 ## Octave.  New programs should use @code{gammainc} instead.
  23 ##
  24 ## @code{gammai (@var{a}, @var{x})} is the same as
  25 ## @code{gammainc (@var{x}, @var{a})}.
  26 ## @end deftypefn
  27
  28 ## Author: jwe
  29 ## Created: 30 Jan 1998
  30
  31 ## Deprecated in version 3.4
  32
  33 function retval = gammai (a, x)
  34   persistent warned = false;
  35   if (! warned)
  36     warned = true;
  37     warning ("Octave:deprecated-function",
  38              "gammai is obsolete and will be removed from a future version of Octave; please use gammainc instead");
  39   endif
  40
  41   if (nargin == 2)
  42     retval = gammainc (x, a);
  43   else
  44     print_usage ();
  45   endif
  46
  47 endfunction