view scripts/deprecated/weibcdf.m @ 12856:cad4cba03f19

Deprecate corrcoef, cor and replace with Matlab equivalent corr The value calculated by Octave's corrcoef and cor are the same as the value calculated by the Matlab function corr. Use MathWorks naming convention for this functionality. * corr.m: New file with functionality of corrcoef.m * cov.m, kendall.m, spearman.m, cor_test.m: Adjust scripts to call corr() * statistics/base/module.mk, deprecated/module.mk: Inform Automake about deprecated functions * NEWS: Inform users about deprecation * stats.txi: Add corr() to documentation.
author Rik <octave@nomad.inbox5.com>
date Sat, 16 Jul 2011 20:38:00 -0700
parents fd0a3ac60b0e
children 72c96de7a403
line wrap: on
line source

## Copyright (C) 2006-2011 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} {} weibcdf (@var{x}, @var{scale}, @var{shape})
## Compute the cumulative distribution function (CDF) at @var{x} of the
## Weibull distribution with shape parameter @var{scale} and scale
## parameter @var{shape}, which is
##
## @example
## 1 - exp(-(x/shape)^scale)
## @end example
##
## @noindent
## for @var{x} @geq{} 0.
## @end deftypefn

## Deprecated in version 3.0
## Matlab still has this function, so don't remove just yet.

function cdf = weibcdf (varargin)

  persistent warned = false;
  if (! warned)
    warned = true;
    warning ("Octave:deprecated-function",
             "weibcdf is obsolete and will be removed from a future version of Octave; please use wblcdf instead");
  endif

  cdf = wblcdf (varargin{:});

endfunction