GNU Octave  4.2.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
ov-scalar.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1996-2017 John W. Eaton
4 
5 This file is part of Octave.
6 
7 Octave is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3 of the License, or (at your
10 option) any later version.
11 
12 Octave is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with Octave; see the file COPYING. If not, see
19 <http://www.gnu.org/licenses/>.
20 
21 */
22 
23 #if ! defined (octave_ov_scalar_h)
24 #define octave_ov_scalar_h 1
25 
26 #include "octave-config.h"
27 
28 #include <cstdlib>
29 
30 #include <iosfwd>
31 #include <string>
32 
33 #include "lo-ieee.h"
34 #include "lo-mappers.h"
35 #include "lo-utils.h"
36 #include "mx-base.h"
37 #include "str-vec.h"
38 
39 #include "errwarn.h"
40 #include "ov-base.h"
41 #include "ov-re-mat.h"
42 #include "ov-base-scalar.h"
43 #include "ov-typeinfo.h"
44 
45 class octave_value_list;
46 
47 class tree_walker;
48 
49 // Real scalar values.
50 
51 class
54 {
55 public:
56 
58  : octave_base_scalar<double> (0.0) { }
59 
60  octave_scalar (double d)
61  : octave_base_scalar<double> (d) { }
62 
64  : octave_base_scalar<double> (s) { }
65 
66  ~octave_scalar (void) { }
67 
68  octave_base_value *clone (void) const { return new octave_scalar (*this); }
69 
70  // We return an octave_matrix here instead of an octave_scalar so
71  // that in expressions like A(2,2,2) = 2 (for A previously
72  // undefined), A will be empty instead of a 1x1 object.
73  octave_base_value *empty_clone (void) const { return new octave_matrix (); }
74 
75  octave_value do_index_op (const octave_value_list& idx,
76  bool resize_ok = false);
77 
78  type_conv_info numeric_demotion_function (void) const;
79 
80  idx_vector index_vector (bool /* require_integers */ = false) const { return idx_vector (scalar); }
81 
82  octave_value any (int = 0) const
83  { return (scalar != 0 && ! lo_ieee_isnan (scalar)); }
84 
85  builtin_type_t builtin_type (void) const { return btyp_double; }
86 
87  bool is_real_scalar (void) const { return true; }
88 
89  bool is_real_type (void) const { return true; }
90 
91  bool is_double_type (void) const { return true; }
92 
93  bool is_float_type (void) const { return true; }
94 
96  int8_array_value (void) const
97  { return int8NDArray (dim_vector (1, 1), scalar); }
98 
100  int16_array_value (void) const
101  { return int16NDArray (dim_vector (1, 1), scalar); }
102 
104  int32_array_value (void) const
105  { return int32NDArray (dim_vector (1, 1), scalar); }
106 
108  int64_array_value (void) const
109  { return int64NDArray (dim_vector (1, 1), scalar); }
110 
112  uint8_array_value (void) const
113  { return uint8NDArray (dim_vector (1, 1), scalar); }
114 
116  uint16_array_value (void) const
117  { return uint16NDArray (dim_vector (1, 1), scalar); }
118 
120  uint32_array_value (void) const
121  { return uint32NDArray (dim_vector (1, 1), scalar); }
122 
124  uint64_array_value (void) const
125  { return uint64NDArray (dim_vector (1, 1), scalar); }
126 
127 #define DEFINE_INT_SCALAR_VALUE(TYPE) \
128  octave_ ## TYPE \
129  TYPE ## _scalar_value (void) const \
130  { \
131  return octave_ ## TYPE (scalar); \
132  }
133 
142 
143 #undef DEFINE_INT_SCALAR_VALUE
144 
145  double double_value (bool = false) const { return scalar; }
146 
147  float float_value (bool = false) const
148  { return static_cast<float> (scalar); }
149 
150  double scalar_value (bool = false) const { return scalar; }
151 
152  float float_scalar_value (bool = false) const
153  { return static_cast<float> (scalar); }
154 
155  Matrix matrix_value (bool = false) const
156  { return Matrix (1, 1, scalar); }
157 
158  FloatMatrix float_matrix_value (bool = false) const
159  { return FloatMatrix (1, 1, scalar); }
160 
161  NDArray array_value (bool = false) const
162  { return NDArray (dim_vector (1, 1), scalar); }
163 
164  FloatNDArray float_array_value (bool = false) const
165  { return FloatNDArray (dim_vector (1, 1), scalar); }
166 
167  SparseMatrix sparse_matrix_value (bool = false) const
168  { return SparseMatrix (Matrix (1, 1, scalar)); }
169 
170  // FIXME: Need SparseComplexMatrix (Matrix) constructor!
172  { return SparseComplexMatrix (sparse_matrix_value ()); }
173 
174  octave_value resize (const dim_vector& dv, bool fill = false) const;
175 
176  Complex complex_value (bool = false) const { return scalar; }
177 
178  FloatComplex float_complex_value (bool = false) const { return scalar; }
179 
180  ComplexMatrix complex_matrix_value (bool = false) const
181  { return ComplexMatrix (1, 1, Complex (scalar)); }
182 
184  { return FloatComplexMatrix (1, 1, FloatComplex (scalar)); }
185 
186  ComplexNDArray complex_array_value (bool = false) const
187  { return ComplexNDArray (dim_vector (1, 1), Complex (scalar)); }
188 
190  { return FloatComplexNDArray (dim_vector (1, 1), FloatComplex (scalar)); }
191 
193  char_array_value (bool = false) const
194  {
195  charNDArray retval (dim_vector (1, 1));
196  retval(0) = static_cast<char> (scalar);
197  return retval;
198  }
199 
200  bool bool_value (bool warn = false) const
201  {
204  if (warn && scalar != 0 && scalar != 1)
206 
207  return scalar;
208  }
209 
210  boolNDArray bool_array_value (bool warn = false) const
211  {
214  if (warn && scalar != 0 && scalar != 1)
216 
217  return boolNDArray (dim_vector (1, 1), scalar);
218  }
219 
220  octave_value as_double (void) const;
221  octave_value as_single (void) const;
222 
223  octave_value as_int8 (void) const;
224  octave_value as_int16 (void) const;
225  octave_value as_int32 (void) const;
226  octave_value as_int64 (void) const;
227 
228  octave_value as_uint8 (void) const;
229  octave_value as_uint16 (void) const;
230  octave_value as_uint32 (void) const;
231  octave_value as_uint64 (void) const;
232 
234 
235  octave_value convert_to_str_internal (bool pad, bool force, char type) const;
236 
237  void increment (void) { ++scalar; }
238 
239  void decrement (void) { --scalar; }
240 
241  bool save_ascii (std::ostream& os);
242 
243  bool load_ascii (std::istream& is);
244 
245  bool save_binary (std::ostream& os, bool& save_as_floats);
246 
247  bool load_binary (std::istream& is, bool swap,
249 
250  bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats);
251 
252  bool load_hdf5 (octave_hdf5_id loc_id, const char *name);
253 
254  int write (octave_stream& os, int block_size,
255  oct_data_conv::data_type output_type, int skip,
257  {
258  return os.write (array_value (), block_size, output_type,
259  skip, flt_fmt);
260  }
261 
262  mxArray *as_mxArray (void) const;
263 
264  octave_value map (unary_mapper_t umap) const;
265 
266  bool fast_elem_insert_self (void *where, builtin_type_t btyp) const;
267 
268 private:
269 
271 };
272 
273 #endif
Matrix matrix_value(bool=false) const
Definition: ov-scalar.h:155
octave_scalar(void)
Definition: ov-scalar.h:57
intNDArray< octave_int64 > int64NDArray
Definition: int64NDArray.h:33
bool is_double_type(void) const
Definition: ov-scalar.h:91
ComplexNDArray complex_array_value(bool=false) const
Definition: ov-scalar.h:186
Complex complex_value(bool=false) const
Definition: ov-scalar.h:176
nd group nd example oindent but is performed more efficiently If only and it is a scalar
Definition: data.cc:5342
octave_scalar(double d)
Definition: ov-scalar.h:60
octave_idx_type write(const octave_value &data, octave_idx_type block_size, oct_data_conv::data_type output_type, octave_idx_type skip, octave::mach_info::float_format flt_fmt)
Definition: oct-stream.cc:6647
builtin_type_t builtin_type(void) const
Definition: ov-scalar.h:85
OCTAVE_EXPORT octave_value_list uint16
Definition: ov.cc:1258
void warn_logical_conversion(void)
Definition: errwarn.cc:353
double scalar_value(bool=false) const
Definition: ov-scalar.h:150
idx_vector index_vector(bool=false) const
Definition: ov-scalar.h:80
#define DEFINE_INT_SCALAR_VALUE(TYPE)
Definition: ov-scalar.h:127
intNDArray< octave_uint32 > uint32NDArray
Definition: uint32NDArray.h:33
intNDArray< octave_uint8 > uint8NDArray
Definition: uint8NDArray.h:33
intNDArray< octave_uint16 > uint16NDArray
Definition: uint16NDArray.h:33
bool isnan(double x)
Definition: lo-mappers.cc:347
int16NDArray int16_array_value(void) const
Definition: ov-scalar.h:100
boolNDArray bool_array_value(bool warn=false) const
Definition: ov-scalar.h:210
octave_base_value * clone(void) const
Definition: ov-scalar.h:68
SparseComplexMatrix sparse_complex_matrix_value(bool=false) const
Definition: ov-scalar.h:171
uint16NDArray uint16_array_value(void) const
Definition: ov-scalar.h:116
int32NDArray int32_array_value(void) const
Definition: ov-scalar.h:104
charNDArray char_array_value(bool=false) const
Definition: ov-scalar.h:193
octave::mach_info::float_format flt_fmt
Definition: load-save.cc:723
uint64NDArray uint64_array_value(void) const
Definition: ov-scalar.h:124
float float_value(bool=false) const
Definition: ov-scalar.h:147
SparseMatrix sparse_matrix_value(bool=false) const
Definition: ov-scalar.h:167
FloatComplexNDArray float_complex_array_value(bool=false) const
Definition: ov-scalar.h:189
intNDArray< octave_int16 > int16NDArray
Definition: int16NDArray.h:33
uint32NDArray uint32_array_value(void) const
Definition: ov-scalar.h:120
s
Definition: file-io.cc:2682
builtin_type_t
Definition: ov-base.h:61
void err_nan_to_logical_conversion(void)
int write(octave_stream &os, int block_size, oct_data_conv::data_type output_type, int skip, octave::mach_info::float_format flt_fmt) const
Definition: ov-scalar.h:254
F77_RET_T F77_REAL &F77_RET_T F77_DBLE &F77_RET_T F77_REAL &F77_RET_T F77_DBLE &F77_RET_T F77_REAL &F77_RET_T F77_DBLE &F77_RET_T const F77_REAL const F77_REAL F77_REAL &F77_RET_T const F77_DBLE const F77_DBLE F77_DBLE &F77_RET_T F77_REAL &F77_RET_T F77_DBLE &F77_RET_T F77_DBLE &F77_RET_T F77_REAL &F77_RET_T F77_REAL &F77_RET_T F77_DBLE &F77_RET_T const F77_DBLE F77_DBLE &F77_RET_T const F77_REAL F77_REAL &F77_RET_T F77_REAL F77_REAL &F77_RET_T F77_DBLE F77_DBLE &F77_RET_T const F77_DBLE const F77_DBLE F77_DBLE * d
#define lo_ieee_isnan(x)
Definition: lo-ieee.h:103
octave_scalar(const octave_scalar &s)
Definition: ov-scalar.h:63
bool swap
Definition: load-save.cc:725
#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
Definition: ov-base.h:148
OCTAVE_EXPORT octave_value_list any number nd example oindent prints the prompt xample Pick a any number!nd example oindent and waits for the user to enter a value The string entered by the user is evaluated as an so it may be a literal a variable name
Definition: input.cc:871
bool bool_value(bool warn=false) const
Definition: ov-scalar.h:200
#define OCTINTERP_API
Definition: mexproto.h:69
~octave_scalar(void)
Definition: ov-scalar.h:66
intNDArray< octave_int8 > int8NDArray
Definition: int8NDArray.h:33
OCTAVE_EXPORT octave_value_list uint32
Definition: ov.cc:1258
nd deftypefn *octave_map m
Definition: ov-struct.cc:2058
OCTAVE_EXPORT octave_value_list int16
Definition: ov.cc:1302
bool save_as_floats
Definition: load-save.cc:1581
octave_value retval
Definition: data.cc:6294
OCTAVE_EXPORT octave_value_list int32
Definition: ov.cc:1258
int64_t octave_hdf5_id
FloatComplex float_complex_value(bool=false) const
Definition: ov-scalar.h:178
idx type
Definition: ov.cc:3129
Definition: dMatrix.h:37
FloatNDArray float_array_value(bool=false) const
Definition: ov-scalar.h:164
void increment(void)
Definition: ov-scalar.h:237
OCTAVE_EXPORT octave_value_list int64
Definition: ov.cc:1258
int8NDArray int8_array_value(void) const
Definition: ov-scalar.h:96
double double_value(bool=false) const
Definition: ov-scalar.h:145
intNDArray< octave_int32 > int32NDArray
Definition: int32NDArray.h:33
FloatComplexMatrix float_complex_matrix_value(bool=false) const
Definition: ov-scalar.h:183
octave_value any(int=0) const
Definition: ov-scalar.h:82
octave_map map(dims)
uint8NDArray uint8_array_value(void) const
Definition: ov-scalar.h:112
issues an error eealso double
Definition: ov-bool-mat.cc:594
bool is_real_type(void) const
Definition: ov-scalar.h:89
bool is_float_type(void) const
Definition: ov-scalar.h:93
bool is_real_scalar(void) const
Definition: ov-scalar.h:87
std::complex< float > FloatComplex
Definition: oct-cmplx.h:32
std::complex< double > Complex
Definition: oct-cmplx.h:31
write the output to stdout if nargout is
Definition: load-save.cc:1576
int64NDArray int64_array_value(void) const
Definition: ov-scalar.h:108
FloatMatrix float_matrix_value(bool=false) const
Definition: ov-scalar.h:158
Vector representing the dimensions (size) of an Array.
Definition: dim-vector.h:87
NDArray array_value(bool=false) const
Definition: ov-scalar.h:161
float float_scalar_value(bool=false) const
Definition: ov-scalar.h:152
octave_base_value * empty_clone(void) const
Definition: ov-scalar.h:73
dim_vector dv
Definition: sub2ind.cc:263
void decrement(void)
Definition: ov-scalar.h:239
ComplexMatrix complex_matrix_value(bool=false) const
Definition: ov-scalar.h:180
intNDArray< octave_uint64 > uint64NDArray
Definition: uint64NDArray.h:33