changeset 12644:e205ebe2ba67

Deprecate sylvester_matrix.m function * NEWS: Add to list of deprecated functions * matrix.txi: Remove from list of special matrices * deprecated/module.mk, special-matrix/module.mk: Move function to deprecated directory.
author Rik <octave@nomad.inbox5.com>
date Mon, 02 May 2011 11:45:56 -0700
parents 55430618bd5f
children 8579e7a6e6e0
files NEWS doc/interpreter/matrix.txi scripts/deprecated/module.mk scripts/deprecated/sylvester_matrix.m scripts/special-matrix/module.mk scripts/special-matrix/sylvester_matrix.m
diffstat 5 files changed, 9 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/NEWS
+++ b/NEWS
@@ -32,6 +32,7 @@
 
       is_duplicate_entry
       studentize
+      sylvester_matrix
 
 
 Summary of important user-visible changes for version 3.4:
--- a/doc/interpreter/matrix.txi
+++ b/doc/interpreter/matrix.txi
@@ -254,8 +254,6 @@
 
 @DOCSTRING(rosser)
 
-@DOCSTRING(sylvester_matrix)
-
 @DOCSTRING(toeplitz)
 
 @DOCSTRING(vander)
--- a/scripts/deprecated/module.mk
+++ b/scripts/deprecated/module.mk
@@ -24,6 +24,7 @@
   deprecated/spvcat.m \
   deprecated/strerror.m \
   deprecated/studentize.m \
+  deprecated/sylvester_matrix.m \
   deprecated/values.m \
   deprecated/weibcdf.m \
   deprecated/weibinv.m \
rename from scripts/special-matrix/sylvester_matrix.m
rename to scripts/deprecated/sylvester_matrix.m
--- a/scripts/special-matrix/sylvester_matrix.m
+++ b/scripts/deprecated/sylvester_matrix.m
@@ -33,6 +33,13 @@
 
 function retval = sylvester_matrix (k)
 
+  persistent warned = false;
+  if (! warned)
+    warned = true;
+    warning ("Octave:deprecated-function",
+             "sylvester_matrix is obsolete and will be removed from a future version of Octave; please use hadamard(2^k) instead");
+  endif
+
   if (nargin != 1)
     print_usage ();
   endif
--- a/scripts/special-matrix/module.mk
+++ b/scripts/special-matrix/module.mk
@@ -8,7 +8,6 @@
   special-matrix/magic.m \
   special-matrix/pascal.m \
   special-matrix/rosser.m \
-  special-matrix/sylvester_matrix.m \
   special-matrix/toeplitz.m \
   special-matrix/vander.m \
   special-matrix/wilkinson.m