annotate libinterp/corefcn/lookup.cc @ 24548:a00033be2134

Clean up lookup() code and documentation with no functional changes (bug #52785). * lookup.cc (icmp_char_lt): Remove. Case insensitivity no longer an option. (icmp_char_gt): Ditto. (stri_comp_lt): Ditto. (stri_comp_gt): Ditto. (Flookup): In docstring, move definition N sooner, drop @code{} command from around its use and make all instances upper case. In the docstring, add "minus" prior to "infinity" for the 'l' option description. Drop a redundant test on local variable 'match_idx'.
author Daniel J Sebald <daniel.sebald@ieee.org>
date Sat, 06 Jan 2018 17:07:37 -0600
parents 194eb4bd202b
children 6652d3823428
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
1 /*
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
2
23219
3ac9f9ecfae5 maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents: 23083
diff changeset
3 Copyright (C) 2008-2017 VZLU Prague a.s., Czech Republic
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
4
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
5 This file is part of Octave.
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
6
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24526
diff changeset
7 Octave is free software: you can redistribute it and/or modify it
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
8 under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24526
diff changeset
9 the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
10 (at your option) any later version.
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
11
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
13 WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
15 GNU General Public License for more details.
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
16
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24526
diff changeset
19 <https://www.gnu.org/licenses/>.
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
20
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
21 */
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
22
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
23 // Author: Jaroslav Hajek <highegg@gmail.com>
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
24
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21301
diff changeset
25 #if defined (HAVE_CONFIG_H)
21301
40de9f8f23a6 Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents: 21200
diff changeset
26 # include "config.h"
10039
1e306aa51d6c Include config.h before another header file.
Thomas Treichl
parents: 9923
diff changeset
27 #endif
1e306aa51d6c Include config.h before another header file.
Thomas Treichl
parents: 9923
diff changeset
28
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
29 #include <cctype>
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
30 #include <functional>
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
31 #include <algorithm>
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
32
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
33 #include "dNDArray.h"
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
34 #include "CNDArray.h"
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
35
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
36 #include "Cell.h"
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14846
diff changeset
37 #include "defun.h"
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
38 #include "error.h"
21100
e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents: 20940
diff changeset
39 #include "errwarn.h"
20940
48b2ad5ee801 maint: Rename oct-obj.[cc|h] to ovl.[cc|h] for clarity.
Rik <rik@octave.org>
parents: 20939
diff changeset
40 #include "ovl.h"
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
41 #include "ov.h"
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
42
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
43 static
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
44 bool
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
45 contains_char (const std::string& str, char c)
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
46 {
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
47 return (str.find (c) != std::string::npos
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10076
diff changeset
48 || str.find (std::toupper (c)) != std::string::npos);
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
49 }
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
50
21139
538b57866b90 consistently use "typename" intead of "class" in template declarations
John W. Eaton <jwe@octave.org>
parents: 21100
diff changeset
51 template <typename T>
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
52 inline sortmode
8814
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
53 get_sort_mode (const Array<T>& array,
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
54 typename octave_sort<T>::compare_fcn_type desc_comp
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
55 = octave_sort<T>::descending_compare)
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
56 {
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
57 octave_idx_type n = array.numel ();
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
58 if (n > 1 && desc_comp (array (0), array (n-1)))
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
59 return DESCENDING;
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
60 else
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
61 return ASCENDING;
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
62 }
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
63
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
64 // FIXME: perhaps there should be octave_value::lookup?
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
65 // The question is, how should it behave w.r.t. the second argument's type.
21751
b571fc85953f maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents: 21724
diff changeset
66 // We'd need a dispatch on two arguments. Hmmm...
8814
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
67
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 21966
diff changeset
68 #define INT_ARRAY_LOOKUP(TYPE) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 21966
diff changeset
69 (table.is_ ## TYPE ## _type () && y.is_ ## TYPE ## _type ()) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 21966
diff changeset
70 retval = do_numeric_lookup (table.TYPE ## _array_value (), \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 21966
diff changeset
71 y.TYPE ## _array_value (), \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 21966
diff changeset
72 left_inf, right_inf, \
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
73 match_idx, match_bool);
21139
538b57866b90 consistently use "typename" intead of "class" in template declarations
John W. Eaton <jwe@octave.org>
parents: 21100
diff changeset
74 template <typename ArrayT>
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
75 static octave_value
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
76 do_numeric_lookup (const ArrayT& array, const ArrayT& values,
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
77 bool left_inf, bool right_inf,
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
78 bool match_idx, bool match_bool)
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
79 {
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
80 octave_value retval;
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
81
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
82 Array<octave_idx_type> idx = array.lookup (values);
18100
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 17787
diff changeset
83 octave_idx_type n = array.numel ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 17787
diff changeset
84 octave_idx_type nval = values.numel ();
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
85
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
86 // Post-process.
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
87 if (match_bool)
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
88 {
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
89 boolNDArray match (idx.dims ());
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
90 for (octave_idx_type i = 0; i < nval; i++)
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
91 {
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
92 octave_idx_type j = idx.xelem (i);
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
93 match.xelem (i) = j != 0 && values(i) == array(j-1);
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
94 }
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
95
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
96 retval = match;
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
97 }
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
98 else if (match_idx || left_inf || right_inf)
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
99 {
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
100 if (match_idx)
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
101 {
10327
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
102 NDArray ridx (idx.dims ());
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
103
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
104 for (octave_idx_type i = 0; i < nval; i++)
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
105 {
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
106 octave_idx_type j = idx.xelem (i);
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
107 ridx.xelem (i) = (j != 0 && values(i) == array(j-1)) ? j : 0;
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
108 }
10327
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
109
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
110 retval = ridx;
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
111 }
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
112 else if (left_inf && right_inf)
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
113 {
21751
b571fc85953f maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents: 21724
diff changeset
114 // Results in valid indices. Optimize using lazy index.
10327
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
115 octave_idx_type zero = 0;
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
116 for (octave_idx_type i = 0; i < nval; i++)
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
117 {
10327
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
118 octave_idx_type j = idx.xelem (i) - 1;
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
119 idx.xelem (i) = std::max (zero, std::min (j, n-2));
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
120 }
10327
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
121
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
122 retval = idx_vector (idx);
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
123 }
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
124 else if (left_inf)
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
125 {
21751
b571fc85953f maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents: 21724
diff changeset
126 // Results in valid indices. Optimize using lazy index.
10327
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
127 octave_idx_type zero = 0;
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
128 for (octave_idx_type i = 0; i < nval; i++)
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
129 {
10327
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
130 octave_idx_type j = idx.xelem (i) - 1;
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
131 idx.xelem (i) = std::max (zero, j);
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
132 }
10327
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
133
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
134 retval = idx_vector (idx);
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
135 }
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
136 else if (right_inf)
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
137 {
10327
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
138 NDArray ridx (idx.dims ());
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
139
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
140 for (octave_idx_type i = 0; i < nval; i++)
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
141 {
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
142 octave_idx_type j = idx.xelem (i);
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
143 ridx.xelem (i) = std::min (j, n-1);
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
144 }
10327
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
145
76cf6dd20f1a take advantage of lazy index optimization in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 10258
diff changeset
146 retval = ridx;
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
147 }
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
148 }
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
149 else
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
150 retval = idx;
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
151
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
152 return retval;
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
153 }
8814
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
154
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14846
diff changeset
155 DEFUN (lookup, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
156 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
157 @deftypefn {} {@var{idx} =} lookup (@var{table}, @var{y})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
158 @deftypefnx {} {@var{idx} =} lookup (@var{table}, @var{y}, @var{opt})
23999
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
159 Lookup values in a @strong{sorted} table.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
160
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
161 This function is usually used as a prelude to interpolation.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
162
24548
a00033be2134 Clean up lookup() code and documentation with no functional changes (bug #52785).
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 24534
diff changeset
163 If table is increasing, of length N and @code{idx = lookup (table, y)}, then
23999
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
164 @code{table(idx(i)) <= y(i) < table(idx(i+1))} for all @code{y(i)} within the
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
165 table. If @code{y(i) < table(1)} then @code{idx(i)} is 0. If
24548
a00033be2134 Clean up lookup() code and documentation with no functional changes (bug #52785).
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 24534
diff changeset
166 @code{y(i) >= table(end)} or @code{isnan (y(i))} then @code{idx(i)} is N.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
167
23999
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
168 If the table is decreasing, then the tests are reversed. For non-strictly
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
169 monotonic tables, empty intervals are always skipped. The result is undefined
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
170 if @var{table} is not monotonic, or if @var{table} contains a NaN.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
171
24548
a00033be2134 Clean up lookup() code and documentation with no functional changes (bug #52785).
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 24534
diff changeset
172 The complexity of the lookup is O(M*log(N)) where M is the size of @var{y}.
a00033be2134 Clean up lookup() code and documentation with no functional changes (bug #52785).
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 24534
diff changeset
173 In the special case when @var{y} is also sorted, the complexity is
a00033be2134 Clean up lookup() code and documentation with no functional changes (bug #52785).
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 24534
diff changeset
174 O(min (M*log(N), M+N)).
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
175
23999
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
176 @var{table} and @var{y} can also be cell arrays of strings (or @var{y} can be a
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
177 single string). In this case, string lookup is performed using lexicographical
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
178 comparison.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
179
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
180 If @var{opts} is specified, it must be a string with letters indicating
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
181 additional options.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
182
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
183 @table @code
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
184 @item m
24505
9c178e5252e4 maint: merge stable to default.
Rik <rik@octave.org>
parents: 23999 24504
diff changeset
185 Match. @code{table(idx(i)) == y(i)} if @code{y(i)} occurs in table;
23999
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
186 otherwise, @code{idx(i)} is zero.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
187
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
188 @item b
24526
d68d1096d294 doc: Another tweak to lookup() documentation (bug #52785).
Rik <rik@octave.org>
parents: 24505
diff changeset
189 Boolean. @code{idx(i)} is a logical 1 or 0, indicating whether @code{y(i)}
23999
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
190 is contained in table or not.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
191
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
192 @item l
23999
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
193 Left. For numeric lookups the leftmost subinterval shall be extended to
24548
a00033be2134 Clean up lookup() code and documentation with no functional changes (bug #52785).
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 24534
diff changeset
194 minus infinity (i.e., all indices at least 1).
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
195
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
196 @item r
23999
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
197 Right. For numeric lookups the rightmost subinterval shall be extended to
24548
a00033be2134 Clean up lookup() code and documentation with no functional changes (bug #52785).
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 24534
diff changeset
198 infinity (i.e., all indices at most N-1).
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
199 @end table
23999
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
200
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
201 @strong{Note}: If @var{table} is not sorted the results from @code{lookup}
21d2114476a4 Improve docstring for lookup() (bug #46425).
Rik <rik@octave.org>
parents: 23586
diff changeset
202 will be unpredictable.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
203 @end deftypefn */)
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
204 {
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
205 int nargin = args.length ();
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
206
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
207 if (nargin < 2 || nargin > 3)
20802
8bb38ba1bad6 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20555
diff changeset
208 print_usage ();
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
209
18100
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 17787
diff changeset
210 octave_value table = args(0);
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 17787
diff changeset
211 octave_value y = args(1);
8814
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
212 if (table.ndims () > 2 || (table.columns () > 1 && table.rows () > 1))
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
213 warning ("lookup: table is not a vector");
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
214
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
215 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
216
23586
f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric.
Rik <rik@octave.org>
parents: 23581
diff changeset
217 bool num_case = ((table.isnumeric () && y.isnumeric ())
9344
0c4e6a3d6e3e support char arrays in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 9341
diff changeset
218 || (table.is_char_matrix () && y.is_char_matrix ()));
23575
e95738a119da maint: Deprecate is_cellstr and replace with iscellstr.
Rik <rik@octave.org>
parents: 23450
diff changeset
219 bool str_case = table.iscellstr () && (y.is_string () || y.iscellstr ());
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
220 bool left_inf = false;
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
221 bool right_inf = false;
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
222 bool match_idx = false;
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
223 bool match_bool = false;
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
224
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
225 if (nargin == 3)
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
226 {
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
227 std::string opt = args(2).xstring_value ("lookup: OPT must be a string");
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
228 left_inf = contains_char (opt, 'l');
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
229 right_inf = contains_char (opt, 'r');
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
230 match_idx = contains_char (opt, 'm');
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
231 match_bool = contains_char (opt, 'b');
11560
05b5bcdb09c8 validate opts in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 11553
diff changeset
232 if (opt.find_first_not_of ("lrmb") != std::string::npos)
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
233 error ("lookup: unrecognized option: %c",
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
234 opt[opt.find_first_not_of ("lrmb")]);
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
235 }
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
236
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
237 if ((match_idx || match_bool) && (left_inf || right_inf))
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
238 error ("lookup: m, b cannot be specified with l or r");
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
239 else if (match_idx && match_bool)
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
240 error ("lookup: only one of m or b can be specified");
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
241 else if (str_case && (left_inf || right_inf))
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
242 error ("lookup: l, r are not recognized for string lookups");
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
243
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
244 if (num_case)
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
245 {
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
246 // In the case of a complex array, absolute values will be used for
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
247 // compatibility (though it's not too meaningful).
23581
c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents: 23575
diff changeset
248 if (table.iscomplex ())
9813
8fa32b527d9a improve & partially revert previous change
Jaroslav Hajek <highegg@gmail.com>
parents: 9812
diff changeset
249 table = table.abs ();
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
250
23581
c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents: 23575
diff changeset
251 if (y.iscomplex ())
9813
8fa32b527d9a improve & partially revert previous change
Jaroslav Hajek <highegg@gmail.com>
parents: 9812
diff changeset
252 y = y.abs ();
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
253
8814
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
254 Array<octave_idx_type> idx;
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
255
8814
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
256 // PS: I learned this from data.cc
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
257 if INT_ARRAY_LOOKUP (int8)
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
258 else if INT_ARRAY_LOOKUP (int16)
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
259 else if INT_ARRAY_LOOKUP (int32)
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
260 else if INT_ARRAY_LOOKUP (int64)
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
261 else if INT_ARRAY_LOOKUP (uint8)
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
262 else if INT_ARRAY_LOOKUP (uint16)
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
263 else if INT_ARRAY_LOOKUP (uint32)
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
264 else if INT_ARRAY_LOOKUP (uint64)
9344
0c4e6a3d6e3e support char arrays in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 9341
diff changeset
265 else if (table.is_char_matrix () && y.is_char_matrix ())
0c4e6a3d6e3e support char arrays in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 9341
diff changeset
266 retval = do_numeric_lookup (table.char_array_value (),
0c4e6a3d6e3e support char arrays in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 9341
diff changeset
267 y.char_array_value (),
0c4e6a3d6e3e support char arrays in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 9341
diff changeset
268 left_inf, right_inf,
0c4e6a3d6e3e support char arrays in lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 9341
diff changeset
269 match_idx, match_bool);
8814
de16ebeef93d improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents: 8646
diff changeset
270 else if (table.is_single_type () || y.is_single_type ())
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
271 retval = do_numeric_lookup (table.float_array_value (),
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
272 y.float_array_value (),
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
273 left_inf, right_inf,
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
274 match_idx, match_bool);
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents: 7671
diff changeset
275 else
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
276 retval = do_numeric_lookup (table.array_value (),
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
277 y.array_value (),
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
278 left_inf, right_inf,
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
279 match_idx, match_bool);
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
280 }
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
281 else if (str_case)
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
282 {
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
283 Array<std::string> str_table = table.cellstr_value ();
11570
57632dea2446 attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents: 11560
diff changeset
284 Array<std::string> str_y (dim_vector (1, 1));
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
285
23575
e95738a119da maint: Deprecate is_cellstr and replace with iscellstr.
Rik <rik@octave.org>
parents: 23450
diff changeset
286 if (y.iscellstr ())
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
287 str_y = y.cellstr_value ();
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
288 else
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
289 str_y(0) = y.string_value ();
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
290
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
291 Array<octave_idx_type> idx = str_table.lookup (str_y);
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
292 octave_idx_type nval = str_y.numel ();
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
293
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
294 // Post-process.
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
295 if (match_bool)
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
296 {
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
297 boolNDArray match (idx.dims ());
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
298 for (octave_idx_type i = 0; i < nval; i++)
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
299 {
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
300 octave_idx_type j = idx.xelem (i);
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
301 match.xelem (i) = j != 0 && str_y(i) == str_table(j-1);
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
302 }
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
303
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
304 retval = match;
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
305 }
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
306 else if (match_idx)
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
307 {
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
308 NDArray ridx (idx.dims ());
24548
a00033be2134 Clean up lookup() code and documentation with no functional changes (bug #52785).
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 24534
diff changeset
309 for (octave_idx_type i = 0; i < nval; i++)
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
310 {
24548
a00033be2134 Clean up lookup() code and documentation with no functional changes (bug #52785).
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 24534
diff changeset
311 octave_idx_type j = idx.xelem (i);
a00033be2134 Clean up lookup() code and documentation with no functional changes (bug #52785).
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 24534
diff changeset
312 ridx.xelem (i) = (j != 0 && str_y(i) == str_table(j-1) ? j : 0);
9341
9fd5c56ce57a extend lookup capabilities
Jaroslav Hajek <highegg@gmail.com>
parents: 9064
diff changeset
313 }
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
314
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
315 retval = ridx;
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
316 }
9921
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
317 else
7c8392a034e6 fix & improve lookup API
Jaroslav Hajek <highegg@gmail.com>
parents: 9813
diff changeset
318 retval = idx;
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
319 }
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
320 else
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
321 print_usage ();
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
322
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
323 return retval;
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
324 }
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
325
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
326 /*
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
327 %!assert (lookup (1:3, 0.5), 0) # value before table
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
328 %!assert (lookup (1:3, 3.5), 3) # value after table error
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
329 %!assert (lookup (1:3, 1.5), 1) # value within table error
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
330 %!assert (lookup (1:3, [3,2,1]), [3,2,1])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
331 %!assert (lookup ([1:4]', [1.2, 3.5]'), [1, 3]')
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
332 %!assert (lookup ([1:4], [1.2, 3.5]'), [1, 3]')
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
333 %!assert (lookup ([1:4]', [1.2, 3.5]), [1, 3])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
334 %!assert (lookup ([1:4], [1.2, 3.5]), [1, 3])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
335 %!assert (lookup (1:3, [3, 2, 1]), [3, 2, 1])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
336 %!assert (lookup ([3:-1:1], [3.5, 3, 1.2, 2.5, 2.5]), [0, 1, 2, 1, 1])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
337 %!assert (isempty (lookup ([1:3], [])))
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
338 %!assert (isempty (lookup ([1:3]', [])))
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
339 %!assert (lookup (1:3, [1, 2; 3, 0.5]), [1, 2; 3, 0])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
340 %!assert (lookup (1:4, [1, 1.2; 3, 2.5], "m"), [1, 0; 3, 0])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
341 %!assert (lookup (4:-1:1, [1, 1.2; 3, 2.5], "m"), [4, 0; 2, 0])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
342 %!assert (lookup (1:4, [1, 1.2; 3, 2.5], "b"), logical ([1, 0; 3, 0]))
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
343 %!assert (lookup (4:-1:1, [1, 1.2; 3, 2.5], "b"), logical ([4, 0; 2, 0]))
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
344 %!
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
345 %!assert (lookup ({"apple","lemon","orange"}, {"banana","kiwi"; "ananas","mango"}), [1,1;0,2])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
346 %!assert (lookup ({"apple","lemon","orange"}, "potato"), 3)
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
347 %!assert (lookup ({"orange","lemon","apple"}, "potato"), 0)
7671
4fbaba9abec1 implement compiled binary lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
348 */