Mercurial > octave-nkf

comparison liboctave/util/lo-array-gripes.h @ 20574:dd6345fd8a97

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
use exceptions for better invalid index error reporting (bug #45957) * lo-array-gripes.h, lo-array-gripes.cc (index_exception): New base class for indexing errors. (invalid_index, out_of_range): New classes. (gripe_index_out_of_range): New overloaded function. (gripe_invalid_index): New overloaded functions. Delete version with no arguments. (gripe_invalid_assignment_size, gripe_assignment_dimension_mismatch): Delete. Change uses of gripe functions as needed. * Cell.cc (Cell::index, Cell::assign, Cell::delete_elements): Use exceptions to collect error info about and handle indexing errors. * data.cc (Fnth_element, do_accumarray_sum, F__accumarray_sum__, do_accumarray_minmax, do_accumarray_minmax_fun, F__accumdim_sum__): Likewise. * oct-map.cc (octave_map::index, octave_map::assign, octave_map::delete_elements): Likewise. * sparse.cc (Fsparse): Likewise. * sub2ind.cc (Fsub2ind, Find2sub): Likewise. New tests. * utils.cc (dims_to_numel): Likewise. * ov-base-diag.cc (octave_base_diag<DMT, MT>::do_index_op, octave_base_diag<DMT, MT>::subsasgn): Likewise. * ov-base-mat.cc (octave_base_matrix<MT>::subsref, octave_base_matrix<MT>::assign): Likewise. * ov-base-sparse.cc (octave_base_sparse<T>::do_index_op, octave_base_sparse<T>::assign, octave_base_sparse<MT>::delete_elements): Likewise. * ov-classdef.cc (cdef_object_array::subsref, cdef_object_array::subsasgn): Likewise. * ov-java.cc (make_java_index): Likewise. * ov-perm.cc (octave_perm_matrix::do_index_op): Likewise. * ov-range.cc (octave_range::do_index_op): Likewise. * ov-re-diag.cc (octave_diag_matrix::do_index_op): Likewise. * ov-str-mat.cc (octave_char_matrix_str::do_index_op_internal): Likewise. * pt-assign.cc (tree_simple_assignment::rvalue1): Likewise. * pt-idx.cc (tree_index_expression::rvalue, tree_index_expression::lvalue): Likewise. * Array-util.cc (sub2ind): Likewise. * toplev.cc (main_loop): Also catch unhandled index_exception exceptions. * ov-base.cc (octave_base_value::index_vector): Improve error message. * ov-re-sparse.cc (octave_sparse_matrix::index_vector): Likewise. * ov-complex.cc (complex_index): New class. (gripe_complex_index): New function. (octave_complex::index_vector): Use it. * pt-id.h, pt-id.cc (tree_identifier::is_variable, tree_black_hole::is_variable): Now const. * pt-idx.cc (final_index_error): New static function. (tree_index_expression::rvalue, tree_index_expression::lvalue): Use it. * index.tst: New tests.
author Lachlan Andrew <lachlanbis@gmail.com>
date Fri, 02 Oct 2015 15:07:37 -0400
parents 4197fc428c7d
children
comparison
equal deleted inserted replaced
20573:e3c0fee87493 20574:dd6345fd8a97
22 22
23 #if !defined (octave_lo_array_gripes_h) 23 #if !defined (octave_lo_array_gripes_h)
24 #define octave_lo_array_gripes_h 1 24 #define octave_lo_array_gripes_h 1
25 25
26 #include "dim-vector.h" 26 #include "dim-vector.h"
27 #include "quit.h"
28
29 // Exception thrown by gripe_invalid_index
30 // This is thrown when the invalid index is detected, at which point nd and dim
31 // are usually not known. It is caught at the place they are known, where a
32 // new gripe_invalid_index is called.
33 //
34 // Typically, this should be caught after any call to
35 // octave_value_list::index_vector()
36 class index_exception : public octave_execution_exception
37 {
38 public:
39
40 index_exception (const char *index_in, octave_idx_type nd_in = 0,
41 octave_idx_type dim_in = 0, const char *var_in = "")
42 : index (index_in), nd (nd_in), dim (dim_in), var (var_in)
43 { }
44
45 ~index_exception (void) throw () { }
46
47 // Erroneous index value. Called in what, and by external code
48 // (e.g., nth_element) to make a custom error message.
49 const char *idx (void) const { return index.c_str (); }
50
51 // details set by subclass.
52 virtual const char* explain (void) const = 0;
53
54 // ID of error to throw.
55 virtual const char* id (void) const = 0;
56
57 virtual const char* err (void) throw ();
58
59 // Position of error: dimension in error, and number of dimensions.
60 void set_pos (octave_idx_type nd_in, octave_idx_type dim_in)
61 {
62 nd = nd_in;
63 dim = dim_in;
64 }
65
66 void set_pos_if_unset (octave_idx_type nd_in, octave_idx_type dim_in)
67 {
68 if (nd == 0)
69 {
70 nd = nd_in;
71 dim = dim_in;
72 }
73 }
74
75 // Name of variable being indexed. eye(2)(1,1) gives "<unknown>".
76 void set_var (std::string var_in) { var = var_in; }
77
78 private:
79
80 // Value of invalid index.
81 std::string index;
82
83 // Formatted message returned by what(), (not on stack).
84 std::string msg;
85
86 protected:
87
88 // Show what's wrong, e.g., A(-1,_), A(0+1i).
89 std::string access (void) const;
90
91 // Number of dimensions of indexed object.
92 octave_idx_type nd;
93
94 // Dimension number in which invalid index occurred.
95 octave_idx_type dim;
96
97 // Name of variable being indexed.
98 std::string var;
99
100 };
27 101
28 extern OCTAVE_API const char *error_id_nonconformant_args; 102 extern OCTAVE_API const char *error_id_nonconformant_args;
29 103
30 extern OCTAVE_API const char *error_id_index_out_of_bounds; 104 extern OCTAVE_API const char *error_id_index_out_of_bounds;
31 105
55 gripe_nonconformant (const char *op, const dim_vector& op1_dims, 129 gripe_nonconformant (const char *op, const dim_vector& op1_dims,
56 const dim_vector& op2_dims); 130 const dim_vector& op2_dims);
57 131
58 extern void OCTAVE_API 132 extern void OCTAVE_API
59 gripe_index_out_of_range (int nd, int dim, 133 gripe_index_out_of_range (int nd, int dim,
134 octave_idx_type iext, octave_idx_type ext,
135 const dim_vector& d);
136
137 extern void OCTAVE_API
138 gripe_index_out_of_range (int nd, int dim,
60 octave_idx_type iext, octave_idx_type ext); 139 octave_idx_type iext, octave_idx_type ext);
61 140
62 extern void OCTAVE_API 141 extern void OCTAVE_API
63 gripe_del_index_out_of_range (bool is1d, octave_idx_type iext, 142 gripe_del_index_out_of_range (bool is1d, octave_idx_type iext,
64 octave_idx_type ext); 143 octave_idx_type ext);
65 144
66 extern void OCTAVE_API 145 extern void OCTAVE_API
67 gripe_invalid_index (void); 146 gripe_invalid_index (double, octave_idx_type nd=0,
147 octave_idx_type dim=0, const char *var = NULL);
148
149 extern void OCTAVE_API
150 gripe_invalid_index (octave_idx_type n, octave_idx_type nd=0,
151 octave_idx_type dim=0, const char *var = NULL);
152
153 extern void OCTAVE_API
154 gripe_invalid_index (const char *idx, octave_idx_type nd=0,
155 octave_idx_type dim=0, const char *var = NULL);
68 156
69 extern void OCTAVE_API 157 extern void OCTAVE_API
70 gripe_invalid_resize (void); 158 gripe_invalid_resize (void);
71 159
72 extern void OCTAVE_API 160 extern void OCTAVE_API
73 gripe_invalid_assignment_size (void);
74
75 extern void OCTAVE_API
76 gripe_assignment_dimension_mismatch (void);
77
78 extern void OCTAVE_API
79 gripe_singular_matrix (double rcond = 0.0); 161 gripe_singular_matrix (double rcond = 0.0);
80 162
81 #endif 163 #endif