octave: libinterp/octave-value/ov-builtin.h annotate

annotate libinterp/octave-value/ov-builtin.h @ 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	8eb8ba8aff9a

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) 1996-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 ////////////////////////////////////////////////////////////////////////
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	26 #if ! defined (octave_ov_builtin_h)
17822 ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17787 diff changeset	27 #define octave_ov_builtin_h 1
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	30
22897 4090c32fccf8 store set of dispatch classes in built-in function objects John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	31 #include <list>
4090c32fccf8 store set of dispatch classes in built-in function objects John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	32 #include <set>
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	33 #include <string>
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	34
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	35 #include "ov-fcn.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	36 #include "ov-typeinfo.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	37
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	38 class octave_value;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	39 class octave_value_list;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	40
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	41 namespace octave
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	42 {
23532 084245f9bd03 pass reference to evaluator to octave_function call methods John W. Eaton <jwe@octave.org> parents: 23520 diff changeset	43 class tree_evaluator;
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	44 class interpreter;
24239 51e408a7d38f jit: Move everything inside the octave namespace Julien Bect <jbect@users.sourceforge.net> parents: 23796 diff changeset	45 class jit_type;
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	46 }
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	47
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	48 // Builtin functions.
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	49
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	50 class
7349 a1ab9dbc9622 [project @ 2008-01-07 14:40:23 by jwe] jwe parents: 7017 diff changeset	51 OCTINTERP_API
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	52 octave_builtin : public octave_function
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	53 {
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	54 public:
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	55
26440 dc68f987c9ba oct-builtin.h: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26376 diff changeset	56 octave_builtin (void) : octave_function (), f (nullptr), m (nullptr),
dc68f987c9ba oct-builtin.h: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26376 diff changeset	57 file (), jtype (nullptr)
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	58 { }
4642 7a83d52d2aed [project @ 2003-11-22 12:19:34 by jwe] jwe parents: 4612 diff changeset	59
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	60 typedef octave_value_list (*meth) (octave::interpreter&,
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	61 const octave_value_list&, int);
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	62
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	63 typedef octave_value_list (*fcn) (const octave_value_list&, int);
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	64
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 20791 diff changeset	65 octave_builtin (fcn ff, const std::string& nm = "",
93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 20791 diff changeset	66 const std::string& ds = "")
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	67 : octave_function (nm, ds), f (ff), m (nullptr), file (), jtype (nullptr)
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	68 { }
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	69
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	70 octave_builtin (meth mm, const std::string& nm = "",
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	71 const std::string& ds = "")
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	72 : octave_function (nm, ds), f (nullptr), m (mm), file (), jtype (nullptr)
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	73 { }
15004 ea6997657614 which: provide source file name for built-in functions John W. Eaton <jwe@octave.org> parents: 14974 diff changeset	74
ea6997657614 which: provide source file name for built-in functions John W. Eaton <jwe@octave.org> parents: 14974 diff changeset	75 octave_builtin (fcn ff, const std::string& nm, const std::string& fnm,
ea6997657614 which: provide source file name for built-in functions John W. Eaton <jwe@octave.org> parents: 14974 diff changeset	76 const std::string& ds)
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	77 : octave_function (nm, ds), f (ff), m (nullptr), file (fnm), jtype (nullptr)
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	78 { }
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	79
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	80 octave_builtin (meth mm, const std::string& nm, const std::string& fnm,
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	81 const std::string& ds)
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	82 : octave_function (nm, ds), f (nullptr), m (mm), file (fnm), jtype (nullptr)
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	83 { }
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	84
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	85 // No copying!
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	86
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	87 octave_builtin (const octave_builtin& ob) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	88
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	89 octave_builtin& operator = (const octave_builtin& ob) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	90
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	91 ~octave_builtin (void) = default;
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	92
15005 74c7265c057a fix failure with function handles caused by changeset ea6997657614 John W. Eaton <jwe@octave.org> parents: 15004 diff changeset	93 std::string src_file_name (void) const { return file; }
15004 ea6997657614 which: provide source file name for built-in functions John W. Eaton <jwe@octave.org> parents: 14974 diff changeset	94
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	95 octave_function * function_value (bool = false) { return this; }
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	96
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3219 diff changeset	97 bool is_builtin_function (void) const { return true; }
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3219 diff changeset	98
26917 9dd1d8973877 avoid some overloaded virtual warnings (bug #55741) John W. Eaton <jwe@octave.org> parents: 26440 diff changeset	99 // We don't need to override both forms of the call method. The using
9dd1d8973877 avoid some overloaded virtual warnings (bug #55741) John W. Eaton <jwe@octave.org> parents: 26440 diff changeset	100 // declaration will avoid warnings about partially-overloaded virtual
9dd1d8973877 avoid some overloaded virtual warnings (bug #55741) John W. Eaton <jwe@octave.org> parents: 26440 diff changeset	101 // functions.
9dd1d8973877 avoid some overloaded virtual warnings (bug #55741) John W. Eaton <jwe@octave.org> parents: 26440 diff changeset	102 using octave_function::call;
9dd1d8973877 avoid some overloaded virtual warnings (bug #55741) John W. Eaton <jwe@octave.org> parents: 26440 diff changeset	103
23653 3bb0a937c071 avoid possible memory errors when parsing function files John W. Eaton <jwe@octave.org> parents: 23532 diff changeset	104 octave_value_list
3bb0a937c071 avoid possible memory errors when parsing function files John W. Eaton <jwe@octave.org> parents: 23532 diff changeset	105 call (octave::tree_evaluator& tw, int nargout = 0,
3bb0a937c071 avoid possible memory errors when parsing function files John W. Eaton <jwe@octave.org> parents: 23532 diff changeset	106 const octave_value_list& args = octave_value_list ());
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	107
24239 51e408a7d38f jit: Move everything inside the octave namespace Julien Bect <jbect@users.sourceforge.net> parents: 23796 diff changeset	108 octave::jit_type * to_jit (void) const;
14973 2960f1b2d6ea Add sin to JIT Max Brister <max@2bass.com> parents: 14138 diff changeset	109
24239 51e408a7d38f jit: Move everything inside the octave namespace Julien Bect <jbect@users.sourceforge.net> parents: 23796 diff changeset	110 void stash_jit (octave::jit_type& type);
14973 2960f1b2d6ea Add sin to JIT Max Brister <max@2bass.com> parents: 14138 diff changeset	111
14974 e3cd4c9d7ccc Generalize builtin specification in JIT and add support for cos and exp Max Brister <max@2bass.com> parents: 14973 diff changeset	112 fcn function (void) const;
e3cd4c9d7ccc Generalize builtin specification in JIT and add support for cos and exp Max Brister <max@2bass.com> parents: 14973 diff changeset	113
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	114 meth method (void) const;
8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	115
22897 4090c32fccf8 store set of dispatch classes in built-in function objects John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	116 void push_dispatch_class (const std::string& dispatch_type);
4090c32fccf8 store set of dispatch classes in built-in function objects John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	117
4090c32fccf8 store set of dispatch classes in built-in function objects John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	118 bool handles_dispatch_class (const std::string& dispatch_type) const;
4090c32fccf8 store set of dispatch classes in built-in function objects John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	119
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3219 diff changeset	120 protected:
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3219 diff changeset	121
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3219 diff changeset	122 // A pointer to the actual function.
2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3219 diff changeset	123 fcn f;
23518 8744d4ed8fb4 provide DEFMETHOD macros John W. Eaton <jwe@octave.org> parents: 23502 diff changeset	124 meth m;
3325 2efa28a91e7a [project @ 1999-10-29 21:39:20 by jwe] jwe parents: 3219 diff changeset	125
15004 ea6997657614 which: provide source file name for built-in functions John W. Eaton <jwe@octave.org> parents: 14974 diff changeset	126 // The name of the file where this function was defined.
ea6997657614 which: provide source file name for built-in functions John W. Eaton <jwe@octave.org> parents: 14974 diff changeset	127 std::string file;
ea6997657614 which: provide source file name for built-in functions John W. Eaton <jwe@octave.org> parents: 14974 diff changeset	128
22897 4090c32fccf8 store set of dispatch classes in built-in function objects John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	129 // The types this function has been declared to handle (if any).
4090c32fccf8 store set of dispatch classes in built-in function objects John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	130 std::set<std::string> dispatch_classes;
4090c32fccf8 store set of dispatch classes in built-in function objects John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	131
14973 2960f1b2d6ea Add sin to JIT Max Brister <max@2bass.com> parents: 14138 diff changeset	132 // A pointer to the jit type that represents the function.
24239 51e408a7d38f jit: Move everything inside the octave namespace Julien Bect <jbect@users.sourceforge.net> parents: 23796 diff changeset	133 octave::jit_type *jtype;
14973 2960f1b2d6ea Add sin to JIT Max Brister <max@2bass.com> parents: 14138 diff changeset	134
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	135 private:
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	136
4612 d44675070f1a [project @ 2003-11-14 19:49:56 by jwe] jwe parents: 4271 diff changeset	137 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	138 };
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	139
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	140 #endif

Mercurial > octave

annotate libinterp/octave-value/ov-builtin.h @ 27923:bd51beb6205e