octave_packages/m/deprecated/weibcdf.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} {} weibcdf (@var{x}, @var{scale}, @var{shape})
  21 ## Compute the cumulative distribution function (CDF) at @var{x} of the
  22 ## Weibull distribution with shape parameter @var{scale} and scale
  23 ## parameter @var{shape}, which is
  24 ##
  25 ## @example
  26 ## 1 - exp(-(x/shape)^scale)
  27 ## @end example
  28 ##
  29 ## @noindent
  30 ## for @var{x} @geq{} 0.
  31 ## @end deftypefn
  32
  33 ## Deprecated in version 3.0
  34 ## Matlab still has this function, so don't remove just yet.
  35
  36 function cdf = weibcdf (varargin)
  37
  38   persistent warned = false;
  39   if (! warned)
  40     warned = true;
  41     warning ("Octave:deprecated-function",
  42              "weibcdf is obsolete and will be removed from a future version of Octave; please use wblcdf instead");
  43   endif
  44
  45   cdf = wblcdf (varargin{:});
  46
  47 endfunction