Mercurial > octave

comparison liboctave/util/lo-array-errwarn.cc @ 21100:e39e05d90788

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. * libinterp/corefcn/errwarn.h, libinterp/corefcn/errwarn.cc: New header and .cc file with common errors and warnings for libinterp. * libinterp/corefcn/module.mk: Add errwarn.h, errwarn.cc to build system. * liboctave/util/lo-array-errwarn.h, liboctave/util/lo-array-errwarn.cc: New header and .cc file with common errors and warnings for liboctave. * liboctave/util/module.mk: Add lo-array-errwarn.h, lo-array-errwarn.cc to build system. * lo-array-gripes.h: #include "lo-array-errwarn.h" for access to class index_exception. Remove const char *error_id_XXX prototypes. * lo-array-gripes.cc: Remove const char *error_id_XXX initializations. Remove index_exception method definitions. * Cell.cc, __pchip_deriv__.cc, __qp__.cc, balance.cc, betainc.cc, cellfun.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc, eig.cc, fft.cc, fft2.cc, fftn.cc, find.cc, gammainc.cc, gcd.cc, getgrent.cc, getpwent.cc, graphics.in.h, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, jit-typeinfo.cc, load-save.cc, lookup.cc, ls-hdf5.cc, ls-mat-ascii.cc, ls-mat4.cc, ls-mat5.cc, ls-oct-binary.cc, ls-oct-text.cc, lsode.cc, lu.cc, luinc.cc, max.cc, mgorth.cc, oct-hist.cc, oct-procbuf.cc, oct-stream.cc, oct.h, pager.cc, pinv.cc, pr-output.cc, quad.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sparse-xdiv.cc, sparse-xpow.cc, sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, syscalls.cc, typecast.cc, utils.cc, variables.cc, xdiv.cc, xnorm.cc, xpow.cc, __eigs__.cc, __glpk__.cc, __magick_read__.cc, __osmesa_print__.cc, audiodevinfo.cc, audioread.cc, chol.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc, ov-base-diag.cc, ov-base-int.cc, ov-base-mat.cc, ov-base-scalar.cc, ov-base-sparse.cc, ov-base.cc, ov-bool-mat.cc, ov-bool-sparse.cc, ov-bool.cc, ov-builtin.cc, ov-cell.cc, ov-ch-mat.cc, ov-class.cc, ov-complex.cc, ov-complex.h, ov-cs-list.cc, ov-cx-diag.cc, ov-cx-mat.cc, ov-cx-sparse.cc, ov-fcn-handle.cc, ov-fcn-inline.cc, ov-float.cc, ov-float.h, ov-flt-complex.cc, ov-flt-complex.h, ov-flt-cx-diag.cc, ov-flt-cx-mat.cc, ov-flt-re-mat.cc, ov-int16.cc, ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-intx.h, ov-mex-fcn.cc, ov-perm.cc, ov-range.cc, ov-re-mat.cc, ov-re-sparse.cc, ov-scalar.cc, ov-scalar.h, ov-str-mat.cc, ov-struct.cc, ov-type-conv.h, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc, ov-usr-fcn.cc, ov.cc, op-b-b.cc, op-b-bm.cc, op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc, op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc, op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc, op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc, op-dms-template.cc, op-double-conv.cc, op-fcdm-fcdm.cc, op-fcdm-fdm.cc, op-fcm-fcm.cc, op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc, op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc, op-float-conv.cc, op-fm-fcm.cc, op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc, op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc, op-i8-i8.cc, op-int-concat.cc, op-int-conv.cc, op-int.h, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc, op-m-scm.cc, op-m-sm.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc, op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc, op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc, op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc, op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc, op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc, op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, ops.h, lex.ll, pt-assign.cc, pt-eval.cc, pt-idx.cc, pt-loop.cc, pt-mat.cc, pt-stmt.cc, Array-util.cc, Array-util.h, Array.cc, CColVector.cc, CDiagMatrix.cc, CMatrix.cc, CNDArray.cc, CRowVector.cc, CSparse.cc, DiagArray2.cc, MDiagArray2.cc, MSparse.cc, PermMatrix.cc, Range.cc, Sparse.cc, dColVector.cc, dDiagMatrix.cc, dMatrix.cc, dNDArray.cc, dRowVector.cc, dSparse.cc, fCColVector.cc, fCDiagMatrix.cc, fCMatrix.cc, fCNDArray.cc, fCRowVector.cc, fColVector.cc, fDiagMatrix.cc, fMatrix.cc, fNDArray.cc, fRowVector.cc, idx-vector.cc, CmplxGEPBAL.cc, dbleGEPBAL.cc, fCmplxGEPBAL.cc, floatGEPBAL.cc, Sparse-diag-op-defs.h, Sparse-op-defs.h, Sparse-perm-op-defs.h, mx-inlines.cc, mx-op-defs.h, oct-binmap.h: Replace 'include "gripes.h"' with 'include "errwarn.h". Change all gripe_XXX to err_XXX or warn_XXX or errwarn_XXX.
author Rik <rik@octave.org>
date Mon, 18 Jan 2016 18:28:06 -0800
parents
children 7bb96a8df912
comparison
equal deleted inserted replaced
21099:52af4092f863 21100:e39e05d90788
1 /*
2
3 Copyright (C) 2016 Rik Wehbring
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 #ifdef HAVE_CONFIG_H
24 #include <config.h>
25 #endif
26
27 #include <sstream>
28
29 #include "lo-array-errwarn.h"
30 #include "lo-error.h"
31
32 const char *error_id_nonconformant_args = "Octave:nonconformant-args";
33
34 const char *error_id_index_out_of_bounds = "Octave:index-out-of-bounds";
35
36 const char *error_id_invalid_index = "Octave:invalid-index";
37
38 const char *warning_id_nearly_singular_matrix = "Octave:nearly-singular-matrix";
39
40 const char *warning_id_singular_matrix = "Octave:singular-matrix";
41
42 void
43 err_nan_to_logical_conversion (void)
44 {
45 (*current_liboctave_error_handler)
46 ("invalid conversion from NaN to logical");
47 }
48
49 void
50 err_nan_to_character_conversion (void)
51 {
52 (*current_liboctave_error_handler)
53 ("invalid conversion from NaN to character");
54 }
55
56 void
57 err_nonconformant (const char *op,
58 octave_idx_type op1_len, octave_idx_type op2_len)
59 {
60 const char *err_id = error_id_nonconformant_args;
61
62 (*current_liboctave_error_with_id_handler)
63 (err_id, "%s: nonconformant arguments (op1 len: %d, op2 len: %d)",
64 op, op1_len, op2_len);
65 }
66
67 void
68 err_nonconformant (const char *op,
69 octave_idx_type op1_nr, octave_idx_type op1_nc,
70 octave_idx_type op2_nr, octave_idx_type op2_nc)
71 {
72 const char *err_id = error_id_nonconformant_args;
73
74 (*current_liboctave_error_with_id_handler)
75 (err_id, "%s: nonconformant arguments (op1 is %dx%d, op2 is %dx%d)",
76 op, op1_nr, op1_nc, op2_nr, op2_nc);
77 }
78
79 void
80 err_nonconformant (const char *op,
81 const dim_vector& op1_dims, const dim_vector& op2_dims)
82 {
83 const char *err_id = error_id_nonconformant_args;
84
85 std::string op1_dims_str = op1_dims.str ();
86 std::string op2_dims_str = op2_dims.str ();
87
88 (*current_liboctave_error_with_id_handler)
89 (err_id, "%s: nonconformant arguments (op1 is %s, op2 is %s)",
90 op, op1_dims_str.c_str (), op2_dims_str.c_str ());
91 }
92
93 void
94 err_del_index_out_of_range (bool is1d, octave_idx_type idx,
95 octave_idx_type ext)
96 {
97 const char *err_id = error_id_index_out_of_bounds;
98
99 (*current_liboctave_error_with_id_handler)
100 (err_id, "A(%s) = []: index out of bounds: value %d out of bound %d",
101 is1d ? "I" : "..,I,..", idx, ext);
102 }
103
104 // Common procedures of base class index_exception, thrown whenever an
105 // object is indexed incorrectly, such as by an index that is out of
106 // range, negative, fractional, complex, or of a non-numeric type.
107
108 std::string
109 index_exception::message (void) const
110 {
111 std::string msg = expression () + ": " + details ();
112 return msg.c_str ();
113 }
114
115 // Show the expression that caused the error, e.g., "A(-1,_)",
116 // "A(0+1i)", "A(_,3)". Show how many indices come before/after the
117 // offending one, e.g., (<error>), (<error>,_), or (_,<error>,...[x5]...)
118
119 std::string
120 index_exception::expression (void) const
121 {
122 std::ostringstream buf;
123
124 if (var.empty () || var == "<unknown>")
125 buf << "index ";
126 else
127 buf << var;
128
129 bool show_parens = dim > 0;
130
131 if (show_parens)
132 {
133 if (dim < 5)
134 {
135 buf << "(";
136
137 for (octave_idx_type i = 1; i < dim; i++)
138 buf << "_,";
139 }
140 else
141 buf << "(...[x" << dim - 1 << "]...";
142 }
143
144 buf << idx ();
145
146 if (show_parens)
147 {
148 if (nd - dim < 5)
149 {
150 for (octave_idx_type i = 0; i < nd - dim; i++)
151 buf << ",_";
152
153 if (nd >= dim)
154 buf << ")";
155 }
156 else
157 buf << "...[x" << nd - dim << "]...)";
158 }
159
160 return buf.str ();
161 }
162
163 class invalid_index : public index_exception
164 {
165 public:
166
167 invalid_index (const std::string& value, octave_idx_type ndim,
168 octave_idx_type dimen)
169 : index_exception (value, ndim, dimen)
170 { }
171
172 std::string details (void) const
173 {
174 #ifdef USE_64_BIT_IDX_T
175 return "subscripts must be either integers 1 to (2^63)-1 or logicals";
176 #else
177 return "subscripts must be either integers 1 to (2^31)-1 or logicals";
178 #endif
179 }
180
181 // ID of error to throw
182 const char *err_id (void) const
183 {
184 return error_id_invalid_index;
185 }
186 };
187
188 // Complain if an index is negative, fractional, or too big.
189
190 void
191 err_invalid_index (const std::string& idx, octave_idx_type nd,
192 octave_idx_type dim, const std::string&)
193 {
194 invalid_index e (idx, nd, dim);
195
196 throw e;
197 }
198
199 void
200 err_invalid_index (octave_idx_type n, octave_idx_type nd,
201 octave_idx_type dim, const std::string& var)
202 {
203 std::ostringstream buf;
204 buf << n + 1;
205 err_invalid_index (buf.str (), nd, dim, var);
206 }
207
208 void
209 err_invalid_index (double n, octave_idx_type nd, octave_idx_type dim,
210 const std::string& var)
211 {
212 std::ostringstream buf;
213 buf << n + 1;
214 err_invalid_index (buf.str (), nd, dim, var);
215 }
216
217
218 // Complain for read access beyond the bounds of an array.
219
220 class out_of_range : public index_exception
221 {
222 public:
223
224 out_of_range (const std::string& value, octave_idx_type nd_in,
225 octave_idx_type dim_in)
226 : index_exception (value, nd_in, dim_in), extent (0)
227 { }
228
229 std::string details (void) const
230 {
231 std::string expl;
232
233 if (nd >= size.length ()) // if not an index slice
234 {
235 if (var != "")
236 expl = "but " + var + " has size ";
237 else
238 expl = "but object has size ";
239
240 expl = expl + size.str ('x');
241 }
242 else
243 {
244 std::ostringstream buf;
245 buf << extent;
246 expl = "out of bound " + buf.str ();
247 }
248
249 return expl;
250 }
251
252 // ID of error to throw.
253 const char *err_id (void) const
254 {
255 return error_id_index_out_of_bounds;
256 }
257
258 void set_size (const dim_vector& size_in) { size = size_in; }
259
260 void set_extent (octave_idx_type ext) { extent = ext; }
261
262 private:
263
264 // Dimension of object being accessed.
265 dim_vector size;
266
267 // Length of dimension being accessed.
268 octave_idx_type extent;
269 };
270
271 // Complain of an index that is out of range, but we don't know matrix size
272 void
273 err_index_out_of_range (int nd, int dim, octave_idx_type idx,
274 octave_idx_type ext)
275 {
276 std::ostringstream buf;
277 buf << idx;
278 out_of_range e (buf.str (), nd, dim);
279
280 e.set_extent (ext);
281 // ??? Make details method give extent not size.
282 e.set_size (dim_vector (1, 1, 1, 1, 1, 1,1));
283
284 throw e;
285 }
286
287 // Complain of an index that is out of range
288 void
289 err_index_out_of_range (int nd, int dim, octave_idx_type idx,
290 octave_idx_type ext, const dim_vector& d)
291 {
292 std::ostringstream buf;
293 buf << idx;
294 out_of_range e (buf.str (), nd, dim);
295
296 e.set_extent (ext);
297 e.set_size (d);
298
299 throw e;
300 }
301
302 void
303 err_invalid_resize (void)
304 {
305 (*current_liboctave_error_with_id_handler)
306 ("Octave:invalid-resize",
307 "Invalid resizing operation or ambiguous assignment to an out-of-bounds array element");
308 }
309
310 void
311 errwarn_singular_matrix (double rcond)
312 {
313 if (rcond == 0.0)
314 {
315 (*current_liboctave_warning_with_id_handler)
316 (warning_id_singular_matrix,
317 "matrix singular to machine precision");
318 }
319 else
320 {
321 (*current_liboctave_warning_with_id_handler)
322 (warning_id_nearly_singular_matrix,
323 "matrix singular to machine precision, rcond = %g", rcond);
324 }
325 }
326
327 /* Tests in test/index.tst */