annotate src/ov-bool.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 bd32f770c09a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
1 /*
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
2
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
4
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
6
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
10 later version.
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
11
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
15 for more details.
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
16
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
20
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
21 */
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
22
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
23 #if !defined (octave_bool_h)
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
24 #define octave_bool_h 1
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
25
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
26 #include <cstdlib>
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
27
3503
d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe]
jwe
parents: 3223
diff changeset
28 #include <iostream>
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
29 #include <string>
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
30
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
31 #include "lo-utils.h"
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
32 #include "mx-base.h"
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
33 #include "oct-alloc.h"
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
34 #include "str-vec.h"
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
35
4970
25c2664861bc [project @ 2004-09-08 05:02:32 by jwe]
jwe
parents: 4915
diff changeset
36 #include "oct-stream.h"
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
37 #include "ov-base.h"
3223
3ee04ff37b3e [project @ 1998-11-20 19:34:15 by jwe]
jwe
parents: 3219
diff changeset
38 #include "ov-base-scalar.h"
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
39 #include "ov-typeinfo.h"
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
40
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
41 class Octave_map;
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
42 class octave_value_list;
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
43
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
44 class tree_walker;
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
45
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
46 // Real scalar values.
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
47
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
48 class
3223
3ee04ff37b3e [project @ 1998-11-20 19:34:15 by jwe]
jwe
parents: 3219
diff changeset
49 octave_bool : public octave_base_scalar<bool>
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
50 {
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
51 public:
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
52
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
53 octave_bool (void)
3223
3ee04ff37b3e [project @ 1998-11-20 19:34:15 by jwe]
jwe
parents: 3219
diff changeset
54 : octave_base_scalar<bool> (false) { }
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
55
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
56 octave_bool (bool b)
3223
3ee04ff37b3e [project @ 1998-11-20 19:34:15 by jwe]
jwe
parents: 3219
diff changeset
57 : octave_base_scalar<bool> (b) { }
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
58
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
59 octave_bool (const octave_bool& s)
3223
3ee04ff37b3e [project @ 1998-11-20 19:34:15 by jwe]
jwe
parents: 3219
diff changeset
60 : octave_base_scalar<bool> (s) { }
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
61
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
62 ~octave_bool (void) { }
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
63
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3503
diff changeset
64 octave_value *clone (void) const { return new octave_bool (*this); }
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3503
diff changeset
65 octave_value *empty_clone (void) const { return new octave_bool (); }
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
66
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
67 type_conv_fcn numeric_conversion_function (void) const;
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
68
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3503
diff changeset
69 octave_value do_index_op (const octave_value_list& idx, int resize_ok);
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
70
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
71 idx_vector index_vector (void) const { return idx_vector (scalar); }
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
72
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
73 bool is_real_scalar (void) const { return true; }
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
74
3209
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe]
jwe
parents: 3203
diff changeset
75 bool is_bool_type (void) const { return true; }
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe]
jwe
parents: 3203
diff changeset
76
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
77 bool is_real_type (void) const { return true; }
3209
fbb332b96e4f [project @ 1998-11-03 20:48:54 by jwe]
jwe
parents: 3203
diff changeset
78
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
79 bool valid_as_scalar_index (void) const { return scalar; }
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
80
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
81 bool valid_as_zero_index (void) const { return ! scalar; }
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
82
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
83 bool is_true (void) const { return scalar; }
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
84
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
85 double double_value (bool = false) const { return scalar; }
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
86
2916
4e7bea116f24 [project @ 1997-04-30 20:56:31 by jwe]
jwe
parents: 2911
diff changeset
87 double scalar_value (bool = false) const { return scalar; }
4e7bea116f24 [project @ 1997-04-30 20:56:31 by jwe]
jwe
parents: 2911
diff changeset
88
3145
0d640dc625c7 [project @ 1998-02-05 08:44:59 by jwe]
jwe
parents: 2974
diff changeset
89 Matrix matrix_value (bool = false) const
0d640dc625c7 [project @ 1998-02-05 08:44:59 by jwe]
jwe
parents: 2974
diff changeset
90 { return Matrix (1, 1, scalar); }
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
91
4630
ca70857bdbd1 [project @ 2003-11-18 18:18:16 by jwe]
jwe
parents: 4612
diff changeset
92 NDArray array_value (bool = false) const
ca70857bdbd1 [project @ 2003-11-18 18:18:16 by jwe]
jwe
parents: 4612
diff changeset
93 { return NDArray (dim_vector (1, 1), scalar); }
ca70857bdbd1 [project @ 2003-11-18 18:18:16 by jwe]
jwe
parents: 4612
diff changeset
94
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
95 Complex complex_value (bool = false) const { return scalar; }
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
96
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
97 ComplexMatrix complex_matrix_value (bool = false) const
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
98 { return ComplexMatrix (1, 1, Complex (scalar)); }
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
99
4630
ca70857bdbd1 [project @ 2003-11-18 18:18:16 by jwe]
jwe
parents: 4612
diff changeset
100 ComplexNDArray complex_array_value (bool = false) const
ca70857bdbd1 [project @ 2003-11-18 18:18:16 by jwe]
jwe
parents: 4612
diff changeset
101 { return ComplexNDArray (dim_vector (1, 1), Complex (scalar)); }
ca70857bdbd1 [project @ 2003-11-18 18:18:16 by jwe]
jwe
parents: 4612
diff changeset
102
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
103 bool bool_value (void) const { return scalar; }
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
104
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
105 boolMatrix bool_matrix_value (void) const
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
106 { return boolMatrix (1, 1, scalar); }
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
107
4847
83ddfedb8db7 [project @ 2004-04-02 21:15:34 by jwe]
jwe
parents: 4687
diff changeset
108 boolNDArray bool_array_value (void) const
83ddfedb8db7 [project @ 2004-04-02 21:15:34 by jwe]
jwe
parents: 4687
diff changeset
109 { return boolNDArray (dim_vector (1, 1), scalar); }
83ddfedb8db7 [project @ 2004-04-02 21:15:34 by jwe]
jwe
parents: 4687
diff changeset
110
4915
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe]
jwe
parents: 4847
diff changeset
111 octave_value resize (const dim_vector& dv) const
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe]
jwe
parents: 4847
diff changeset
112 { boolNDArray retval (dv); if (dv.numel()) retval(0) = scalar; return retval; }
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe]
jwe
parents: 4847
diff changeset
113
4457
d7d9ca19960a [project @ 2003-07-11 03:05:38 by jwe]
jwe
parents: 4452
diff changeset
114 octave_value convert_to_str_internal (bool pad, bool force) const;
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
115
4687
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
116 bool save_ascii (std::ostream& os, bool& infnan_warned,
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
117 bool strip_nan_and_inf);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
118
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
119 bool load_ascii (std::istream& is);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
120
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
121 bool save_binary (std::ostream& os, bool& save_as_floats);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
122
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
123 bool load_binary (std::istream& is, bool swap,
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
124 oct_mach_info::float_format fmt);
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
125
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
126 #if defined (HAVE_HDF5)
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
127 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: 4630
diff changeset
128
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
129 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: 4630
diff changeset
130 #endif
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe]
jwe
parents: 4630
diff changeset
131
4970
25c2664861bc [project @ 2004-09-08 05:02:32 by jwe]
jwe
parents: 4915
diff changeset
132 int write (octave_stream& os, int block_size,
25c2664861bc [project @ 2004-09-08 05:02:32 by jwe]
jwe
parents: 4915
diff changeset
133 oct_data_conv::data_type output_type, int skip,
25c2664861bc [project @ 2004-09-08 05:02:32 by jwe]
jwe
parents: 4915
diff changeset
134 oct_mach_info::float_format flt_fmt) const
25c2664861bc [project @ 2004-09-08 05:02:32 by jwe]
jwe
parents: 4915
diff changeset
135 {
25c2664861bc [project @ 2004-09-08 05:02:32 by jwe]
jwe
parents: 4915
diff changeset
136 return os.write (bool_array_value (), block_size, output_type,
25c2664861bc [project @ 2004-09-08 05:02:32 by jwe]
jwe
parents: 4915
diff changeset
137 skip, flt_fmt);
25c2664861bc [project @ 2004-09-08 05:02:32 by jwe]
jwe
parents: 4915
diff changeset
138 }
25c2664861bc [project @ 2004-09-08 05:02:32 by jwe]
jwe
parents: 4915
diff changeset
139
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
140 private:
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
141
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4457
diff changeset
142 DECLARE_OCTAVE_ALLOCATOR
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
143
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4457
diff changeset
144 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
2871
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
145 };
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
146
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
147 #endif
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
148
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
149 /*
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
150 ;;; Local Variables: ***
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
151 ;;; mode: C++ ***
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
152 ;;; End: ***
c691fdf6bebb [project @ 1997-04-19 01:26:38 by jwe]
jwe
parents:
diff changeset
153 */