annotate libinterp/operators/op-class.cc @ 27923:bd51beb6205e

update formatting of copyright notices * Use <https://octave.org/copyright/> instead of <https://octave.org/COPYRIGHT.html/>. * For consistency with other comments in the Octave sources, use C++-style comments for copyright blocks in C and C++ files. * Use delimiters above and below copyright blocks that are appropriate for the language used in the file. * Eliminate extra spacing inside copyright blocks. * lex.ll (looks_like_copyright): Also allow newlines and carriage returns before the word "Copyright". * scripts/mk-doc.pl (gethelp): Also skip empty comment lines. * bp-table.cc, type.m: Adjust tests.
author John W. Eaton <jwe@octave.org>
date Wed, 08 Jan 2020 11:59:41 -0500
parents 1891570abac8
children 0a5b15007766
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
3 // Copyright (C) 2007-2020 The Octave Project Developers
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
4 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
7 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
9 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
14 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
19 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ////////////////////////////////////////////////////////////////////////
7338
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
25
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
26 //! @file op-class.cc
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
27 //! Unary and binary operators for classdef and old style classes.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
28
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21301
diff changeset
29 #if defined (HAVE_CONFIG_H)
21301
40de9f8f23a6 Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents: 21200
diff changeset
30 # include "config.h"
7338
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
31 #endif
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
32
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
33 #include "oct-time.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
34
21100
e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents: 20940
diff changeset
35 #include "errwarn.h"
23599
5cb3a2bb5e1e don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents: 23587
diff changeset
36 #include "interpreter-private.h"
7338
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
37 #include "load-path.h"
20940
48b2ad5ee801 maint: Rename oct-obj.[cc|h] to ovl.[cc|h] for clarity.
Rik <rik@octave.org>
parents: 20833
diff changeset
38 #include "ovl.h"
7338
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
39 #include "ov.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
40 #include "ov-class.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
41 #include "ov-typeinfo.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
42 #include "ops.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
43 #include "symtab.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
44 #include "parse.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
45
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
46 //! Default unary class operator.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
47 //!
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
48 //! @param a operand
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
49 //! @param opname operator name
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
50
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
51 static octave_value
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
52 oct_unop_default (const octave_value& a, const std::string& opname)
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
53 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
54 std::string class_name = a.class_name ();
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
55
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
56 octave_value meth
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
57 = octave::__get_symbol_table__ ("oct_unop_" + opname)
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
58 .find_method (opname, class_name);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
59
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
60 if (meth.is_defined ())
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
61 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
62 // Call overloaded unary class operator.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
63 octave_value_list tmp = octave::feval (meth.function_value (),
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
64 ovl (a), 1);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
65
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
66 // Return first element if present.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
67 if (tmp.length () > 0)
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
68 return tmp(0);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
69
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
70 return octave_value ();
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
71 }
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
72
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
73 // Matlab compatibility: If (conjugate) transpose is not overloaded and
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
74 // the number of dimensions is maximal two, just transpose the array of
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
75 // that class.
7338
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
76
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
77 if ((opname == "transpose") || (opname == "ctranspose"))
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
78 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
79 if (a.ndims () > 2)
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
80 error ("%s not defined for N-D objects of %s class", opname.c_str (),
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
81 class_name.c_str ());
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
82
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
83 if (a.is_classdef_object ())
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
84 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
85 // FIXME: Default transposition for classdef arrays.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
86
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
87 error ("%s method not defined for %s class", opname.c_str (),
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
88 class_name.c_str ());
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
89 }
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
90 else
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
91 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
92 const octave_class& v
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
93 = dynamic_cast<const octave_class&> (a.get_rep ());
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
94
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
95 return octave_value (v.map_value ().transpose (),
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
96 v.class_name (),
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
97 v.parent_class_name_list ());
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
98 }
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
99 }
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
100 else
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
101 error ("%s method not defined for %s class", opname.c_str (),
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
102 class_name.c_str ());
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
103 }
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
104
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
105 //! Helper macro to define unary class operators.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
106
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
107 #define DEF_CLASS_UNOP(opname) \
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
108 static octave_value \
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
109 oct_unop_ ## opname (const octave_value& a) \
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
110 { \
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
111 return oct_unop_default (a, #opname); \
7338
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
112 }
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
113
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
114 DEF_CLASS_UNOP (not) // !a or ~a
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
115 DEF_CLASS_UNOP (uplus) // +a
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
116 DEF_CLASS_UNOP (uminus) // -a
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
117 DEF_CLASS_UNOP (transpose) // a.'
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
118 DEF_CLASS_UNOP (ctranspose) // a'
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
119 #undef DEF_CLASS_UNOP
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
120
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
121 //! Default binary class operator.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
122 //!
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
123 //! @param a1 first operand
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
124 //! @param a2 second operand
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
125 //! @param opname operator name
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
126 //!
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
127 //! The operator precedence is as follows:
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
128 //!
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
129 //! 1. If exactly one of the operands is a user defined class object, then
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
130 //! the class method of that operand is invoked.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
131 //!
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
132 //! 2. If both operands are user defined class objects, then
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
133 //! 2.1 The superior class method is invoked.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
134 //! 2.2 The leftmost class method is invoked if both classes are the same
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
135 //! or their precedence is not defined by superiorto/inferiorto.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
136
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
137 static octave_value
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
138 oct_binop_default (const octave_value& a1, const octave_value& a2,
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
139 const std::string& opname)
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
140 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
141 octave::symbol_table& symtab
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
142 = octave::__get_symbol_table__ ("oct_binop_" + opname);
27095
4ae89360ca16 Default (c)transpose for old style class arrays (bug #56323).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 26376
diff changeset
143
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
144 // Dispatch to first (leftmost) operand by default.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
145 std::string dispatch_type = a1.class_name ();
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
146
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
147 // Determine, if second operand takes precedence (see rules above).
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
148 if (! a1.isobject ()
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
149 || (a1.isobject () && a2.isobject ()
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
150 && symtab.is_superiorto (a2.class_name (), dispatch_type)))
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
151 dispatch_type = a2.class_name ();
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
152
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
153 octave_value meth = symtab.find_method (opname, dispatch_type);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
154
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
155 if (meth.is_undefined ())
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
156 error ("%s method not defined for %s class", opname.c_str (),
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
157 dispatch_type.c_str ());
27095
4ae89360ca16 Default (c)transpose for old style class arrays (bug #56323).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 26376
diff changeset
158
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
159 octave_value_list tmp = octave::feval (meth.function_value (),
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
160 ovl (a1, a2), 1);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
161
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
162 if (tmp.length () > 0)
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
163 return tmp(0);
27095
4ae89360ca16 Default (c)transpose for old style class arrays (bug #56323).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 26376
diff changeset
164
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
165 return octave_value ();
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
166 }
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
167
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
168 //! Helper macro to define binary class operators.
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
169
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
170 #define DEF_CLASS_BINOP(opname) \
27095
4ae89360ca16 Default (c)transpose for old style class arrays (bug #56323).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 26376
diff changeset
171 static octave_value \
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
172 oct_binop_ ## opname (const octave_value& a1, const octave_value& a2) \
27095
4ae89360ca16 Default (c)transpose for old style class arrays (bug #56323).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 26376
diff changeset
173 { \
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
174 return oct_binop_default (a1, a2, #opname); \
27095
4ae89360ca16 Default (c)transpose for old style class arrays (bug #56323).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 26376
diff changeset
175 }
4ae89360ca16 Default (c)transpose for old style class arrays (bug #56323).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 26376
diff changeset
176
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
177 DEF_CLASS_BINOP (plus) // a1 + a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
178 DEF_CLASS_BINOP (minus) // a1 - a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
179 DEF_CLASS_BINOP (mtimes) // a1 * a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
180 DEF_CLASS_BINOP (mrdivide) // a1 / a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
181 DEF_CLASS_BINOP (mpower) // a1 ^ a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
182 DEF_CLASS_BINOP (mldivide) // a1 \ a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
183 DEF_CLASS_BINOP (lt) // a1 < a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
184 DEF_CLASS_BINOP (le) // a1 <= a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
185 DEF_CLASS_BINOP (eq) // a1 <= a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
186 DEF_CLASS_BINOP (ge) // a1 >= a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
187 DEF_CLASS_BINOP (gt) // a1 > a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
188 DEF_CLASS_BINOP (ne) // a1 ~= a2 or a1 != a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
189 DEF_CLASS_BINOP (times) // a1 .* a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
190 DEF_CLASS_BINOP (rdivide) // a1 ./ a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
191 DEF_CLASS_BINOP (power) // a1 .^ a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
192 DEF_CLASS_BINOP (ldivide) // a1 .\ a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
193 DEF_CLASS_BINOP (and) // a1 & a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
194 DEF_CLASS_BINOP (or) // a1 | a2
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
195 #undef DEF_CLASS_BINOP
7338
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
196
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
197 void
24540
46440078d73b don't use singleton for octave_value_typeinfo
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
198 install_class_ops (octave::type_info& ti)
7338
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
199 {
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
200 ti.install_unary_class_op (octave_value::op_not, oct_unop_not);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
201 ti.install_unary_class_op (octave_value::op_uplus, oct_unop_uplus);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
202 ti.install_unary_class_op (octave_value::op_uminus, oct_unop_uminus);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
203 ti.install_unary_class_op (octave_value::op_transpose, oct_unop_transpose);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
204 ti.install_unary_class_op (octave_value::op_hermitian, oct_unop_ctranspose);
7338
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
205
27098
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
206 ti.install_binary_class_op (octave_value::op_add, oct_binop_plus);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
207 ti.install_binary_class_op (octave_value::op_sub, oct_binop_minus);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
208 ti.install_binary_class_op (octave_value::op_mul, oct_binop_mtimes);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
209 ti.install_binary_class_op (octave_value::op_div, oct_binop_mrdivide);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
210 ti.install_binary_class_op (octave_value::op_pow, oct_binop_mpower);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
211 ti.install_binary_class_op (octave_value::op_ldiv, oct_binop_mldivide);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
212 ti.install_binary_class_op (octave_value::op_lt, oct_binop_lt);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
213 ti.install_binary_class_op (octave_value::op_le, oct_binop_le);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
214 ti.install_binary_class_op (octave_value::op_eq, oct_binop_eq);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
215 ti.install_binary_class_op (octave_value::op_ge, oct_binop_ge);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
216 ti.install_binary_class_op (octave_value::op_gt, oct_binop_gt);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
217 ti.install_binary_class_op (octave_value::op_ne, oct_binop_ne);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
218 ti.install_binary_class_op (octave_value::op_el_mul, oct_binop_times);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
219 ti.install_binary_class_op (octave_value::op_el_div, oct_binop_rdivide);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
220 ti.install_binary_class_op (octave_value::op_el_pow, oct_binop_power);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
221 ti.install_binary_class_op (octave_value::op_el_ldiv, oct_binop_ldivide);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
222 ti.install_binary_class_op (octave_value::op_el_and, oct_binop_and);
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27095
diff changeset
223 ti.install_binary_class_op (octave_value::op_el_or, oct_binop_or);
7338
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe]
jwe
parents:
diff changeset
224 }