GNU Octave  4.4.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
ov-scalar.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1996-2018 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
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11 
12 Octave is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License 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 <https://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 // Real scalar values.
48 
49 class
50 OCTINTERP_API
52 {
53 public:
54 
56  : octave_base_scalar<double> (0.0) { }
57 
58  octave_scalar (double d)
59  : octave_base_scalar<double> (d) { }
60 
62  : octave_base_scalar<double> (s) { }
63 
64  ~octave_scalar (void) = default;
65 
66  octave_base_value * clone (void) const { return new octave_scalar (*this); }
67 
68  // We return an octave_matrix here instead of an octave_scalar so
69  // that in expressions like A(2,2,2) = 2 (for A previously
70  // undefined), A will be empty instead of a 1x1 object.
71  octave_base_value * empty_clone (void) const { return new octave_matrix (); }
72 
73  octave_value do_index_op (const octave_value_list& idx,
74  bool resize_ok = false);
75 
76  type_conv_info numeric_demotion_function (void) const;
77 
78  idx_vector index_vector (bool /* require_integers */ = false) const { return idx_vector (scalar); }
79 
80  octave_value any (int = 0) const
81  { return (scalar != 0 && ! lo_ieee_isnan (scalar)); }
82 
83  builtin_type_t builtin_type (void) const { return btyp_double; }
84 
85  bool is_real_scalar (void) const { return true; }
86 
87  bool isreal (void) const { return true; }
88 
89  bool is_double_type (void) const { return true; }
90 
91  bool isfloat (void) const { return true; }
92 
94  int8_array_value (void) const
95  { return int8NDArray (dim_vector (1, 1), scalar); }
96 
98  int16_array_value (void) const
99  { return int16NDArray (dim_vector (1, 1), scalar); }
100 
102  int32_array_value (void) const
103  { return int32NDArray (dim_vector (1, 1), scalar); }
104 
106  int64_array_value (void) const
107  { return int64NDArray (dim_vector (1, 1), scalar); }
108 
110  uint8_array_value (void) const
111  { return uint8NDArray (dim_vector (1, 1), scalar); }
112 
114  uint16_array_value (void) const
115  { return uint16NDArray (dim_vector (1, 1), scalar); }
116 
118  uint32_array_value (void) const
119  { return uint32NDArray (dim_vector (1, 1), scalar); }
120 
122  uint64_array_value (void) const
123  { return uint64NDArray (dim_vector (1, 1), scalar); }
124 
125 #define DEFINE_INT_SCALAR_VALUE(TYPE) \
126  octave_ ## TYPE \
127  TYPE ## _scalar_value (void) const \
128  { \
129  return octave_ ## TYPE (scalar); \
130  }
131 
140 
141 #undef DEFINE_INT_SCALAR_VALUE
142 
143  double double_value (bool = false) const { return scalar; }
144 
145  float float_value (bool = false) const
146  { return static_cast<float> (scalar); }
147 
148  double scalar_value (bool = false) const { return scalar; }
149 
150  float float_scalar_value (bool = false) const
151  { return float_value (); }
152 
153  Matrix matrix_value (bool = false) const
154  { return Matrix (1, 1, scalar); }
155 
156  FloatMatrix float_matrix_value (bool = false) const
157  { return FloatMatrix (1, 1, float_value ()); }
158 
159  NDArray array_value (bool = false) const
160  { return NDArray (dim_vector (1, 1), scalar); }
161 
162  FloatNDArray float_array_value (bool = false) const
163  { return FloatNDArray (dim_vector (1, 1), float_value ()); }
164 
165  SparseMatrix sparse_matrix_value (bool = false) const
166  { return SparseMatrix (Matrix (1, 1, scalar)); }
167 
168  // FIXME: Need SparseComplexMatrix (Matrix) constructor!
170  { return SparseComplexMatrix (sparse_matrix_value ()); }
171 
172  octave_value resize (const dim_vector& dv, bool fill = false) const;
173 
174  Complex complex_value (bool = false) const { return scalar; }
175 
176  FloatComplex float_complex_value (bool = false) const
177  { return FloatComplex (float_value ()); }
178 
179  ComplexMatrix complex_matrix_value (bool = false) const
180  { return ComplexMatrix (1, 1, Complex (scalar)); }
181 
183  { return FloatComplexMatrix (1, 1, FloatComplex (float_value ())); }
184 
185  ComplexNDArray complex_array_value (bool = false) const
186  { return ComplexNDArray (dim_vector (1, 1), Complex (scalar)); }
187 
189  {
190  return FloatComplexNDArray (dim_vector (1, 1),
191  FloatComplex (float_value ()));
192  }
193 
195  char_array_value (bool = false) const
196  {
197  charNDArray retval (dim_vector (1, 1));
198  retval(0) = static_cast<char> (scalar);
199  return retval;
200  }
201 
202  bool bool_value (bool warn = false) const
203  {
206  if (warn && scalar != 0 && scalar != 1)
208 
209  return scalar;
210  }
211 
212  boolNDArray bool_array_value (bool warn = false) const
213  {
216  if (warn && scalar != 0 && scalar != 1)
218 
219  return boolNDArray (dim_vector (1, 1), scalar);
220  }
221 
222  octave_value as_double (void) const;
223  octave_value as_single (void) const;
224 
225  octave_value as_int8 (void) const;
226  octave_value as_int16 (void) const;
227  octave_value as_int32 (void) const;
228  octave_value as_int64 (void) const;
229 
230  octave_value as_uint8 (void) const;
231  octave_value as_uint16 (void) const;
232  octave_value as_uint32 (void) const;
233  octave_value as_uint64 (void) const;
234 
235  octave_value diag (octave_idx_type m, octave_idx_type n) const;
236 
237  octave_value convert_to_str_internal (bool pad, bool force, char type) const;
238 
239  void increment (void) { ++scalar; }
240 
241  void decrement (void) { --scalar; }
242 
243  bool save_ascii (std::ostream& os);
244 
245  bool load_ascii (std::istream& is);
246 
247  bool save_binary (std::ostream& os, bool& save_as_floats);
248 
249  bool load_binary (std::istream& is, bool swap,
251 
252  bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats);
253 
254  bool load_hdf5 (octave_hdf5_id loc_id, const char *name);
255 
256  int write (octave::stream& os, int block_size,
257  oct_data_conv::data_type output_type, int skip,
259  {
260  return os.write (array_value (), block_size, output_type,
261  skip, flt_fmt);
262  }
263 
264  mxArray * as_mxArray (void) const;
265 
266  octave_value map (unary_mapper_t umap) const;
267 
268  bool fast_elem_insert_self (void *where, builtin_type_t btyp) const;
269 
270 private:
271 
273 };
274 
275 #endif
octave_idx_type write(const octave_value &data, octave_idx_type block_size, oct_data_conv::data_type output_type, octave_idx_type skip, mach_info::float_format flt_fmt)
Definition: oct-stream.cc:6704
bool is_real_scalar(void) const
Definition: ov-scalar.h:85
Matrix matrix_value(bool=false) const
Definition: ov-scalar.h:153
octave_scalar(void)
Definition: ov-scalar.h:55
FloatNDArray float_array_value(bool=false) const
Definition: ov-scalar.h:162
float float_scalar_value(bool=false) const
Definition: ov-scalar.h:150
intNDArray< octave_int64 > int64NDArray
Definition: int64NDArray.h:33
uint8NDArray uint8_array_value(void) const
Definition: ov-scalar.h:110
float float_value(bool=false) const
Definition: ov-scalar.h:145
nd group nd example oindent but is performed more efficiently If only and it is a scalar
Definition: data.cc:5264
double scalar_value(bool=false) const
Definition: ov-scalar.h:148
octave_scalar(double d)
Definition: ov-scalar.h:58
void warn_logical_conversion(void)
Definition: errwarn.cc:359
idx_vector index_vector(bool=false) const
Definition: ov-scalar.h:78
#define DEFINE_INT_SCALAR_VALUE(TYPE)
Definition: ov-scalar.h:125
intNDArray< octave_uint32 > uint32NDArray
Definition: uint32NDArray.h:33
bool isreal(void) const
Definition: ov-scalar.h:87
intNDArray< octave_uint8 > uint8NDArray
Definition: uint8NDArray.h:33
intNDArray< octave_uint16 > uint16NDArray
Definition: uint16NDArray.h:33
bool isnan(bool)
Definition: lo-mappers.h:187
FloatComplex float_complex_value(bool=false) const
Definition: ov-scalar.h:176
int64NDArray int64_array_value(void) const
Definition: ov-scalar.h:106
octave::mach_info::float_format flt_fmt
Definition: load-save.cc:736
ComplexNDArray complex_array_value(bool=false) const
Definition: ov-scalar.h:185
intNDArray< octave_int16 > int16NDArray
Definition: int16NDArray.h:33
charNDArray char_array_value(bool=false) const
Definition: ov-scalar.h:195
s
Definition: file-io.cc:2729
builtin_type_t
Definition: ov-base.h:71
void err_nan_to_logical_conversion(void)
uint32NDArray uint32_array_value(void) const
Definition: ov-scalar.h:118
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 const F77_DBLE F77_DBLE &F77_RET_T const F77_REAL F77_REAL &F77_RET_T const F77_DBLE const F77_DBLE F77_DBLE * d
#define lo_ieee_isnan(x)
Definition: lo-ieee.h:105
octave_scalar(const octave_scalar &s)
Definition: ov-scalar.h:61
static double as_double(time_t sec, long usec)
Definition: oct-time.h:34
bool swap
Definition: load-save.cc:738
NDArray array_value(bool=false) const
Definition: ov-scalar.h:159
#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
Definition: ov-base.h:158
nd deftypefn *std::string name
Definition: sysdep.cc:647
double double_value(bool=false) const
Definition: ov-scalar.h:143
intNDArray< octave_int8 > int8NDArray
Definition: int8NDArray.h:33
octave_base_value * clone(void) const
Definition: ov-scalar.h:66
int8NDArray int8_array_value(void) const
Definition: ov-scalar.h:94
Array< octave_value > array_value(void) const
Definition: ovl.h:86
uint64NDArray uint64_array_value(void) const
Definition: ov-scalar.h:122
bool save_as_floats
Definition: load-save.cc:1617
bool bool_value(bool warn=false) const
Definition: ov-scalar.h:202
octave_value retval
Definition: data.cc:6246
int64_t octave_hdf5_id
idx type
Definition: ov.cc:3114
boolNDArray bool_array_value(bool warn=false) const
Definition: ov-scalar.h:212
Definition: dMatrix.h:36
void increment(void)
Definition: ov-scalar.h:239
int16NDArray int16_array_value(void) const
Definition: ov-scalar.h:98
intNDArray< octave_int32 > int32NDArray
Definition: int32NDArray.h:33
int32NDArray int32_array_value(void) const
Definition: ov-scalar.h:102
bool is_double_type(void) const
Definition: ov-scalar.h:89
octave_map map(dims)
octave_base_value * empty_clone(void) const
Definition: ov-scalar.h:71
FloatMatrix float_matrix_value(bool=false) const
Definition: ov-scalar.h:156
SparseComplexMatrix sparse_complex_matrix_value(bool=false) const
Definition: ov-scalar.h:169
Complex complex_value(bool=false) const
Definition: ov-scalar.h:174
ComplexMatrix complex_matrix_value(bool=false) const
Definition: ov-scalar.h:179
octave_value any(int=0) const
Definition: ov-scalar.h:80
void resize(octave_idx_type n, const octave_value &rfv=octave_value())
Definition: ovl.h:100
std::complex< float > FloatComplex
Definition: oct-cmplx.h:32
SparseMatrix sparse_matrix_value(bool=false) const
Definition: ov-scalar.h:165
std::complex< double > Complex
Definition: oct-cmplx.h:31
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:256
write the output to stdout if nargout is
Definition: load-save.cc:1612
FloatComplexNDArray float_complex_array_value(bool=false) const
Definition: ov-scalar.h:188
Vector representing the dimensions (size) of an Array.
Definition: dim-vector.h:87
uint16NDArray uint16_array_value(void) const
Definition: ov-scalar.h:114
builtin_type_t builtin_type(void) const
Definition: ov-scalar.h:83
dim_vector dv
Definition: sub2ind.cc:263
FloatComplexMatrix float_complex_matrix_value(bool=false) const
Definition: ov-scalar.h:182
octave::stream os
Definition: file-io.cc:627
void decrement(void)
Definition: ov-scalar.h:241
intNDArray< octave_uint64 > uint64NDArray
Definition: uint64NDArray.h:33
bool isfloat(void) const
Definition: ov-scalar.h:91