update packages

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

diff --git a/octave_packages/m/deprecated/intwarning.m b/octave_packages/m/deprecated/intwarning.m
new file mode 100644 (file)
index 0000000..60c1960
--- /dev/null
+++ b/octave_packages/m/deprecated/intwarning.m
@@ -0,0 +1,133 @@
+## Copyright (C) 2008-2012 David Bateman
+##
+## 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} {} intwarning (@var{action})
+## @deftypefnx {Function File} {} intwarning (@var{s})
+## @deftypefnx {Function File} {@var{s} =} intwarning (@dots{})
+## Control the state of the warning for integer conversions and math
+## operations.
+##
+## @table @asis
+## @item "query"
+## With an output argument, return the current state of the integer
+## conversion and math warnings.  With no output arguments, print the
+## current state.
+## @c Set example in small font to prevent overfull line
+##
+## @smallexample
+## @group
+## intwarning ("query")
+## The state of warning "Octave:int-convert-nan" is "off"
+## The state of warning "Octave:int-convert-non-int-val" is "off"
+## The state of warning "Octave:int-convert-overflow" is "off"
+## The state of warning "Octave:int-math-overflow" is "off"
+## @end group
+## @end smallexample
+##
+## @item "on"
+## @itemx "off"
+## Turn integer conversion and math warnings on (or off).  If there is
+## no output argument, then nothing is printed.  Otherwise the original
+## state of the state of the integer conversion and math warnings is
+## returned in a structure array.
+## @end table
+##
+## The original state of the integer warnings can be restored by passing
+## the structure array returned by @code{intwarning} to a later call to
+## @code{intwarning}.  For example:
+##
+## @example
+## @group
+## s = intwarning ("off");
+## @dots{}
+## intwarning (s);
+## @end group
+## @end example
+## @seealso{warning}
+## @end deftypefn
+
+## Deprecated in v. 3.4
+
+function y = intwarning (x)
+
+  persistent warned = false;
+  if (! warned)
+    warned = true;
+    warning ("Octave:deprecated-function",
+             "intwarning is obsolete and will be removed from a future version of Octave; integer math no longer produces warnings -- supply your own checks if you need those");
+  endif
+
+  return;
+
+  if (nargin != 1)
+    print_usage ();
+  else
+    if (nargout > 0)
+      y = warning("query", "Octave:int-convert-nan");
+      y = [y; warning("query", "Octave:int-convert-non-int-val")];
+      y = [y; warning("query", "Octave:int-convert-overflow")];
+      y = [y; warning("query", "Octave:int-math-overflow")];
+    endif
+    if (ischar (x))
+      if (strcmpi (x, "query"))
+        if (nargout == 0)
+          __print_int_warn_state__ ("Octave:int-convert-nan");
+          __print_int_warn_state__ ("Octave:int-convert-non-int-val");
+          __print_int_warn_state__ ("Octave:int-convert-overflow");
+          __print_int_warn_state__ ("Octave:int-math-overflow");
+          printf("\n");
+        endif
+      elseif (strcmpi (x, "on"))
+        warning ("on", "Octave:int-convert-nan");
+        warning ("on", "Octave:int-convert-non-int-val");
+        warning ("on", "Octave:int-convert-overflow");
+        warning ("on", "Octave:int-math-overflow");
+      elseif (strcmpi (x, "off"))
+        warning ("off", "Octave:int-convert-nan");
+        warning ("off", "Octave:int-convert-non-int-val");
+        warning ("off", "Octave:int-convert-overflow");
+        warning ("off", "Octave:int-math-overflow");
+      else
+        error ("intwarning: unrecognized argument");
+      endif
+    elseif (isstruct(x))
+      for fld = fieldnames (x)
+        if (strcmp ("Octave:int-convert-nan")
+            || strcmp ("Octave:int-convert-non-int-val")
+            || strcmp ("Octave:int-convert-overflow")
+            || strcmp ("Octave:int-cmath-overflow"))
+          s = getfield (x, fld);
+          if (! ischar (s) || !(strcmpi("s","on") || strcmpi("s","off")))
+            error ("intwarning: unexpected warning state");
+          endif
+          warning (s, fld);
+        else
+          error ("intwarning: unrecognized integer warning %s", fld);
+        endif
+      endfor
+    else
+      error ("intwarning: unexpected input");
+    endif
+  endif
+endfunction
+
+function __print_int_warn_state__ (s)
+  fprintf ("The state of warning \"%s\" is \"%s\"\n",
+           s, warning ("query", s).state);
+endfunction