comparison scripts/deprecated/java_unsigned_conversion.m @ 15800:d9b8333df5e4

Deprecate java_debug, java_convert_matrix, java_unsigned_conversion. Replace with debug_java, java_matrix_autoconversion, java_unsigned_autoconversion. * libinterp/octave-value/ov-java.h: Rename Vjava_debug, Vjava_unsigned_conversion, Vjava_convert_matrix to Vdebug_java, Vjava_unsigned_autoconversion, Vjava_matrix_autoconversion. * libinterp/octave-value/ov-java.cc(Fjava_debug, Fjava_unsigned_conversion, Fjava_convert_matrix): Rename functions to match variables in ov-java.h. Improve docstrings. * scripts/deprecated/module.mk: Add java_debug.m, java_convert_matrix.m, java_unsigned_conversion.m files to build system. * scripts/deprecated/java_convert_matrix.m: New m-file for deprecated function. * scripts/deprecated/java_debug.m: New m-file for deprecated function. * scripts/deprecated/java_unsigned_conversion.m: New m-file for deprecated function.
author Rik <rik@octave.org>
date Sun, 16 Dec 2012 21:43:52 -0800
parents
children fe112e09d799
comparison
equal deleted inserted replaced
15799:d0579fed7e22 15800:d9b8333df5e4
1 ## Copyright (C) 2012 Rik Wehbring
2 ##
3 ## This file is part of Octave.
4 ##
5 ## Octave is free software; you can redistribute it and/or modify it
6 ## under the terms of the GNU General Public License as published by
7 ## the Free Software Foundation; either version 3 of the License, or (at
8 ## your option) any later version.
9 ##
10 ## Octave is distributed in the hope that it will be useful, but
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 ## General Public License for more details.
14 ##
15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>.
18
19 ## -*- texinfo -*-
20 ## @deftypefn {Built-in Function} {@var{val} =} java_unsigned_conversion ()
21 ## @deftypefnx {Built-in Function} {@var{old_val} =} java_unsigned_conversion (@var{new_val})
22 ## @deftypefnx {Built-in Function} {} java_unsigned_conversion (@var{new_val}, \"local\")
23 ## Query or set the internal variable that controls how integer classes are
24 ## converted when Java matrix autoconversion is enabled. When enabled, Java
25 ## arrays of class Byte or Integer are converted to matrices of class uint8 or
26 ## uint32 respectively.
27 ##
28 ## When called from inside a function with the \"local\" option, the variable is
29 ## changed locally for the function and any subroutines it calls. The original
30 ## variable value is restored when exiting the function.
31 ## @seealso{java_unsigned_autoconversion, java_convert_matrix, debug_java}
32 ## @end deftypefn
33
34 function old_val = java_unsigned_conversion (varargin)
35
36 persistent warned = false;
37 if (! warned)
38 warned = true;
39 warning ("Octave:deprecated-function",
40 "java_unsigned_conversion is obsolete and will be removed from a future version of Octave; use java_unsigned_autoconversion instead");
41 endif
42
43 if (nargin > 2)
44 print_usage ();
45 endif
46
47 old_val = java_unsigned_autoconversion (varargin{:});
48
49 endfunction
50