annotate src/ov-fcn-handle.h @ 5210:996a08a3eb06 ss-2-9-0

[project @ 2005-03-15 20:46:03 by jwe]
author jwe
date Tue, 15 Mar 2005 20:46:03 +0000
parents e35b034d3523
children 4c8a2e4e0717
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
1 /*
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
2
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
3 Copyright (C) 2003 John W. Eaton
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
4
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
6
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
10 later version.
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
11
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
15 for more details.
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
16
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
20
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
21 */
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
22
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
23 #if !defined (octave_fcn_handle_h)
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
24 #define octave_fcn_handle_h 1
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
25
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
26 #include <iostream>
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
27 #include <string>
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
28
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
29 #include "oct-alloc.h"
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
30
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
31 #include "ov-base.h"
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
32 #include "ov-base-mat.h"
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
33 #include "ov-fcn.h"
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
34 #include "ov-typeinfo.h"
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
35
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
36 // Function handles.
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
37
4925
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
38 class
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
39 octave_fcn_handle : public octave_base_value
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
40 {
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
41 public:
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
42 octave_fcn_handle (void)
4933
cd58733c326b [project @ 2004-08-05 16:08:28 by jwe]
jwe
parents: 4930
diff changeset
43 : fcn (), nm () { }
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
44
5007
f8c27dad3643 [project @ 2004-09-17 11:42:04 by jwe]
jwe
parents: 4988
diff changeset
45 octave_fcn_handle (const std::string& n)
f8c27dad3643 [project @ 2004-09-17 11:42:04 by jwe]
jwe
parents: 4988
diff changeset
46 : fcn (), nm (n) { }
f8c27dad3643 [project @ 2004-09-17 11:42:04 by jwe]
jwe
parents: 4988
diff changeset
47
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
48 octave_fcn_handle (const octave_value& f, const std::string& n)
4933
cd58733c326b [project @ 2004-08-05 16:08:28 by jwe]
jwe
parents: 4930
diff changeset
49 : fcn (f), nm (n) { }
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
50
4967
0355f2f7d193 [project @ 2004-09-07 15:09:14 by jwe]
jwe
parents: 4933
diff changeset
51 octave_fcn_handle (const octave_fcn_handle& fh)
0355f2f7d193 [project @ 2004-09-07 15:09:14 by jwe]
jwe
parents: 4933
diff changeset
52 : octave_base_value (fh), fcn (fh.fcn), nm (fh.nm) { }
0355f2f7d193 [project @ 2004-09-07 15:09:14 by jwe]
jwe
parents: 4933
diff changeset
53
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
54 ~octave_fcn_handle (void) { }
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
55
4967
0355f2f7d193 [project @ 2004-09-07 15:09:14 by jwe]
jwe
parents: 4933
diff changeset
56 octave_value *clone (void) const { return new octave_fcn_handle (*this); }
0355f2f7d193 [project @ 2004-09-07 15:09:14 by jwe]
jwe
parents: 4933
diff changeset
57 octave_value *empty_clone (void) const { return new octave_fcn_handle (); }
0355f2f7d193 [project @ 2004-09-07 15:09:14 by jwe]
jwe
parents: 4933
diff changeset
58
4924
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
59 octave_value subsref (const std::string&,
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
60 const std::list<octave_value_list>&)
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
61 {
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
62 panic_impossible ();
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
63 return octave_value ();
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
64 }
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
65
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
66 octave_value_list subsref (const std::string& type,
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
67 const std::list<octave_value_list>& idx,
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
68 int nargout);
9a3a32f5a27d [project @ 2004-08-02 19:04:20 by jwe]
jwe
parents: 4898
diff changeset
69
4925
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
70 bool is_defined (void) const { return true; }
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
71
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
72 bool is_function_handle (void) const { return true; }
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
73
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
74 octave_function *function_value (bool = false)
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
75 { return fcn.function_value (); }
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
76
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
77 octave_fcn_handle *fcn_handle_value (bool = false) { return this; }
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
78
5007
f8c27dad3643 [project @ 2004-09-17 11:42:04 by jwe]
jwe
parents: 4988
diff changeset
79 octave_value fcn_val (void) const { return fcn; }
f8c27dad3643 [project @ 2004-09-17 11:42:04 by jwe]
jwe
parents: 4988
diff changeset
80
4933
cd58733c326b [project @ 2004-08-05 16:08:28 by jwe]
jwe
parents: 4930
diff changeset
81 std::string fcn_name (void) const { return nm; }
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
82
4988
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
83 bool save_ascii (std::ostream& os, bool& infnan_warned,
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
84 bool strip_nan_and_inf);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
85
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
86 bool load_ascii (std::istream& is);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
87
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
88 bool save_binary (std::ostream& os, bool& save_as_floats);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
89
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
90 bool load_binary (std::istream& is, bool swap,
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
91 oct_mach_info::float_format fmt);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
92
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
93 #if defined (HAVE_HDF5)
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
94 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
95
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
96 bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
97 #endif
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4967
diff changeset
98
4654
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
99 void print (std::ostream& os, bool pr_as_read_syntax = false) const;
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
100
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
101 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
102
a9b22513b7a6 [project @ 2003-11-24 18:56:35 by jwe]
jwe
parents: 4649
diff changeset
103 private:
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
104
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4346
diff changeset
105 DECLARE_OCTAVE_ALLOCATOR
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
106
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4346
diff changeset
107 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
4925
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
108
4933
cd58733c326b [project @ 2004-08-05 16:08:28 by jwe]
jwe
parents: 4930
diff changeset
109 protected:
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
110
4925
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
111 // The function we are handling.
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4925
diff changeset
112 octave_value fcn;
4925
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
113
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
114 // The name of the handle, including the "@".
90f51232d751 [project @ 2004-08-02 22:09:47 by jwe]
jwe
parents: 4924
diff changeset
115 std::string nm;
4343
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
116 };
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
117
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
118 extern octave_value make_fcn_handle (const std::string& nm);
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
119
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
120 #endif
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
121
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
122 /*
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
123 ;;; Local Variables: ***
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
124 ;;; mode: C++ ***
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
125 ;;; End: ***
db5e0814277a [project @ 2003-02-20 16:44:16 by jwe]
jwe
parents:
diff changeset
126 */