update packages

[CreaPhase.git] / octave_packages / m / deprecated / weibpdf.m

diff --git a/octave_packages/m/deprecated/weibpdf.m b/octave_packages/m/deprecated/weibpdf.m
new file mode 100644 (file)
index 0000000..3b2a462
--- /dev/null
+++ b/octave_packages/m/deprecated/weibpdf.m
@@ -0,0 +1,47 @@
+## Copyright (C) 2006-2012 John W. Eaton
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} {} weibpdf (@var{x}, @var{scale}, @var{shape})
+## Compute the probability density function (PDF) at @var{x} of the
+## Weibull distribution with shape parameter @var{scale} and scale
+## parameter @var{shape} which is given by
+##
+## @example
+##    scale * shape^(-scale) * x^(scale-1) * exp(-(x/shape)^scale)
+## @end example
+##
+## @noindent
+## for @var{x} > 0.
+## @end deftypefn
+
+## Deprecated in version 3.0
+## Matlab still has this function, so don't remove just yet.
+
+function pdf = weibpdf (varargin)
+
+  persistent warned = false;
+  if (! warned)
+    warned = true;
+    warning ("Octave:deprecated-function",
+             "weibpdf is obsolete and will be removed from a future version of Octave; please use wblpdf instead");
+  endif
+
+  pdf = wblpdf (varargin{:});
+
+endfunction