Mercurial > octave
annotate liboctave/oct-sort.h @ 8721:e9cb742df9eb
imported patch sort3.diff
| author | Jaroslav Hajek <highegg@gmail.com> |
|---|---|
| date | Wed, 11 Feb 2009 15:25:53 +0100 |
| parents | 314be237cd5b |
| children | d5af326a3ede |
| rev | line source |
|---|---|
| 4851 | 1 /* |
| 7017 | 2 Copyright (C) 2003, 2004, 2005, 2006, 2007 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 | |
| 7234 | 85 // The maximum number of entries in a MergeState's pending-runs stack. |
| 86 // This is enough to sort arrays of size up to about | |
| 87 // 32 * phi ** MAX_MERGE_PENDING | |
| 88 // where phi ~= 1.618. 85 is ridiculously large enough, good for an array | |
| 89 // with 2**64 elements. | |
| 4851 | 90 #define MAX_MERGE_PENDING 85 |
| 91 | |
| 7234 | 92 // When we get into galloping mode, we stay there until both runs win less |
| 93 // often than MIN_GALLOP consecutive times. See listsort.txt for more info. | |
| 4851 | 94 #define MIN_GALLOP 7 |
| 95 | |
| 7234 | 96 // Avoid malloc for small temp arrays. |
| 4851 | 97 #define MERGESTATE_TEMP_SIZE 1024 |
| 98 | |
| 7433 | 99 // Enum for type of sort function |
|
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
100 enum sortmode { UNSORTED = 0, ASCENDING, DESCENDING }; |
| 7433 | 101 |
| 4851 | 102 template <class T> |
| 103 class | |
| 104 octave_sort | |
| 105 { | |
| 4998 | 106 public: |
| 107 | |
| 4851 | 108 octave_sort (void); |
| 109 | |
| 110 octave_sort (bool (*comp) (T, T)); | |
| 111 | |
| 4998 | 112 ~octave_sort (void) { merge_freemem (); } |
| 113 | |
| 114 void set_compare (bool (*comp) (T, T)) { compare = comp; } | |
| 4851 | 115 |
|
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
116 void set_compare (sortmode mode); |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
117 |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
118 // Sort an array in-place. |
| 8700 | 119 void sort (T *data, octave_idx_type nel); |
| 120 | |
|
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
121 // Ditto, but also permute the passed indices (may not be valid indices). |
| 8700 | 122 void sort (T *data, octave_idx_type *idx, octave_idx_type nel); |
| 123 | |
|
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
124 // Check whether an array is sorted. |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
125 bool is_sorted (const T *data, octave_idx_type nel); |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
126 |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
127 // Sort a matrix by rows, return a permutation |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
128 // vector. |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
129 void sort_rows (const T *data, octave_idx_type *idx, |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
130 octave_idx_type rows, octave_idx_type cols); |
|
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 // 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
|
133 bool is_sorted_rows (const T *data, |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
134 octave_idx_type rows, octave_idx_type cols); |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
135 |
| 8700 | 136 static bool ascending_compare (T, T); |
| 137 static bool descending_compare (T, T); | |
| 4851 | 138 |
| 4998 | 139 private: |
| 140 | |
| 7234 | 141 // One MergeState exists on the stack per invocation of mergesort. |
| 142 // It's just a convenient way to pass state around among the helper | |
| 143 // functions. | |
| 144 // | |
| 145 // DGB: This isn't needed with mergesort in a class, but it doesn't | |
| 146 // slow things up, and it is likely to make my life easier for any | |
| 147 // potential backporting of changes in the Python code. | |
| 4851 | 148 |
| 149 struct s_slice | |
| 150 { | |
| 8700 | 151 octave_idx_type base, len; |
| 4851 | 152 }; |
| 153 | |
| 7234 | 154 struct MergeState |
| 4851 | 155 { |
| 7234 | 156 // This controls when we get *into* galloping mode. It's |
| 157 // initialized to MIN_GALLOP. merge_lo and merge_hi tend to nudge | |
| 158 // it higher for random data, and lower for highly structured | |
| 159 // data. | |
| 7433 | 160 octave_idx_type min_gallop; |
| 4851 | 161 |
| 7234 | 162 // 'a' is temp storage to help with merges. It contains room for |
| 163 // alloced entries. | |
| 164 T *a; // may point to temparray below | |
| 8700 | 165 octave_idx_type *ia; |
| 7433 | 166 octave_idx_type alloced; |
| 4851 | 167 |
| 7234 | 168 // A stack of n pending runs yet to be merged. Run #i starts at |
| 169 // address base[i] and extends for len[i] elements. It's always | |
| 170 // true (so long as the indices are in bounds) that | |
| 171 // | |
| 172 // pending[i].base + pending[i].len == pending[i+1].base | |
| 173 // | |
| 174 // so we could cut the storage for this, but it's a minor amount, | |
| 175 // and keeping all the info explicit simplifies the code. | |
| 7433 | 176 octave_idx_type n; |
| 4851 | 177 struct s_slice pending[MAX_MERGE_PENDING]; |
| 7234 | 178 }; |
| 4851 | 179 |
| 7234 | 180 bool (*compare) (T, T); |
| 4851 | 181 |
| 182 MergeState ms; | |
| 183 | |
| 8700 | 184 |
| 185 template <class Comp> | |
| 186 void binarysort (T *data, octave_idx_type nel, | |
| 187 octave_idx_type start, Comp comp); | |
| 188 | |
| 189 template <class Comp> | |
| 190 void binarysort (T *data, octave_idx_type *idx, octave_idx_type nel, | |
| 191 octave_idx_type start, Comp comp); | |
| 4851 | 192 |
| 8700 | 193 template <class Comp> |
| 194 octave_idx_type count_run (T *lo, octave_idx_type n, bool& descending, Comp comp); | |
| 4851 | 195 |
| 8700 | 196 template <class Comp> |
| 197 octave_idx_type gallop_left (T key, T *a, octave_idx_type n, octave_idx_type hint, | |
| 198 Comp comp); | |
| 4851 | 199 |
| 8700 | 200 template <class Comp> |
| 201 octave_idx_type gallop_right (T key, T *a, octave_idx_type n, octave_idx_type hint, | |
| 202 Comp comp); | |
| 4851 | 203 |
| 7234 | 204 void merge_init (void); |
| 4851 | 205 |
| 7234 | 206 void merge_freemem (void); |
| 4851 | 207 |
| 7433 | 208 int merge_getmem (octave_idx_type need); |
| 4851 | 209 |
| 8700 | 210 int merge_getmemi (octave_idx_type need); |
| 211 | |
| 212 template <class Comp> | |
| 213 int merge_lo (T *pa, octave_idx_type na, | |
| 214 T *pb, octave_idx_type nb, | |
| 215 Comp comp); | |
| 4851 | 216 |
| 8700 | 217 template <class Comp> |
| 218 int merge_lo (T *pa, octave_idx_type *ipa, octave_idx_type na, | |
| 219 T *pb, octave_idx_type *ipb, octave_idx_type nb, | |
| 220 Comp comp); | |
| 221 | |
| 222 template <class Comp> | |
| 223 int merge_hi (T *pa, octave_idx_type na, | |
| 224 T *pb, octave_idx_type nb, | |
| 225 Comp comp); | |
| 4851 | 226 |
| 8700 | 227 template <class Comp> |
| 228 int merge_hi (T *pa, octave_idx_type *ipa, octave_idx_type na, | |
| 229 T *pb, octave_idx_type *ipb, octave_idx_type nb, | |
| 230 Comp comp); | |
| 231 | |
| 232 template <class Comp> | |
| 233 int merge_at (octave_idx_type i, T *data, | |
| 234 Comp comp); | |
| 4851 | 235 |
| 8700 | 236 template <class Comp> |
| 237 int merge_at (octave_idx_type i, T *data, octave_idx_type *idx, | |
| 238 Comp comp); | |
| 239 | |
| 240 template <class Comp> | |
| 241 int merge_collapse (T *data, Comp comp); | |
| 4851 | 242 |
| 8700 | 243 template <class Comp> |
| 244 int merge_collapse (T *data, octave_idx_type *idx, Comp comp); | |
| 245 | |
| 246 template <class Comp> | |
| 247 int merge_force_collapse (T *data, Comp comp); | |
| 248 | |
| 249 template <class Comp> | |
| 250 int merge_force_collapse (T *data, octave_idx_type *idx, Comp comp); | |
| 4851 | 251 |
| 7433 | 252 octave_idx_type merge_compute_minrun (octave_idx_type n); |
| 8700 | 253 |
| 254 template <class Comp> | |
| 255 void sort (T *data, octave_idx_type nel, Comp comp); | |
| 256 | |
| 257 template <class Comp> | |
| 258 void sort (T *data, octave_idx_type *idx, octave_idx_type nel, Comp comp); | |
| 259 | |
|
8721
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
260 template <class Comp> |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
261 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
|
262 |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
263 template <class Comp> |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
264 void sort_rows (const T *data, octave_idx_type *idx, |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
265 octave_idx_type rows, octave_idx_type cols, |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
266 Comp comp); |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
267 |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
268 template <class Comp> |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
269 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
|
270 octave_idx_type cols, Comp comp); |
|
e9cb742df9eb
imported patch sort3.diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8700
diff
changeset
|
271 |
| 4851 | 272 }; |
| 273 | |
| 7433 | 274 template <class T> |
| 275 class | |
| 276 vec_index | |
| 277 { | |
| 278 public: | |
| 279 T vec; | |
| 280 octave_idx_type indx; | |
| 281 }; | |
| 4851 | 282 #endif |
| 283 | |
| 284 /* | |
| 285 ;;; Local Variables: *** | |
| 286 ;;; mode: C++ *** | |
| 287 ;;; End: *** | |
| 288 */ |