annotate src/ov-list.h @ 8950:d865363208d6

include <iosfwd> instead of <iostream> in header files
author John W. Eaton <jwe@octave.org>
date Tue, 10 Mar 2009 13:55:52 -0400
parents eb63fbe60fab
children b3089dba88bf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
1 /*
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
2
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 1996, 1997, 1998, 2000, 2002, 2003, 2004, 2005, 2006,
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 7651
diff changeset
4 2007, 2008 John W. Eaton
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
5
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
7
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6974
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6974
diff changeset
11 option) any later version.
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
12
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
16 for more details.
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
17
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6974
diff changeset
19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6974
diff changeset
20 <http://www.gnu.org/licenses/>.
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
21
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
22 */
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
23
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_list_h)
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
25 #define octave_list_h 1
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
26
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
27 #include <cstdlib>
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
28
8950
d865363208d6 include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
29 #include <iosfwd>
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
30 #include <string>
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
31
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
32 #include "mx-base.h"
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
33 #include "str-vec.h"
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
34
4591
2c9de1be042a [project @ 2003-11-11 00:23:35 by jwe]
jwe
parents: 4563
diff changeset
35 #include "Cell.h"
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
36 #include "error.h"
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
37 #include "oct-alloc.h"
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
38 #include "ov-base.h"
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
39 #include "ov-typeinfo.h"
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
40
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
41 class tree_walker;
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
42
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
43 // Lists.
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
44
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
45 class
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
46 octave_list : public octave_base_value
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
47 {
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
48 public:
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
49
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
50 octave_list (void)
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
51 : octave_base_value () { }
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
52
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
53 octave_list (const octave_value_list& l)
4591
2c9de1be042a [project @ 2003-11-11 00:23:35 by jwe]
jwe
parents: 4563
diff changeset
54 : octave_base_value (), data (l) { }
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
55
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4499
diff changeset
56 octave_list (const Cell& c);
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4499
diff changeset
57
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
58 octave_list (const octave_list& l)
4591
2c9de1be042a [project @ 2003-11-11 00:23:35 by jwe]
jwe
parents: 4563
diff changeset
59 : octave_base_value (), data (l.data) { }
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
60
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
61 ~octave_list (void) { }
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
62
5759
ce79d238f142 [project @ 2006-04-13 13:04:32 by jwe]
jwe
parents: 5307
diff changeset
63 octave_base_value *clone (void) const { return new octave_list (*this); }
ce79d238f142 [project @ 2006-04-13 13:04:32 by jwe]
jwe
parents: 5307
diff changeset
64 octave_base_value *empty_clone (void) const { return new octave_list (); }
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
65
7651
443a8f5a50fd require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
66 octave_value subsref (const std::string& type,
443a8f5a50fd require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
67 const std::list<octave_value_list>& idx)
4271
be631c1720ea [project @ 2003-01-03 19:36:04 by jwe]
jwe
parents: 4247
diff changeset
68 {
7651
443a8f5a50fd require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
69 octave_value_list tmp = subsref (type, idx, 1);
443a8f5a50fd require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
70 return tmp.length () > 0 ? tmp(0) : octave_value ();
4271
be631c1720ea [project @ 2003-01-03 19:36:04 by jwe]
jwe
parents: 4247
diff changeset
71 }
be631c1720ea [project @ 2003-01-03 19:36:04 by jwe]
jwe
parents: 4247
diff changeset
72
4994
48d0defe9445 [project @ 2004-09-15 20:31:31 by jwe]
jwe
parents: 4791
diff changeset
73 octave_value_list subsref (const std::string& type,
48d0defe9445 [project @ 2004-09-15 20:31:31 by jwe]
jwe
parents: 4791
diff changeset
74 const std::list<octave_value_list>& idx,
48d0defe9445 [project @ 2004-09-15 20:31:31 by jwe]
jwe
parents: 4791
diff changeset
75 int nargout);
48d0defe9445 [project @ 2004-09-15 20:31:31 by jwe]
jwe
parents: 4791
diff changeset
76
5885
bd3041e30d97 [project @ 2006-07-14 20:29:35 by jwe]
jwe
parents: 5759
diff changeset
77 octave_value do_index_op (const octave_value_list& idx,
bd3041e30d97 [project @ 2006-07-14 20:29:35 by jwe]
jwe
parents: 5759
diff changeset
78 bool resize_ok = false);
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
79
4247
fc9a075d10fb [project @ 2002-12-30 23:05:27 by jwe]
jwe
parents: 4219
diff changeset
80 octave_value subsasgn (const std::string& type,
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4192
diff changeset
81 const std::list<octave_value_list>& idx,
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
82 const octave_value& rhs);
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
83
3196
3ac3e8edc258 [project @ 1998-10-28 23:04:39 by jwe]
jwe
parents: 2974
diff changeset
84 void assign (const octave_value_list& idx, const octave_value& rhs);
3ac3e8edc258 [project @ 1998-10-28 23:04:39 by jwe]
jwe
parents: 2974
diff changeset
85
4591
2c9de1be042a [project @ 2003-11-11 00:23:35 by jwe]
jwe
parents: 4563
diff changeset
86 dim_vector dims (void) const { return dim_vector (1, data.length ()); }
4559
802818bfac91 [project @ 2003-10-28 19:13:43 by jwe]
jwe
parents: 4513
diff changeset
87
4791
62f2fb593455 [project @ 2004-02-20 18:02:59 by jwe]
jwe
parents: 4687
diff changeset
88 size_t byte_size (void) const;
62f2fb593455 [project @ 2004-02-20 18:02:59 by jwe]
jwe
parents: 4687
diff changeset
89
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
90 bool is_defined (void) const { return true; }
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
91
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
92 bool is_list (void) const { return true; }
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
93
4591
2c9de1be042a [project @ 2003-11-11 00:23:35 by jwe]
jwe
parents: 4563
diff changeset
94 octave_value_list list_value (void) const;
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
95
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
96 void print (std::ostream& os, bool pr_as_read_syntax = false) const;
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents: 2882
diff changeset
97
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
98 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents: 2882
diff changeset
99
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
100 bool print_name_tag (std::ostream& os, const std::string& name) const;
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
101
6974
9e32bb109980 [project @ 2007-10-08 11:06:47 by jwe]
jwe
parents: 5958
diff changeset
102 bool save_ascii (std::ostream& os);
4687
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
103
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
104 bool load_ascii (std::istream& is);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
105
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
106 bool save_binary (std::ostream& os, bool& save_as_floats);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
107
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
108 bool load_binary (std::istream& is, bool swap,
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
109 oct_mach_info::float_format fmt);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
110
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
111 #if defined (HAVE_HDF5)
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
112 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
113
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
114 bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
115 #endif
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4661
diff changeset
116
4499
55695bf73797 [project @ 2003-09-05 19:56:37 by jwe]
jwe
parents: 4271
diff changeset
117 protected:
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
118
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
119 // The list of Octave values.
4591
2c9de1be042a [project @ 2003-11-11 00:23:35 by jwe]
jwe
parents: 4563
diff changeset
120 Cell data;
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
121
4499
55695bf73797 [project @ 2003-09-05 19:56:37 by jwe]
jwe
parents: 4271
diff changeset
122 private:
55695bf73797 [project @ 2003-09-05 19:56:37 by jwe]
jwe
parents: 4271
diff changeset
123
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4591
diff changeset
124 DECLARE_OCTAVE_ALLOCATOR
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
125
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4591
diff changeset
126 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
2882
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
127 };
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
128
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
129 #endif
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
130
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
131 /*
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
132 ;;; Local Variables: ***
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
133 ;;; mode: C++ ***
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
134 ;;; End: ***
05926e1b367d [project @ 1997-04-24 09:48:59 by jwe]
jwe
parents:
diff changeset
135 */