Mercurial > hg > octave-lyh

changeset 12586:f9b7aa3b88f8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Deprecate studentize(), replace with zscore().
author Rik <octave@nomad.inbox5.com>
date Fri, 08 Apr 2011 20:15:19 -0700
parents 4e32a1bb9096
children cf9cae7fed6d
files ChangeLog NEWS doc/ChangeLog doc/interpreter/stats.txi scripts/ChangeLog scripts/deprecated/module.mk scripts/deprecated/studentize.m scripts/statistics/base/center.m scripts/statistics/base/module.mk scripts/statistics/base/studentize.m scripts/statistics/base/zscore.m
diffstat 10 files changed, 46 insertions(+), 22 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2011-04-08  Rik  <octave@nomad.inbox5.com>
+
+	* NEWS: Deprecate studentize(), add new function zscore().
+
 2011-04-04  Rik  <octave@nomad.inbox5.com>
 
 	* NEWS: Add perror, strerror to list of functions deprecated in 3.4
--- a/NEWS
+++ b/NEWS
@@ -7,7 +7,8 @@
 
     iscolumn
     issrow
- 
+    zscore
+
  ** Deprecated functions.
 
     The following functions were deprecated in Octave 3.2 and have been
@@ -30,7 +31,8 @@
     release after 3.6):
 
       is_duplicate_entry
-      
+      studentize
+
 
 Summary of important user-visible changes for version 3.4:
 ---------------------------------------------------------
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,8 @@
+2011-04-08  Rik  <octave@nomad.inbox5.com>
+
+	* interpreter/stats.txi: Deprecate studentize(), replace with
+	zscore().
+
 2011-04-06  Rik  <octave@nomad.inbox5.com>
 
 	* interpreter/numbers.txi, interpreter/strings.txi: Group commonly used
--- a/doc/interpreter/stats.txi
+++ b/doc/interpreter/stats.txi
@@ -114,7 +114,7 @@
 
 @DOCSTRING(center)
 
-@DOCSTRING(studentize)
+@DOCSTRING(zscore)
 
 @DOCSTRING(histc)
 
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -1,3 +1,9 @@
+2011-04-08  Rik  <octave@nomad.inbox5.com>
+
+	* scripts/deprecated/module.mk, statistics/base/center.m,
+	statistics/base/module.mk: Deprecate studentize(), replace with
+	zscore().
+
 2011-04-08  Rik  <octave@nomad.inbox5.com>
 
 	* statistics/base/mode.m, statistics/base/quantile.m: Return output
--- a/scripts/deprecated/module.mk
+++ b/scripts/deprecated/module.mk
@@ -23,6 +23,7 @@
   deprecated/sphcat.m \
   deprecated/spvcat.m \
   deprecated/strerror.m \
+  deprecated/studentize.m \
   deprecated/values.m \
   deprecated/weibcdf.m \
   deprecated/weibinv.m \
rename from scripts/statistics/base/studentize.m
rename to scripts/deprecated/studentize.m
--- a/scripts/statistics/base/studentize.m
+++ b/scripts/deprecated/studentize.m
@@ -32,6 +32,12 @@
 ## Description: Subtract mean and divide by standard deviation
 
 function t = studentize (x, dim)
+  persistent warned = false;
+  if (! warned)
+    warned = true;
+    warning ("Octave:deprecated-function",
+             "studentize is obsolete and will be removed from a future version of Octave; please use zscore instead");
+  endif
 
   if (nargin != 1 && nargin != 2)
     print_usage ();
--- a/scripts/statistics/base/center.m
+++ b/scripts/statistics/base/center.m
@@ -23,7 +23,7 @@
 ## If @var{x} is a vector, subtract its mean.
 ## If @var{x} is a matrix, do the above for each column.
 ## If the optional argument @var{dim} is given, operate along this dimension.
-## @seealso{studentize}
+## @seealso{zscore}
 ## @end deftypefn
 
 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/base/module.mk
+++ b/scripts/statistics/base/module.mk
@@ -33,9 +33,9 @@
   statistics/base/spearman.m \
   statistics/base/statistics.m \
   statistics/base/std.m \
-  statistics/base/studentize.m \
   statistics/base/table.m \
-  statistics/base/var.m
+  statistics/base/var.m \
+  statistics/base/zscore.m
 
 FCN_FILES += $(statistics_base_FCN_FILES)
 
copy from scripts/statistics/base/studentize.m
copy to scripts/statistics/base/zscore.m
--- a/scripts/statistics/base/studentize.m
+++ b/scripts/statistics/base/zscore.m
@@ -17,8 +17,8 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn  {Function File} {} studentize (@var{x})
-## @deftypefnx {Function File} {} studentize (@var{x}, @var{dim})
+## @deftypefn  {Function File} {} zscore (@var{x})
+## @deftypefnx {Function File} {} zscore (@var{x}, @var{dim})
 ## If @var{x} is a vector, subtract its mean and divide by its standard
 ## deviation.
 ##
@@ -31,14 +31,14 @@
 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
 ## Description: Subtract mean and divide by standard deviation
 
-function t = studentize (x, dim)
+function t = zscore (x, dim)
 
   if (nargin != 1 && nargin != 2)
     print_usage ();
   endif
 
   if (! isnumeric(x))
-    error ("studentize: X must be a numeric vector or matrix");
+    error ("zscore: X must be a numeric vector or matrix");
   endif
 
   if (isinteger (x))
@@ -56,7 +56,7 @@
   else
     if (!(isscalar (dim) && dim == fix (dim))
         || !(1 <= dim && dim <= nd))
-      error ("studentize: DIM must be an integer and a valid dimension");
+      error ("zscore: DIM must be an integer and a valid dimension");
     endif
   endif
 
@@ -72,17 +72,17 @@
 
 endfunction
 
-%!assert(studentize ([1,2,3]), [-1,0,1])
-%!assert(studentize (int8 ([1,2,3])), [-1,0,1])
-#%!assert(studentize (ones (3,2,0,2)), zeros (3,2,0,2))
-%!assert(studentize ([2,0,-2;0,2,0;-2,-2,2]), [1,0,-1;0,1,0;-1,-1,1])
+%!assert(zscore ([1,2,3]), [-1,0,1])
+%!assert(zscore (int8 ([1,2,3])), [-1,0,1])
+#%!assert(zscore (ones (3,2,0,2)), zeros (3,2,0,2))
+%!assert(zscore ([2,0,-2;0,2,0;-2,-2,2]), [1,0,-1;0,1,0;-1,-1,1])
 
 %% Test input validation
-%!error studentize ()
-%!error studentize (1, 2, 3)
-%!error studentize ([true true])
-%!error studentize (1, ones(2,2))
-%!error studentize (1, 1.5)
-%!error studentize (1, 0)
-%!error studentize (1, 3)
+%!error zscore ()
+%!error zscore (1, 2, 3)
+%!error zscore ([true true])
+%!error zscore (1, ones(2,2))
+%!error zscore (1, 1.5)
+%!error zscore (1, 0)
+%!error zscore (1, 3)