Mercurial > octave
annotate libinterp/corefcn/variables.h @ 21721:bcc30b45a225
define octave_numeric_limits template methods for Inf and NaN
* lo-ieee.h (octave_numeric_limits::Inf, octave_numeric_limits::NaN):
New methods.
* Canvas.cc, data.cc, graphics.cc, graphics.in.h, oct-handle.h,
oct-stream.cc, quadcc.cc, sparse-xdiv.cc, str2double.cc, variables.h,
__glpk__.cc, __init_fltk__.cc, __voronoi__.cc, octave.cc, Matrix.cc,
CNDArray.cc, CSparse.cc, Sparse-C.cc, dDiagMatrix.cc, dMatrix.cc,
dSparse.cc, fCMatrix.cc, fCNDArray.cc, fDiagMatrix.cc, fMatrix.cc,
Faddeeva.cc, eigs-base.cc, lo-mappers.cc, lo-mappers.h, lo-specfun.cc,
oct-norm.cc, oct-rand.cc, oct-rand.h, oct-spparms.cc, randgamma.cc,
randpoisson.cc: Use them instead of octave_Inf, octave_Float_Inf,
octave_NaN, and octave_Float_NaN.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 17 May 2016 01:11:27 -0400 |
parents | 987c1a79d33f |
children | bae585228161 |
rev | line source |
---|---|
1 | 1 /* |
2 | |
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17787
diff
changeset
|
3 Copyright (C) 1993-2015 John W. Eaton |
1 | 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 | |
7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
10 option) any later version. | |
1 | 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 | |
7016 | 18 along with Octave; see the file COPYING. If not, see |
19 <http://www.gnu.org/licenses/>. | |
1 | 20 |
21 */ | |
22 | |
20791
f7084eae3318
maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
23 #if ! defined (octave_variables_h) |
383 | 24 #define octave_variables_h 1 |
1 | 25 |
21244
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
21134
diff
changeset
|
26 #include "octave-config.h" |
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
21134
diff
changeset
|
27 |
2975 | 28 class octave_function; |
4700 | 29 class octave_user_function; |
1738 | 30 |
2390 | 31 class tree_identifier; |
2086 | 32 class octave_value; |
33 class octave_value_list; | |
2892 | 34 class octave_builtin; |
1755 | 35 class string_vector; |
36 | |
5794 | 37 #include <cfloat> |
38 | |
15215
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
39 #include <limits> |
1755 | 40 #include <string> |
1 | 41 |
15215
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
42 #include "lo-ieee.h" |
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
43 |
2390 | 44 #include "ov.h" |
2975 | 45 #include "ov-builtin.h" |
2953 | 46 #include "symtab.h" |
195 | 47 |
6109 | 48 extern OCTINTERP_API void clear_mex_functions (void); |
195 | 49 |
6109 | 50 extern OCTINTERP_API octave_function * |
21017
93748bcaec17
maint: Replace emtpy 'std::string ()' calls with "".
Rik <rik@octave.org>
parents:
21012
diff
changeset
|
51 is_valid_function (const octave_value&, const std::string& = "", |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
52 bool warn = false); |
593 | 53 |
6109 | 54 extern OCTINTERP_API octave_function * |
21017
93748bcaec17
maint: Replace emtpy 'std::string ()' calls with "".
Rik <rik@octave.org>
parents:
21012
diff
changeset
|
55 is_valid_function (const std::string&, const std::string& = "", |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
56 bool warn = false); |
3178 | 57 |
6109 | 58 extern OCTINTERP_API octave_function * |
3523 | 59 extract_function (const octave_value& arg, const std::string& warn_for, |
10313 | 60 const std::string& fname, const std::string& header, |
61 const std::string& trailer); | |
2796 | 62 |
6109 | 63 extern OCTINTERP_API string_vector |
3523 | 64 get_struct_elts (const std::string& text); |
2921 | 65 |
6109 | 66 extern OCTINTERP_API string_vector |
3523 | 67 generate_struct_completions (const std::string& text, std::string& prefix, |
10313 | 68 std::string& hint); |
3020 | 69 |
6109 | 70 extern OCTINTERP_API bool |
3523 | 71 looks_like_struct (const std::string& text); |
2921 | 72 |
6109 | 73 extern OCTINTERP_API int |
4930 | 74 symbol_exist (const std::string& name, const std::string& type = "any"); |
4319 | 75 |
6109 | 76 extern OCTINTERP_API std::string |
4954 | 77 unique_symbol_name (const std::string& basename); |
78 | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
79 extern OCTINTERP_API octave_value |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
80 lookup_function_handle (const std::string& nm); |
4988 | 81 |
6109 | 82 extern OCTINTERP_API octave_value |
5027 | 83 get_global_value (const std::string& nm, bool silent = false); |
3020 | 84 |
10071
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
85 extern OCTINTERP_API void |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
86 set_global_value (const std::string& nm, const octave_value& val); |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
87 |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
88 extern OCTINTERP_API octave_value |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
89 get_top_level_value (const std::string& nm, bool silent = false); |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
90 |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
91 extern OCTINTERP_API void |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
92 set_top_level_value (const std::string& nm, const octave_value& val); |
3020 | 93 |
6109 | 94 extern OCTINTERP_API octave_value |
5791 | 95 set_internal_variable (bool& var, const octave_value_list& args, |
10313 | 96 int nargout, const char *nm); |
5794 | 97 |
6109 | 98 extern OCTINTERP_API octave_value |
5794 | 99 set_internal_variable (char& var, const octave_value_list& args, |
10313 | 100 int nargout, const char *nm); |
5794 | 101 |
6109 | 102 extern OCTINTERP_API octave_value |
5794 | 103 set_internal_variable (int& var, const octave_value_list& args, |
10313 | 104 int nargout, const char *nm, |
15215
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
105 int minval = std::numeric_limits<int>::min (), |
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
106 int maxval = std::numeric_limits<int>::max ()); |
5794 | 107 |
6109 | 108 extern OCTINTERP_API octave_value |
5794 | 109 set_internal_variable (double& var, const octave_value_list& args, |
10313 | 110 int nargout, const char *nm, |
21721
bcc30b45a225
define octave_numeric_limits template methods for Inf and NaN
John W. Eaton <jwe@octave.org>
parents:
21272
diff
changeset
|
111 double minval = -octave_numeric_limits<double>::Inf (), |
bcc30b45a225
define octave_numeric_limits template methods for Inf and NaN
John W. Eaton <jwe@octave.org>
parents:
21272
diff
changeset
|
112 double maxval = octave_numeric_limits<double>::Inf ()); |
5791 | 113 |
6109 | 114 extern OCTINTERP_API octave_value |
5791 | 115 set_internal_variable (std::string& var, const octave_value_list& args, |
10313 | 116 int nargout, const char *nm, bool empty_ok = true); |
5794 | 117 |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
118 extern OCTINTERP_API octave_value |
21272
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
119 set_internal_variable (std::string& var, const octave_value_list& args, |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
120 int nargout, const char *nm, const char **choices); |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
121 |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
122 extern OCTINTERP_API octave_value |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
123 set_internal_variable (int& var, const octave_value_list& args, |
10640
5c594472f75e
determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents:
10638
diff
changeset
|
124 int nargout, const char *nm, const char **choices); |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
125 |
5794 | 126 #define SET_INTERNAL_VARIABLE(NM) \ |
127 set_internal_variable (V ## NM, args, nargout, #NM) | |
5791 | 128 |
5794 | 129 #define SET_NONEMPTY_INTERNAL_STRING_VARIABLE(NM) \ |
130 set_internal_variable (V ## NM, args, nargout, #NM, false) | |
131 | |
132 #define SET_INTERNAL_VARIABLE_WITH_LIMITS(NM, MINVAL, MAXVAL) \ | |
133 set_internal_variable (V ## NM, args, nargout, #NM, MINVAL, MAXVAL) | |
5791 | 134 |
10640
5c594472f75e
determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents:
10638
diff
changeset
|
135 // in the following, CHOICES must be a C string array terminated by null. |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
136 #define SET_INTERNAL_VARIABLE_CHOICES(NM, CHOICES) \ |
10640
5c594472f75e
determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents:
10638
diff
changeset
|
137 set_internal_variable (V ## NM, args, nargout, #NM, CHOICES) |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
138 |
6109 | 139 extern OCTINTERP_API std::string builtin_string_variable (const std::string&); |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
140 extern OCTINTERP_API int builtin_real_scalar_variable (const std::string&, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
141 double&); |
6109 | 142 extern OCTINTERP_API octave_value builtin_any_variable (const std::string&); |
3020 | 143 |
6109 | 144 extern OCTINTERP_API void bind_ans (const octave_value& val, bool print); |
1162 | 145 |
21134
2e5c1f766ac9
provide replacement hints for deprecated C++ functions
John W. Eaton <jwe@octave.org>
parents:
21040
diff
changeset
|
146 OCTAVE_DEPRECATED ("note: internal variables have been replaced by functions; use 'feval' instead") |
2e5c1f766ac9
provide replacement hints for deprecated C++ functions
John W. Eaton <jwe@octave.org>
parents:
21040
diff
changeset
|
147 OCTINTERP_API extern void |
2e5c1f766ac9
provide replacement hints for deprecated C++ functions
John W. Eaton <jwe@octave.org>
parents:
21040
diff
changeset
|
148 bind_internal_variable (const std::string& fname, const octave_value& val); |
1406 | 149 |
7336 | 150 extern OCTINTERP_API void mlock (void); |
6109 | 151 extern OCTINTERP_API void munlock (const std::string&); |
152 extern OCTINTERP_API bool mislocked (const std::string&); | |
4016 | 153 |
7336 | 154 extern OCTINTERP_API void clear_function (const std::string& nm); |
155 extern OCTINTERP_API void clear_variable (const std::string& nm); | |
156 extern OCTINTERP_API void clear_symbol (const std::string& nm); | |
4009 | 157 |
10443
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
158 extern OCTINTERP_API void maybe_missing_function_hook (const std::string& name); |
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
159 |
1 | 160 #endif |