octave_packages/m/deprecated/weibinv.m

   1 ## Copyright (C) 2006-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} {} weibinv (@var{x}, @var{scale}, @var{shape})
  21 ## Compute the quantile (the inverse of the CDF) at @var{x} of the
  22 ## Weibull distribution with shape parameter @var{scale} and scale
  23 ## parameter @var{shape}.
  24 ## @end deftypefn
  25
  26 ## Deprecated in version 3.0
  27 ## Matlab still has this function, so don't remove just yet.
  28
  29 function inv = weibinv (varargin)
  30
  31   persistent warned = false;
  32   if (! warned)
  33     warned = true;
  34     warning ("Octave:deprecated-function",
  35              "weibinv is obsolete and will be removed from a future version of Octave; please use wblinv instead");
  36   endif
  37
  38   inv = wblinv (varargin{:});
  39
  40 endfunction