Mercurial > hg > octave-nkf

changeset 20712:afdb856e44f1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Deprecate mahalanobis function. * NEWS: Announce deprecation. * stats.txi: Remove from manual * scripts/deprecated/module.mk: Add to deprecated build dir. * scripts/statistics/base/module.mk: Remove from existing dir * scripts/deprecated/mahalanobis.m: Add warning message to deprecated function. * scripts/statistics/base/mahalanobis.m: Delete deprecated function.
author Rik <rik@octave.org>
date Tue, 22 Sep 2015 05:45:05 -0700
parents 1f330d33388f
children b6ae0ef9327e
files NEWS doc/interpreter/stats.txi scripts/deprecated/mahalanobis.m scripts/deprecated/module.mk scripts/statistics/base/mahalanobis.m scripts/statistics/base/module.mk
diffstat 5 files changed, 14 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/NEWS
+++ b/NEWS
@@ -47,6 +47,7 @@
       Function             | Replacement
       ---------------------|------------------
       bitmax               | flintmax
+      mahalanobis          | mahal in Octave-Forge statistics pkg
       wavread              | audioread
       wavwrite             | audiowrite
 
--- a/doc/interpreter/stats.txi
+++ b/doc/interpreter/stats.txi
@@ -137,8 +137,6 @@
 
 @DOCSTRING(cloglog)
 
-@DOCSTRING(mahalanobis)
-
 @DOCSTRING(table)
 
 @node Statistical Plots
rename from scripts/statistics/base/mahalanobis.m
rename to scripts/deprecated/mahalanobis.m
--- a/scripts/statistics/base/mahalanobis.m
+++ b/scripts/deprecated/mahalanobis.m
@@ -18,6 +18,11 @@
 
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} mahalanobis (@var{x}, @var{y})
+##
+## @code{mahalanobis} is deprecated and will be removed in Octave version 4.6.
+## See the @code{mahal} function in the statistics package from Octave-Forge
+## for equivalent functionality.
+##
 ## Return the Mahalanobis' D-square distance between the multivariate
 ## samples @var{x} and @var{y}.
 ##
@@ -31,6 +36,13 @@
 
 function retval = mahalanobis (x, y)
 
+  persistent warned = false;
+  if (! warned)
+    warned = true;
+    warning ("Octave:deprecated-function",
+             "mahalanobis is obsolete and will be removed from a future version of Octave, please use mahal from the statistics package in Octave-Forge instead");
+  endif
+
   if (nargin != 2)
     print_usage ();
   endif
--- a/scripts/deprecated/module.mk
+++ b/scripts/deprecated/module.mk
@@ -13,6 +13,7 @@
   scripts/deprecated/isstr.m \
   scripts/deprecated/loadaudio.m \
   scripts/deprecated/luinc.m \
+  scripts/deprecated/mahalanobis.m \
   scripts/deprecated/mouse_wheel_zoom.m \
   scripts/deprecated/nfields.m \
   scripts/deprecated/octave_tmp_file_name.m \
--- a/scripts/statistics/base/module.mk
+++ b/scripts/statistics/base/module.mk
@@ -12,7 +12,6 @@
   scripts/statistics/base/kurtosis.m \
   scripts/statistics/base/logit.m \
   scripts/statistics/base/lscov.m \
-  scripts/statistics/base/mahalanobis.m \
   scripts/statistics/base/mean.m \
   scripts/statistics/base/meansq.m \
   scripts/statistics/base/median.m \