Mercurial > hg > octave-nkf

annotate scripts/general/methods.m @ 20509:c5a8eff5a05d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
gallery: add very basic tests (check output size) for all matrix types.
author Carnë Draug <carandraug@octave.org>
date Fri, 03 Jul 2015 16:53:08 +0100
parents 7503499a252b
children 5d31cd795c21
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19898
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19790
diff changeset
1 ## Copyright (C) 2012-2015 Rik Wehbring
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
8 ## your option) any later version.
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
18
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
15809
cf3a18843a26 doc: Change function type to "Function File".
Rik <rik@octave.org>
parents: 15790
diff changeset
20 ## @deftypefn {Function File} {} methods (@var{obj})
cf3a18843a26 doc: Change function type to "Function File".
Rik <rik@octave.org>
parents: 15790
diff changeset
21 ## @deftypefnx {Function File} {} methods ("@var{classname}")
cf3a18843a26 doc: Change function type to "Function File".
Rik <rik@octave.org>
parents: 15790
diff changeset
22 ## @deftypefnx {Function File} {@var{mtds} =} methods (@dots{})
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
23 ##
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
24 ## Return a cell array containing the names of the methods for the
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
25 ## object @var{obj} or the named class @var{classname}.
20368
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19898
diff changeset
26 ##
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
27 ## @var{obj} may be an Octave class object or a Java object.
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
28 ##
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
29 ## @seealso{fieldnames}
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
30 ## @end deftypefn
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
31
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
32 function mtds = methods (obj)
19790
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
33
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
34 if (nargin != 1)
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
35 print_usage ();
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
36 endif
19790
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
37
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
38 if (isobject (obj))
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
39 ## Call internal C++ function for Octave objects
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
40 mtds_list = __methods__ (obj);
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
41 elseif (ischar (obj))
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
42 ## Could be a classname for an Octave class or Java class.
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
43 ## Try Octave class first.
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
44 mtds_list = __methods__ (obj);
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
45 if (isempty (mtds_list))
15790
921912c92102 Deprecate java_invoke, replace with javaMethod.
Rik <rik@octave.org>
parents: 15785
diff changeset
46 mtds_str = javaMethod ("getMethods", "org.octave.ClassHelper", obj);
16724
b7667fcb9fbc Substitute ostrsplit() for strsplit().
Ben Abbott <bpabbott@mac.com>
parents: 16403
diff changeset
47 mtds_list = ostrsplit (mtds_str, ';');
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
48 endif
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
49 elseif (isjava (obj))
15816
59b6c6aee042 Don't box return values from javaObject. Always return a Java object.
Rik <rik@octave.org>
parents: 15809
diff changeset
50 ## FIXME: Function prototype that excepts java obj exists, but doesn't
59b6c6aee042 Don't box return values from javaObject. Always return a Java object.
Rik <rik@octave.org>
parents: 15809
diff changeset
51 ## work if obj is java.lang.String. Convert obj to classname.
59b6c6aee042 Don't box return values from javaObject. Always return a Java object.
Rik <rik@octave.org>
parents: 15809
diff changeset
52 obj = class (obj);
15790
921912c92102 Deprecate java_invoke, replace with javaMethod.
Rik <rik@octave.org>
parents: 15785
diff changeset
53 mtds_str = javaMethod ("getMethods", "org.octave.ClassHelper", obj);
16724
b7667fcb9fbc Substitute ostrsplit() for strsplit().
Ben Abbott <bpabbott@mac.com>
parents: 16403
diff changeset
54 mtds_list = strsplit (mtds_str, ';');
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
55 else
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
56 error ("methods: Invalid input argument");
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
57 endif
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
58
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
59 if (nargout == 0)
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
60 classname = ifelse (ischar (obj), obj, class (obj));
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
61 printf ("Methods for class %s:\n", classname);
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
62 disp (list_in_columns (mtds_list));
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
63 else
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
64 mtds = mtds_list;
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
65 endif
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
66
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
67 endfunction
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
68
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
69
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
70 ## test Octave classname
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
71 %!test
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
72 %! mtds = methods ("ftp");
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
73 %! assert (mtds{1}, "ascii");
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
74
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
75 ## test Java classname
19790
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
76 %!testif HAVE_JAVA
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
77 %! mtds = methods ("java.lang.Double");
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
78 %! search = strfind (mtds, "java.lang.Double valueOf");
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
79 %! assert (! isempty ([search{:}]));
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
80