Mercurial > octave
view liboctave/util/lo-array-gripes.h @ 20542:dd6345fd8a97
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 | 22296da09307 |
line wrap: on
line source
/* Copyright (C) 2000-2015 John W. Eaton This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #if !defined (octave_lo_array_gripes_h) #define octave_lo_array_gripes_h 1 #include "dim-vector.h" #include "quit.h" // Exception thrown by gripe_invalid_index // This is thrown when the invalid index is detected, at which point nd and dim // are usually not known. It is caught at the place they are known, where a // new gripe_invalid_index is called. // // Typically, this should be caught after any call to // octave_value_list::index_vector() class index_exception : public octave_execution_exception { public: index_exception (const char *index_in, octave_idx_type nd_in = 0, octave_idx_type dim_in = 0, const char *var_in = "") : index (index_in), nd (nd_in), dim (dim_in), var (var_in) { } ~index_exception (void) throw () { } // Erroneous index value. Called in what, and by external code // (e.g., nth_element) to make a custom error message. const char *idx (void) const { return index.c_str (); } // details set by subclass. virtual const char* explain (void) const = 0; // ID of error to throw. virtual const char* id (void) const = 0; virtual const char* err (void) throw (); // Position of error: dimension in error, and number of dimensions. void set_pos (octave_idx_type nd_in, octave_idx_type dim_in) { nd = nd_in; dim = dim_in; } void set_pos_if_unset (octave_idx_type nd_in, octave_idx_type dim_in) { if (nd == 0) { nd = nd_in; dim = dim_in; } } // Name of variable being indexed. eye(2)(1,1) gives "<unknown>". void set_var (std::string var_in) { var = var_in; } private: // Value of invalid index. std::string index; // Formatted message returned by what(), (not on stack). std::string msg; protected: // Show what's wrong, e.g., A(-1,_), A(0+1i). std::string access (void) const; // Number of dimensions of indexed object. octave_idx_type nd; // Dimension number in which invalid index occurred. octave_idx_type dim; // Name of variable being indexed. std::string var; }; extern OCTAVE_API const char *error_id_nonconformant_args; extern OCTAVE_API const char *error_id_index_out_of_bounds; extern OCTAVE_API const char *error_id_invalid_index; extern OCTAVE_API const char *warning_id_nearly_singular_matrix; extern OCTAVE_API const char *warning_id_singular_matrix; extern void OCTAVE_API gripe_nan_to_logical_conversion (void); extern void OCTAVE_API gripe_nan_to_character_conversion (void); extern void OCTAVE_API gripe_nonconformant (const char *op, octave_idx_type op1_len, octave_idx_type op2_len); extern void OCTAVE_API gripe_nonconformant (const char *op, octave_idx_type op1_nr, octave_idx_type op1_nc, octave_idx_type op2_nr, octave_idx_type op2_nc); extern void OCTAVE_API gripe_nonconformant (const char *op, const dim_vector& op1_dims, const dim_vector& op2_dims); extern void OCTAVE_API gripe_index_out_of_range (int nd, int dim, octave_idx_type iext, octave_idx_type ext, const dim_vector& d); extern void OCTAVE_API gripe_index_out_of_range (int nd, int dim, octave_idx_type iext, octave_idx_type ext); extern void OCTAVE_API gripe_del_index_out_of_range (bool is1d, octave_idx_type iext, octave_idx_type ext); extern void OCTAVE_API gripe_invalid_index (double, octave_idx_type nd=0, octave_idx_type dim=0, const char *var = NULL); extern void OCTAVE_API gripe_invalid_index (octave_idx_type n, octave_idx_type nd=0, octave_idx_type dim=0, const char *var = NULL); extern void OCTAVE_API gripe_invalid_index (const char *idx, octave_idx_type nd=0, octave_idx_type dim=0, const char *var = NULL); extern void OCTAVE_API gripe_invalid_resize (void); extern void OCTAVE_API gripe_singular_matrix (double rcond = 0.0); #endif