annotate liboctave/util/dv-utils.cc @ 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 #ifdef HAVE_CONFIG_H
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
24 #include <config.h>
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
25 #endif
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
26
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
27 #include "dim-vector.h"
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
28 #include <cassert>
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
29
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
30 bool
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
31 dv_is_extended_vector (const dim_vector& dv)
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 bool found = false;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
34 for (int i = 0; i < dv.length (); i++)
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 if (dv(i) != 1)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
37 {
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
38 if (found)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
39 return false;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
40 else
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
41 found = true;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
42 }
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 return found;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
45 }
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
46
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
47 bool
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
48 dv_is_scalar (const dim_vector& dv)
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 for (int i = 0; i < dv.length (); i++)
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 if (dv(i) != 1)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
53 return false;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
54 }
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
55 return true;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
56 }
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
57
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
58 bool
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
59 dv_is_row (const dim_vector& dv)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
60 {
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
61 return dv_is_extended_vector (dv) && dv(1) != 1;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
62 }
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
63
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
64 //Returns the dimension along which a vector is a nonsingleton
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
65 int
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
66 dv_vector_dimension (const dim_vector& dv)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
67 {
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
68 assert(dv_is_extended_vector (dv));
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
69 for (int i = 0; i < dv.length (); i++)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
70 {
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
71 if (dv(i) != 1)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
72 return i;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
73 }
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
74 liboctave_fatal ("No non-1 dimension");
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
75 }
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
76
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
77 dim_vector
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
78 dv_match_vector (const dim_vector& dv, octave_idx_type numel)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
79 {
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
80 if(numel == 1)
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
81 return dim_vector (1, 1);
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
82 dim_vector res = dv;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
83 res (dv_vector_dimension (dv)) = numel;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
84 return res;
3fb030666878 Added special-case logical-indexing function
David Spies <dnspies@gmail.com>
parents:
diff changeset
85 }