view 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
line wrap: on
line source

## Copyright (C) 2012 Rik Wehbring
##
## 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  {Built-in Function} {@var{val} =} java_unsigned_conversion ()
## @deftypefnx {Built-in Function} {@var{old_val} =} java_unsigned_conversion (@var{new_val})
## @deftypefnx {Built-in Function} {} java_unsigned_conversion (@var{new_val}, \"local\")
## Query or set the internal variable that controls how integer classes are
## converted when Java matrix autoconversion is enabled.  When enabled, Java
## arrays of class Byte or Integer are converted to matrices of class uint8 or
## uint32 respectively.
## 
## When called from inside a function with the \"local\" option, the variable is
## changed locally for the function and any subroutines it calls.  The original
## variable value is restored when exiting the function.
## @seealso{java_unsigned_autoconversion, java_convert_matrix, debug_java}
## @end deftypefn

function old_val = java_unsigned_conversion (varargin)

  persistent warned = false;
  if (! warned)
    warned = true;
    warning ("Octave:deprecated-function",
             "java_unsigned_conversion is obsolete and will be removed from a future version of Octave; use java_unsigned_autoconversion instead");
  endif

  if (nargin > 2)
    print_usage ();
  endif

  old_val = java_unsigned_autoconversion (varargin{:});

endfunction