annotate liboctave/util/idx-bounds.h @ 19010:3fb030666878 draft default tip dspies

Added special-case logical-indexing function * logical-index.h (New file) : Logical-indexing function. May be called on octave_value types via call_bool_index * nz-iterators.h : Add base-class nz_iterator for iterator types. Array has template bool for whether to internally store row-col or compute on the fly Add skip_ahead method which skips forward to the next nonzero after its argument Add flat_index for computing octave_idx_type index of current position (with assertion failure in the case of overflow) Move is_zero to separate file * ov-base-diag.cc, ov-base-mat.cc, ov-base-sparse.cc, ov-perm.cc (do_index_op): Add call to call_bool_index in logical-index.h * Array.h : Move forward-declaration for array_iterator to separate header file * dim-vector.cc (dim_max): Refers to idx-bounds.h (max_idx) * array-iter-decl.h (New file): Header file for forward declaration of array-iterator * direction.h : Add constants fdirc and bdirc to avoid having to reconstruct them * dv-utils.h, dv-utils.cc (New files) : Utility functions for querying and constructing dim-vectors * idx-bounds.h (New file) : Utility constants and functions for determining whether things will overflow the maximum allowed bounds * interp-idx.h (New function : to_flat_idx) : Converts row-col pair to linear index of octave_idx_type * is-zero.h (New file) : Function for determining whether an element is zero * logical-index.tst : Add tests for correct return-value dimensions and large sparse matrix behavior
author David Spies <dnspies@gmail.com>
date Fri, 25 Jul 2014 13:39:31 -0600
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19010
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
1 /*
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
2
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
3 Copyright (C) 2014 David Spies
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
4
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
5 This file is part of Octave.
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
6
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
10 option) any later version.
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
11
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
15 for more details.
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
16
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, see
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
19 <http://www.gnu.org/licenses/>.
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
20
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
21 */
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
22
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
23 #if !defined (octave_idx_bounds_h)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
24 #define octave_idx_bounds_h 1
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
25
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
26 #include <limits>
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
27
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
28 //The maximum value for octave_idx_type (and the maximum possible size of an
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
29 //Array)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
30 const octave_idx_type idx_type_max_value =
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
31 std::numeric_limits<octave_idx_type>::max ();
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
32
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
33 //The maximum index an array can have (idx_type_max_value - 1)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
34 const octave_idx_type max_idx = idx_type_max_value - 1;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
35
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
36 //Determines if a row-col pair will overflow octave_idx_type if translated into
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
37 //a linear index
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
38 inline bool
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
39 row_col_to_idx_overflows (octave_idx_type row, octave_idx_type col,
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
40 octave_idx_type height)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
41 {
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
42 return row > (max_idx - col) / height;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
43 }
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
44
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
45 //Determines if a height-width pair will overflow octave_idx_type when nelem is
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
46 //extracted
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
47 inline bool
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
48 height_width_to_nelem_overflows (octave_idx_type height, octave_idx_type width)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
49 {
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
50 return width > idx_type_max_value / height;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
51 }
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
52
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
53 #endif