Mercurial > hg > octave-nkf
annotate liboctave/oct-sort.h @ 8920:eb63fbe60fab
update copyright notices
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Sat, 07 Mar 2009 10:41:27 -0500 |
parents | 89b95972e178 |
children | 9fd5c56ce57a |
rev | line source |
---|---|
4851 | 1 /* |
8920 | 2 Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 David Bateman |
4851 | 3 |
4 This file is part of Octave. | |
5 | |
6 Octave is free software; you can redistribute it and/or modify it | |
7 under the terms of the GNU General Public License as published by the | |
7016 | 8 Free Software Foundation; either version 3 of the License, or (at your |
9 option) any later version. | |
4851 | 10 |
11 Octave is distributed in the hope that it will be useful, but WITHOUT | |
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
14 for more details. | |
15 | |
16 You should have received a copy of the GNU General Public License | |
7016 | 17 along with Octave; see the file COPYING. If not, see |
18 <http://www.gnu.org/licenses/>. | |
4851 | 19 |
20 Code stolen in large part from Python's, listobject.c, which itself had | |
21 no license header. However, thanks to Tim Peters for the parts of the | |
22 code I ripped-off. | |
23 | |
24 As required in the Python license the short description of the changes | |
25 made are | |
26 | |
27 * convert the sorting code in listobject.cc into a generic class, | |
28 replacing PyObject* with the type of the class T. | |
29 | |
30 The Python license is | |
31 | |
32 PSF LICENSE AGREEMENT FOR PYTHON 2.3 | |
33 -------------------------------------- | |
34 | |
35 1. This LICENSE AGREEMENT is between the Python Software Foundation | |
36 ("PSF"), and the Individual or Organization ("Licensee") accessing and | |
37 otherwise using Python 2.3 software in source or binary form and its | |
38 associated documentation. | |
39 | |
40 2. Subject to the terms and conditions of this License Agreement, PSF | |
41 hereby grants Licensee a nonexclusive, royalty-free, world-wide | |
42 license to reproduce, analyze, test, perform and/or display publicly, | |
43 prepare derivative works, distribute, and otherwise use Python 2.3 | |
44 alone or in any derivative version, provided, however, that PSF's | |
45 License Agreement and PSF's notice of copyright, i.e., "Copyright (c) | |
46 2001, 2002, 2003 Python Software Foundation; All Rights Reserved" are | |
47 retained in Python 2.3 alone or in any derivative version prepared by | |
48 Licensee. | |
49 | |
50 3. In the event Licensee prepares a derivative work that is based on | |
51 or incorporates Python 2.3 or any part thereof, and wants to make | |
52 the derivative work available to others as provided herein, then | |
53 Licensee hereby agrees to include in any such work a brief summary of | |
54 the changes made to Python 2.3. | |
55 | |
56 4. PSF is making Python 2.3 available to Licensee on an "AS IS" | |
57 basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR | |
58 IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND | |
59 DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS | |
60 FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 2.3 WILL NOT | |
61 INFRINGE ANY THIRD PARTY RIGHTS. | |
62 | |
63 5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON | |
64 2.3 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS | |
65 A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 2.3, | |
66 OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. | |
67 | |
68 6. This License Agreement will automatically terminate upon a material | |
69 breach of its terms and conditions. | |
70 | |
71 7. Nothing in this License Agreement shall be deemed to create any | |
72 relationship of agency, partnership, or joint venture between PSF and | |
73 Licensee. This License Agreement does not grant permission to use PSF | |
74 trademarks or trade name in a trademark sense to endorse or promote | |
75 products or services of Licensee, or any third party. | |
76 | |
77 8. By copying, installing or otherwise using Python 2.3, Licensee | |
78 agrees to be bound by the terms and conditions of this License | |
79 Agreement. | |
80 */ | |
81 | |
82 #if !defined (octave_sort_h) | |
83 #define octave_sort_h 1 | |
84 | |
8725 | 85 #include "lo-traits.h" |
86 | |
7234 | 87 // The maximum number of entries in a MergeState's pending-runs stack. |
88 // This is enough to sort arrays of size up to about | |
89 // 32 * phi ** MAX_MERGE_PENDING | |
90 // where phi ~= 1.618. 85 is ridiculously large enough, good for an array | |
91 // with 2**64 elements. | |
4851 | 92 #define MAX_MERGE_PENDING 85 |
93 | |
7234 | 94 // When we get into galloping mode, we stay there until both runs win less |
95 // often than MIN_GALLOP consecutive times. See listsort.txt for more info. | |
4851 | 96 #define MIN_GALLOP 7 |
97 | |
7234 | 98 // Avoid malloc for small temp arrays. |
4851 | 99 #define MERGESTATE_TEMP_SIZE 1024 |
100 | |
7433 | 101 // Enum for type of sort function |
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
102 enum sortmode { UNSORTED = 0, ASCENDING, DESCENDING }; |
7433 | 103 |
4851 | 104 template <class T> |
105 class | |
106 octave_sort | |
107 { | |
4998 | 108 public: |
109 | |
8725 | 110 typedef bool (*compare_fcn_type) (typename ref_param<T>::type, |
111 typename ref_param<T>::type); | |
112 | |
4851 | 113 octave_sort (void); |
114 | |
8725 | 115 octave_sort (compare_fcn_type); |
4851 | 116 |
8814
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
117 ~octave_sort (void); |
4998 | 118 |
8725 | 119 void set_compare (compare_fcn_type comp) { compare = comp; } |
4851 | 120 |
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
121 void set_compare (sortmode mode); |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
122 |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
123 // Sort an array in-place. |
8700 | 124 void sort (T *data, octave_idx_type nel); |
125 | |
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
126 // Ditto, but also permute the passed indices (may not be valid indices). |
8700 | 127 void sort (T *data, octave_idx_type *idx, octave_idx_type nel); |
128 | |
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
129 // Check whether an array is sorted. |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
130 bool is_sorted (const T *data, octave_idx_type nel); |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
131 |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
132 // Sort a matrix by rows, return a permutation |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
133 // vector. |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
134 void sort_rows (const T *data, octave_idx_type *idx, |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
135 octave_idx_type rows, octave_idx_type cols); |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
136 |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
137 // Determine whether a matrix (as a contiguous block) is sorted by rows. |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
138 bool is_sorted_rows (const T *data, |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
139 octave_idx_type rows, octave_idx_type cols); |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
140 |
8814
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
141 // Do a binary lookup in a sorted array. |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
142 octave_idx_type lookup (const T *data, octave_idx_type nel, |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
143 const T& value); |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
144 |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
145 // Ditto, but for an array of values, specializing on long runs. |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
146 // Adds offset to all indices. |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
147 void lookup (const T *data, octave_idx_type nel, |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
148 const T* values, octave_idx_type nvalues, |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
149 octave_idx_type *idx, octave_idx_type offset = 0); |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
150 |
8725 | 151 static bool ascending_compare (typename ref_param<T>::type, |
152 typename ref_param<T>::type); | |
153 | |
154 static bool descending_compare (typename ref_param<T>::type, | |
155 typename ref_param<T>::type); | |
4851 | 156 |
4998 | 157 private: |
158 | |
7234 | 159 // One MergeState exists on the stack per invocation of mergesort. |
160 // It's just a convenient way to pass state around among the helper | |
161 // functions. | |
162 // | |
163 // DGB: This isn't needed with mergesort in a class, but it doesn't | |
164 // slow things up, and it is likely to make my life easier for any | |
165 // potential backporting of changes in the Python code. | |
4851 | 166 |
167 struct s_slice | |
168 { | |
8700 | 169 octave_idx_type base, len; |
4851 | 170 }; |
171 | |
7234 | 172 struct MergeState |
4851 | 173 { |
8820
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
174 MergeState (void) |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
175 : a (0), ia (0), alloced (0) |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
176 { reset (); } |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
177 |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
178 ~MergeState (void) |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
179 { delete [] a; delete [] ia; } |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
180 |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
181 void reset (void) |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
182 { min_gallop = MIN_GALLOP; n = 0; } |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
183 |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
184 void getmem (octave_idx_type need); |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
185 |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
186 void getmemi (octave_idx_type need); |
89b95972e178
fix previously introduced problem in octave_sort, improve design
Jaroslav Hajek <highegg@gmail.com>
parents:
8814
diff
changeset
|
187 |
7234 | 188 // This controls when we get *into* galloping mode. It's |
189 // initialized to MIN_GALLOP. merge_lo and merge_hi tend to nudge | |
190 // it higher for random data, and lower for highly structured | |
191 // data. | |
7433 | 192 octave_idx_type min_gallop; |
4851 | 193 |
7234 | 194 // 'a' is temp storage to help with merges. It contains room for |
195 // alloced entries. | |
196 T *a; // may point to temparray below | |
8700 | 197 octave_idx_type *ia; |
7433 | 198 octave_idx_type alloced; |
4851 | 199 |
7234 | 200 // A stack of n pending runs yet to be merged. Run #i starts at |
201 // address base[i] and extends for len[i] elements. It's always | |
202 // true (so long as the indices are in bounds) that | |
203 // | |
204 // pending[i].base + pending[i].len == pending[i+1].base | |
205 // | |
206 // so we could cut the storage for this, but it's a minor amount, | |
207 // and keeping all the info explicit simplifies the code. | |
7433 | 208 octave_idx_type n; |
4851 | 209 struct s_slice pending[MAX_MERGE_PENDING]; |
7234 | 210 }; |
4851 | 211 |
8725 | 212 compare_fcn_type compare; |
4851 | 213 |
8814
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
214 MergeState *ms; |
4851 | 215 |
8700 | 216 |
217 template <class Comp> | |
218 void binarysort (T *data, octave_idx_type nel, | |
219 octave_idx_type start, Comp comp); | |
220 | |
221 template <class Comp> | |
222 void binarysort (T *data, octave_idx_type *idx, octave_idx_type nel, | |
223 octave_idx_type start, Comp comp); | |
4851 | 224 |
8700 | 225 template <class Comp> |
226 octave_idx_type count_run (T *lo, octave_idx_type n, bool& descending, Comp comp); | |
4851 | 227 |
8700 | 228 template <class Comp> |
229 octave_idx_type gallop_left (T key, T *a, octave_idx_type n, octave_idx_type hint, | |
230 Comp comp); | |
4851 | 231 |
8700 | 232 template <class Comp> |
233 octave_idx_type gallop_right (T key, T *a, octave_idx_type n, octave_idx_type hint, | |
234 Comp comp); | |
4851 | 235 |
8700 | 236 template <class Comp> |
237 int merge_lo (T *pa, octave_idx_type na, | |
238 T *pb, octave_idx_type nb, | |
239 Comp comp); | |
4851 | 240 |
8700 | 241 template <class Comp> |
242 int merge_lo (T *pa, octave_idx_type *ipa, octave_idx_type na, | |
243 T *pb, octave_idx_type *ipb, octave_idx_type nb, | |
244 Comp comp); | |
245 | |
246 template <class Comp> | |
247 int merge_hi (T *pa, octave_idx_type na, | |
248 T *pb, octave_idx_type nb, | |
249 Comp comp); | |
4851 | 250 |
8700 | 251 template <class Comp> |
252 int merge_hi (T *pa, octave_idx_type *ipa, octave_idx_type na, | |
253 T *pb, octave_idx_type *ipb, octave_idx_type nb, | |
254 Comp comp); | |
255 | |
256 template <class Comp> | |
257 int merge_at (octave_idx_type i, T *data, | |
258 Comp comp); | |
4851 | 259 |
8700 | 260 template <class Comp> |
261 int merge_at (octave_idx_type i, T *data, octave_idx_type *idx, | |
262 Comp comp); | |
263 | |
264 template <class Comp> | |
265 int merge_collapse (T *data, Comp comp); | |
4851 | 266 |
8700 | 267 template <class Comp> |
268 int merge_collapse (T *data, octave_idx_type *idx, Comp comp); | |
269 | |
270 template <class Comp> | |
271 int merge_force_collapse (T *data, Comp comp); | |
272 | |
273 template <class Comp> | |
274 int merge_force_collapse (T *data, octave_idx_type *idx, Comp comp); | |
4851 | 275 |
7433 | 276 octave_idx_type merge_compute_minrun (octave_idx_type n); |
8700 | 277 |
278 template <class Comp> | |
279 void sort (T *data, octave_idx_type nel, Comp comp); | |
280 | |
281 template <class Comp> | |
282 void sort (T *data, octave_idx_type *idx, octave_idx_type nel, Comp comp); | |
283 | |
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
284 template <class Comp> |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
285 bool is_sorted (const T *data, octave_idx_type nel, Comp comp); |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
286 |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
287 template <class Comp> |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
288 void sort_rows (const T *data, octave_idx_type *idx, |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
289 octave_idx_type rows, octave_idx_type cols, |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
290 Comp comp); |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
291 |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
292 template <class Comp> |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
293 bool is_sorted_rows (const T *data, octave_idx_type rows, |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
294 octave_idx_type cols, Comp comp); |
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
295 |
8814
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
296 template <class Comp> |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
297 octave_idx_type lookup (const T *data, octave_idx_type nel, |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
298 const T& value, Comp comp); |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
299 |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
300 template <class Comp> |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
301 void lookup (const T *data, octave_idx_type nel, |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
302 const T* values, octave_idx_type nvalues, |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
303 octave_idx_type *idx, octave_idx_type offset, Comp comp); |
de16ebeef93d
improve lookup, provide Array<T>::lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
8725
diff
changeset
|
304 |
4851 | 305 }; |
306 | |
7433 | 307 template <class T> |
308 class | |
309 vec_index | |
310 { | |
311 public: | |
312 T vec; | |
313 octave_idx_type indx; | |
314 }; | |
4851 | 315 #endif |
316 | |
317 /* | |
318 ;;; Local Variables: *** | |
319 ;;; mode: C++ *** | |
320 ;;; End: *** | |
321 */ |