annotate scripts/deprecated/java_convert_matrix.m @ 18102:e124ae274013 gui-release

maint: Backout ca72f1b73216 on gui_release branch.
author Rik <rik@octave.org>
date Thu, 05 Dec 2013 11:30:28 -0800
parents
children fe689210525c 4197fc428c7d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18102
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
1 ## Copyright (C) 2012-2013 Rik Wehbring
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
8 ## your option) any later version.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
18
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
20 ## @deftypefn {Built-in Function} {@var{val} =} java_convert_matrix ()
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
21 ## @deftypefnx {Built-in Function} {@var{old_val} =} java_convert_matrix (@var{new_val})
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
22 ## @deftypefnx {Built-in Function} {} java_convert_matrix (@var{new_val}, "local")
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
23 ## Query or set the internal variable that controls whether Java arrays are
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
24 ## automatically converted to Octave matrices. The default value is false.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
25 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
26 ## When called from inside a function with the @qcode{"local"} option, the
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
27 ## variable is changed locally for the function and any subroutines it calls.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
28 ## The original variable value is restored when exiting the function.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
29 ## @seealso{java_matrix_autoconversion, java_unsigned_conversion, java_debug}
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
30 ## @end deftypefn
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
31
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
32 function old_val = java_convert_matrix (varargin)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
33
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
34 persistent warned = false;
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
35 if (! warned)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
36 warned = true;
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
37 warning ("Octave:deprecated-function",
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
38 "java_convert_matrix is obsolete and will be removed from a future version of Octave; use java_matrix_autoconversion instead");
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
39 endif
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
40
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
41 if (nargin > 2)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
42 print_usage ();
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
43 endif
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
44
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
45 old_val = java_matrix_autoconversion (varargin{:});
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
46
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
47 endfunction
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
48