octave: libinterp/operators/op-class.cc annotate

annotate libinterp/operators/op-class.cc @ 27098:5fa8d1459b35

* libinterp/operators/op-class.cc: Overhaul file and document code. No functional changes, Doxygen and comments added. Refactor large portions of the macros DEF_CLASS_UNOP and DEF_CLASS_BINOP to proper c++ functions "oct_unop_default" and "oct_binop_default". The macro DEF_CLASS_UNOP_TRANS is no longer necessary. Expanded and removed the macros INSTALL_CLASS_UNOP_TI and INSTALL_CLASS_BINOP_TI to improve readability.

author	Kai T. Ohlhus <k.ohlhus@gmail.com>
date	Tue, 21 May 2019 10:00:52 +0200
parents	4ae89360ca16
children	b442ec6dda5c

rev	line source
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	1 /*
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	2
26376 00f796120a6d maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 25911 diff changeset	3 Copyright (C) 2007-2019 John W. Eaton
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	4
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	6
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23693 diff changeset	7 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	8 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23693 diff changeset	9 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	10 (at your option) any later version.
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	11
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	12 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	13 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	15 GNU General Public License for more details.
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	16
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	17 You should have received a copy of the GNU General Public License
7444 1e1e2608da7b [project @ 2008-02-04 07:40:55 by jwe] jwe parents: 7338 diff changeset	18 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23693 diff changeset	19 <https://www.gnu.org/licenses/>.
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	20
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	21 */
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	22
27098 5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	23 //! @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	24 //! 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	25
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	26 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	27 # include "config.h"
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	28 #endif
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	29
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	30 #include "oct-time.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	31
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20940 diff changeset	32 #include "errwarn.h"
23599 5cb3a2bb5e1e don't use singleton for symbol_table John W. Eaton <jwe@octave.org> parents: 23587 diff changeset	33 #include "interpreter-private.h"
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	34 #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	35 #include "ovl.h"
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	36 #include "ov.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	37 #include "ov-class.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	38 #include "ov-typeinfo.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	39 #include "ops.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	40 #include "symtab.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	41 #include "parse.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	42
27098 5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	43 //! 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	44 //!
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	45 //! @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	46 //! @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	47
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	48 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	49 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	50 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	51 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	52
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	53 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	54 = 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	55 .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	56
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	57 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	58 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	59 // 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	60 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	61 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	62
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	63 // 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	64 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	65 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	66
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	67 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	68 }
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 // 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	71 // 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	72 // that class.
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	73
27098 5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	74 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	75 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	76 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	77 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	78 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	79
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	80 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	81 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	82 // 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	83
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	84 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	85 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	86 }
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	87 else
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	88 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	89 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	90 = 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	91
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	92 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	93 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	94 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	95 }
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	96 }
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	97 else
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	98 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	99 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	100 }
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	101
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	102 //! 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	103
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	104 #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	105 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	106 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	107 { \
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	108 return oct_unop_default (a, #opname); \
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	109 }
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	110
27098 5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	111 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	112 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	113 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	114 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	115 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	116 #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	117
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	118 //! 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	119 //!
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	120 //! @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	121 //! @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	122 //! @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	123 //!
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	124 //! 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	125 //!
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	126 //! 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	127 //! 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	128 //!
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	129 //! 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	130 //! 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	131 //! 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	132 //! 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	133
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	134 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	135 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	136 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	137 {
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	138 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	139 = 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	140
27098 5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	141 // 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	142 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	143
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	144 // 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	145 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	146 \|\| (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	147 && 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	148 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	149
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	150 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	151
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	152 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	153 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	154 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	155
27098 5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	156 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	157 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	158
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	159 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	160 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	161
27098 5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	162 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	163 }
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	164
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	165 //! 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	166
5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	167 #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	168 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	169 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	170 { \
27098 5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	171 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	172 }
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 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	175 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	176 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	177 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	178 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	179 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	180 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	181 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	182 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	183 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	184 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	185 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	186 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	187 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	188 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	189 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	190 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	191 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	192 #undef DEF_CLASS_BINOP
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	193
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	194 void
24540 46440078d73b don't use singleton for octave_value_typeinfo John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	195 install_class_ops (octave::type_info& ti)
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	196 {
27098 5fa8d1459b35 * libinterp/operators/op-class.cc: Overhaul file and document code. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 27095 diff changeset	197 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	198 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	199 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	200 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	201 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	202
27098 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_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	204 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	205 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	206 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	207 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	208 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	209 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	210 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	211 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	212 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	213 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	214 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	215 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	216 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	217 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	218 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	219 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	220 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	221 }

Mercurial > octave

annotate libinterp/operators/op-class.cc @ 27098:5fa8d1459b35