annotate liboctave/util/lo-array-gripes.h @ 19009:8d47ce2053f2 draft

Added safety checks to Array::xelem There's no reason to have a method which never checks invariants, ever. Added debugging checks to Array::xelem to help catch and debug out-of-bounds errors and reference overlap * configure.ac: Added configuration option for uniqueness-checking with xelem * jit-typeinfo.cc (octave_jit_paren_scalar): Call const Array::xelem rather than Array::xelem * Array-util.h, Array-util.cc (check_out_of_range): Extract common pattern to method (check_index): Methods to check index is in-bounds (compute_index): Added bool parameter check. does not check bounds when check is false and BOUNDS_CHECKING is off * Array.h, Array.cc (xelem): Use methods from Array-util.h to compute indices (is_unique): Check if this is the only reference to data * CmplxQR.cc, dbleQR.cc, fCmplxQR.cc, floatQR.cc (form): Move second assignment to after the call to xelem * lo-array-gripes.h, lo-array-gripes.cc (gripe_modifying_nonunique): Added error message for when non-const xelem is called on non-unique array
author David Spies <dnspies@gmail.com>
date Mon, 14 Jul 2014 13:07:59 -0600
parents ebb3ef964372
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11135
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 /*
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 15271
diff changeset
3 Copyright (C) 2000-2013 John W. Eaton
11135
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 This file is part of Octave.
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 option) any later version.
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 for more details.
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, see
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 <http://www.gnu.org/licenses/>.
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
21 */
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22
17822
ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files.
Rik <rik@octave.org>
parents: 17744
diff changeset
23 #if !defined (octave_lo_array_gripes_h)
ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files.
Rik <rik@octave.org>
parents: 17744
diff changeset
24 #define octave_lo_array_gripes_h 1
11135
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 #include "dim-vector.h"
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 extern OCTAVE_API const char *error_id_nonconformant_args;
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30 extern OCTAVE_API const char *error_id_index_out_of_bounds;
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32 extern OCTAVE_API const char *error_id_invalid_index;
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 extern void OCTAVE_API
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 gripe_nan_to_logical_conversion (void);
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 extern void OCTAVE_API
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38 gripe_nan_to_character_conversion (void);
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 extern void OCTAVE_API
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 gripe_nonconformant (const char *op,
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 octave_idx_type op1_len, octave_idx_type op2_len);
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 extern void OCTAVE_API
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 gripe_nonconformant (const char *op,
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 octave_idx_type op1_nr, octave_idx_type op1_nc,
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 octave_idx_type op2_nr, octave_idx_type op2_nc);
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50 extern void OCTAVE_API
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 gripe_nonconformant (const char *op, const dim_vector& op1_dims,
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 const dim_vector& op2_dims);
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54 extern void OCTAVE_API
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
55 gripe_index_out_of_range (int nd, int dim,
11135
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56 octave_idx_type iext, octave_idx_type ext);
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 extern void OCTAVE_API
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
59 gripe_del_index_out_of_range (bool is1d, octave_idx_type iext,
11135
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 octave_idx_type ext);
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 extern void OCTAVE_API
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 gripe_invalid_index (void);
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65 extern void OCTAVE_API
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 gripe_invalid_resize (void);
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 extern void OCTAVE_API
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
69 gripe_invalid_assignment_size (void);
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
70
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
71 extern void OCTAVE_API
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72 gripe_assignment_dimension_mismatch (void);
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
73
19009
8d47ce2053f2 Added safety checks to Array::xelem
David Spies <dnspies@gmail.com>
parents: 17822
diff changeset
74 extern void OCTAVE_API
8d47ce2053f2 Added safety checks to Array::xelem
David Spies <dnspies@gmail.com>
parents: 17822
diff changeset
75 gripe_modifying_nonunique (void);
8d47ce2053f2 Added safety checks to Array::xelem
David Spies <dnspies@gmail.com>
parents: 17822
diff changeset
76
11135
047b0e877a14 add files for previous change
John W. Eaton <jwe@octave.org>
parents:
diff changeset
77 #endif