Mercurial > hg > octave-lyh
annotate src/ov-range.h @ 7503:8c32f95c2639
convert mapper functions to new format
| author | David Bateman <dbateman@free.fr> |
|---|---|
| date | Wed, 20 Feb 2008 04:22:50 -0500 |
| parents | 2467639bd8c0 |
| children | 7ebdc99a0bab |
| rev | line source |
|---|---|
| 2376 | 1 /* |
| 2 | |
| 7017 | 3 Copyright (C) 1996, 1997, 1998, 2000, 2002, 2003, 2004, 2005, 2006, |
| 4 2007 John W. Eaton | |
| 2376 | 5 |
| 6 This file is part of Octave. | |
| 7 | |
| 8 Octave is free software; you can redistribute it and/or modify it | |
| 9 under the terms of the GNU General Public License as published by the | |
| 7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
| 11 option) any later version. | |
| 2376 | 12 |
| 13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 16 for more details. | |
| 17 | |
| 18 You should have received a copy of the GNU General Public License | |
| 7016 | 19 along with Octave; see the file COPYING. If not, see |
| 20 <http://www.gnu.org/licenses/>. | |
| 2376 | 21 |
| 22 */ | |
| 23 | |
| 24 #if !defined (octave_range_h) | |
| 25 #define octave_range_h 1 | |
| 26 | |
| 27 #include <cstdlib> | |
| 28 | |
| 3503 | 29 #include <iostream> |
| 2376 | 30 #include <string> |
| 31 | |
| 32 #include "Range.h" | |
| 33 | |
| 2889 | 34 #include "lo-mappers.h" |
| 2376 | 35 #include "lo-utils.h" |
| 36 #include "mx-base.h" | |
| 2477 | 37 #include "oct-alloc.h" |
| 2376 | 38 #include "str-vec.h" |
| 39 | |
| 40 #include "error.h" | |
| 5051 | 41 #include "oct-stream.h" |
| 2376 | 42 #include "ov-base.h" |
| 6127 | 43 #include "ov-re-mat.h" |
| 2376 | 44 #include "ov-typeinfo.h" |
| 45 | |
| 46 class Octave_map; | |
| 47 class octave_value_list; | |
| 48 | |
| 49 class tree_walker; | |
| 50 | |
| 51 // Range values. | |
| 52 | |
| 53 class | |
| 54 octave_range : public octave_base_value | |
| 55 { | |
| 56 public: | |
| 57 | |
| 58 octave_range (void) | |
| 59 : octave_base_value () { } | |
| 60 | |
| 61 octave_range (double base, double limit, double inc) | |
| 62 : octave_base_value (), range (base, limit, inc) | |
| 63 { | |
| 64 if (range.nelem () < 0) | |
| 65 ::error ("invalid range"); | |
| 66 } | |
| 67 | |
| 68 octave_range (const Range& r) | |
| 69 : octave_base_value (), range (r) | |
| 70 { | |
| 71 if (range.nelem () < 0) | |
| 72 ::error ("invalid range"); | |
| 73 } | |
| 74 | |
| 75 octave_range (const octave_range& r) | |
| 76 : octave_base_value (), range (r.range) { } | |
| 77 | |
| 78 ~octave_range (void) { } | |
| 79 | |
| 5759 | 80 octave_base_value *clone (void) const { return new octave_range (*this); } |
| 6127 | 81 |
| 82 // A range is really just a special kind of real matrix object. In | |
| 83 // the places where we need to call empty_clone, it makes more sense | |
| 84 // to create an empty matrix (0x0) instead of an empty range (1x0). | |
| 85 octave_base_value *empty_clone (void) const { return new octave_matrix (); } | |
| 2376 | 86 |
| 2410 | 87 type_conv_fcn numeric_conversion_function (void) const; |
| 88 | |
| 5759 | 89 octave_base_value *try_narrowing_conversion (void); |
| 2376 | 90 |
| 4247 | 91 octave_value subsref (const std::string& type, |
| 4219 | 92 const std::list<octave_value_list>& idx); |
| 3933 | 93 |
| 4661 | 94 octave_value_list subsref (const std::string&, |
| 95 const std::list<octave_value_list>&, int) | |
| 4271 | 96 { |
| 97 panic_impossible (); | |
| 98 return octave_value_list (); | |
| 99 } | |
| 100 | |
| 5885 | 101 octave_value do_index_op (const octave_value_list& idx, |
| 102 bool resize_ok = false); | |
| 2436 | 103 |
| 2376 | 104 idx_vector index_vector (void) const { return idx_vector (range); } |
| 105 | |
| 4563 | 106 dim_vector dims (void) const |
| 5275 | 107 { |
| 108 octave_idx_type n = range.nelem (); | |
| 4563 | 109 return dim_vector (n > 0, n); |
| 110 } | |
| 3195 | 111 |
| 5731 | 112 octave_value resize (const dim_vector& dv, bool fill = false) const; |
| 113 | |
| 4915 | 114 |
| 4792 | 115 size_t byte_size (void) const { return 3 * sizeof (double); } |
| 4791 | 116 |
| 4627 | 117 octave_value reshape (const dim_vector& new_dims) const |
| 4901 | 118 { return NDArray (array_value().reshape (new_dims)); } |
| 4627 | 119 |
| 5434 | 120 octave_value permute (const Array<int>& vec, bool inv = false) const |
| 121 { return NDArray (array_value().permute (vec, inv)); } | |
| 122 | |
| 6999 | 123 octave_value squeeze (void) const { return range; } |
| 124 | |
| 2376 | 125 bool is_defined (void) const { return true; } |
| 126 | |
| 2974 | 127 bool is_constant (void) const { return true; } |
| 128 | |
| 2376 | 129 bool is_range (void) const { return true; } |
| 130 | |
| 4017 | 131 octave_value all (int dim = 0) const; |
| 132 | |
| 133 octave_value any (int dim = 0) const; | |
| 2376 | 134 |
|
7463
2467639bd8c0
eliminate UNDEFINED sort mode
John W. Eaton <jwe@octave.org>
parents:
7458
diff
changeset
|
135 octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const |
| 7458 | 136 { return range.sort (dim, mode); } |
| 137 | |
| 138 octave_value sort (Array<octave_idx_type>& sidx, octave_idx_type dim = 0, | |
|
7463
2467639bd8c0
eliminate UNDEFINED sort mode
John W. Eaton <jwe@octave.org>
parents:
7458
diff
changeset
|
139 sortmode mode = ASCENDING) const |
| 7458 | 140 { return range.sort (sidx, dim, mode); } |
| 141 | |
| 2376 | 142 bool is_real_type (void) const { return true; } |
| 143 | |
| 5895 | 144 bool is_double_type (void) const { return true; } |
| 145 | |
| 2376 | 146 bool valid_as_scalar_index (void) const |
| 147 { | |
| 5042 | 148 double b = range.base (); |
| 2376 | 149 return (range.nelem () == 1 |
| 5275 | 150 && ! xisnan (b) && D_NINT (b) == b && NINTbig (b) == 1); |
| 2376 | 151 } |
| 152 | |
| 153 bool valid_as_zero_index (void) const | |
| 154 { | |
| 5042 | 155 double b = range.base (); |
| 2376 | 156 return (range.nelem () == 1 |
| 5275 | 157 && ! xisnan (b) && D_NINT (b) == b && NINTbig (b) == 0); |
| 2376 | 158 } |
| 159 | |
| 3678 | 160 bool is_numeric_type (void) const { return true; } |
| 161 | |
| 2376 | 162 bool is_true (void) const; |
| 163 | |
| 3145 | 164 double double_value (bool = false) const; |
| 2376 | 165 |
| 3145 | 166 double scalar_value (bool frc_str_conv = false) const |
| 167 { return double_value (frc_str_conv); } | |
| 2916 | 168 |
| 3145 | 169 Matrix matrix_value (bool = false) const |
| 2376 | 170 { return range.matrix_value (); } |
| 171 | |
| 4668 | 172 NDArray array_value (bool = false) const |
| 173 { return range.matrix_value (); } | |
| 174 | |
| 6934 | 175 // FIXME -- it would be better to have Range::intXNDArray_value |
| 176 // functions to avoid the intermediate conversion to a matrix | |
| 177 // object. | |
| 178 | |
| 6932 | 179 int8NDArray |
| 180 int8_array_value (void) const { return int8NDArray (array_value ()); } | |
| 181 | |
| 182 int16NDArray | |
| 183 int16_array_value (void) const { return int16NDArray (array_value ()); } | |
| 184 | |
| 185 int32NDArray | |
| 186 int32_array_value (void) const { return int32NDArray (array_value ()); } | |
| 187 | |
| 188 int64NDArray | |
| 189 int64_array_value (void) const { return int64NDArray (array_value ()); } | |
| 190 | |
| 191 uint8NDArray | |
| 192 uint8_array_value (void) const { return uint8NDArray (array_value ()); } | |
| 193 | |
| 194 uint16NDArray | |
| 195 uint16_array_value (void) const { return uint16NDArray (array_value ()); } | |
| 196 | |
| 197 uint32NDArray | |
| 198 uint32_array_value (void) const { return uint32NDArray (array_value ()); } | |
| 199 | |
| 200 uint64NDArray | |
| 201 uint64_array_value (void) const { return uint64NDArray (array_value ()); } | |
| 202 | |
| 6928 | 203 SparseMatrix sparse_matrix_value (bool = false) const |
| 204 { return SparseMatrix (range.matrix_value ()); } | |
| 205 | |
| 206 SparseComplexMatrix sparse_complex_matrix_value (bool = false) const | |
| 207 { return SparseComplexMatrix (sparse_matrix_value ()); } | |
| 208 | |
| 3145 | 209 Complex complex_value (bool = false) const; |
| 2376 | 210 |
| 5943 | 211 boolNDArray bool_array_value (bool warn = false) const |
| 212 { | |
| 213 Matrix m = range.matrix_value (); | |
| 214 | |
| 215 if (warn && m.any_element_not_one_or_zero ()) | |
| 216 gripe_logical_conversion (); | |
| 217 | |
| 218 return boolNDArray (m); | |
| 219 } | |
| 5898 | 220 |
| 3145 | 221 ComplexMatrix complex_matrix_value (bool = false) const |
| 3587 | 222 { return ComplexMatrix (range.matrix_value ()); } |
| 2376 | 223 |
| 4668 | 224 ComplexNDArray complex_array_value (bool = false) const |
| 225 { return ComplexMatrix (range.matrix_value ()); } | |
| 226 | |
| 2376 | 227 Range range_value (void) const { return range; } |
| 228 | |
| 5279 | 229 octave_value convert_to_str_internal (bool pad, bool force, char type) const; |
| 2449 | 230 |
| 3523 | 231 void print (std::ostream& os, bool pr_as_read_syntax = false) const; |
| 2901 | 232 |
| 3523 | 233 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; |
| 2901 | 234 |
| 3523 | 235 bool print_name_tag (std::ostream& os, const std::string& name) const; |
| 2376 | 236 |
| 6974 | 237 bool save_ascii (std::ostream& os); |
| 4687 | 238 |
| 239 bool load_ascii (std::istream& is); | |
| 240 | |
| 241 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 242 | |
| 243 bool load_binary (std::istream& is, bool swap, | |
| 244 oct_mach_info::float_format fmt); | |
| 245 | |
| 246 #if defined (HAVE_HDF5) | |
| 247 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 248 | |
| 249 bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug); | |
| 250 #endif | |
| 251 | |
| 5051 | 252 int write (octave_stream& os, int block_size, |
| 253 oct_data_conv::data_type output_type, int skip, | |
| 254 oct_mach_info::float_format flt_fmt) const | |
| 255 { | |
| 5775 | 256 // FIXME -- could be more memory efficient by having a |
| 5051 | 257 // special case of the octave_stream::write method for ranges. |
| 258 | |
| 259 return os.write (matrix_value (), block_size, output_type, skip, | |
| 260 flt_fmt); | |
| 261 } | |
| 262 | |
| 5900 | 263 mxArray *as_mxArray (void) const; |
| 264 | |
|
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
265 // Mapper functions are converted to double for treatment |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
266 #define RANGE_MAPPER(MAP) \ |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
267 octave_value MAP (void) const \ |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
268 { \ |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
269 octave_matrix m (array_value ()); \ |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
270 return m.MAP (); \ |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
271 } |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
272 |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
273 RANGE_MAPPER (abs) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
274 RANGE_MAPPER (acos) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
275 RANGE_MAPPER (acosh) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
276 RANGE_MAPPER (angle) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
277 RANGE_MAPPER (arg) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
278 RANGE_MAPPER (asin) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
279 RANGE_MAPPER (asinh) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
280 RANGE_MAPPER (atan) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
281 RANGE_MAPPER (atanh) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
282 RANGE_MAPPER (ceil) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
283 RANGE_MAPPER (conj) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
284 RANGE_MAPPER (cos) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
285 RANGE_MAPPER (cosh) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
286 RANGE_MAPPER (erf) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
287 RANGE_MAPPER (erfc) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
288 RANGE_MAPPER (exp) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
289 RANGE_MAPPER (finite) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
290 RANGE_MAPPER (fix) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
291 RANGE_MAPPER (floor) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
292 RANGE_MAPPER (gamma) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
293 RANGE_MAPPER (imag) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
294 RANGE_MAPPER (isinf) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
295 RANGE_MAPPER (isna) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
296 RANGE_MAPPER (isnan) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
297 RANGE_MAPPER (lgamma) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
298 RANGE_MAPPER (log) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
299 RANGE_MAPPER (log10) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
300 RANGE_MAPPER (real) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
301 RANGE_MAPPER (round) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
302 RANGE_MAPPER (signum) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
303 RANGE_MAPPER (sin) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
304 RANGE_MAPPER (sinh) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
305 RANGE_MAPPER (sqrt) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
306 RANGE_MAPPER (tan) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
307 RANGE_MAPPER (tanh) |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
308 |
| 2376 | 309 private: |
| 310 | |
| 311 Range range; | |
| 312 | |
| 4612 | 313 DECLARE_OCTAVE_ALLOCATOR |
| 2477 | 314 |
| 4612 | 315 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
| 2376 | 316 }; |
| 317 | |
| 318 #endif | |
| 319 | |
| 320 /* | |
| 321 ;;; Local Variables: *** | |
| 322 ;;; mode: C++ *** | |
| 323 ;;; End: *** | |
| 324 */ |