include/irrArray.h

   1 // Copyright (C) 2002-2012 Nikolaus Gebhardt\r
   2 // This file is part of the "Irrlicht Engine" and the "irrXML" project.\r
   3 // For conditions of distribution and use, see copyright notice in irrlicht.h and irrXML.h\r
   4 \r
   5 #ifndef __IRR_ARRAY_H_INCLUDED__\r
   6 #define __IRR_ARRAY_H_INCLUDED__\r
   7 \r
   8 #include "irrTypes.h"\r
   9 #include "heapsort.h"\r
  10 #include "irrAllocator.h"\r
  11 #include "irrMath.h"\r
  12 \r
  13 namespace irr\r
  14 {\r
  15 namespace core\r
  16 {\r
  17 \r
  18 //! Self reallocating template array (like stl vector) with additional features.\r
  19 /** Some features are: Heap sorting, binary search methods, easier debugging.\r
  20 */\r
  21 template <class T, typename TAlloc = irrAllocator<T> >\r
  22 class array\r
  23 {\r
  24 \r
  25 public:\r
  26 \r
  27         //! Default constructor for empty array.\r
  28         array() : data(0), allocated(0), used(0),\r
  29                         strategy(ALLOC_STRATEGY_DOUBLE), free_when_destroyed(true), is_sorted(true)\r
  30         {\r
  31         }\r
  32 \r
  33 \r
  34         //! Constructs an array and allocates an initial chunk of memory.\r
  35         /** \param start_count Amount of elements to pre-allocate. */\r
  36         explicit array(u32 start_count) : data(0), allocated(0), used(0),\r
  37                         strategy(ALLOC_STRATEGY_DOUBLE),\r
  38                         free_when_destroyed(true), is_sorted(true)\r
  39         {\r
  40                 reallocate(start_count);\r
  41         }\r
  42 \r
  43 \r
  44         //! Copy constructor\r
  45         array(const array<T, TAlloc>& other) : data(0)\r
  46         {\r
  47                 *this = other;\r
  48         }\r
  49 \r
  50 \r
  51         //! Destructor.\r
  52         /** Frees allocated memory, if set_free_when_destroyed was not set to\r
  53         false by the user before. */\r
  54         ~array()\r
  55         {\r
  56                 clear();\r
  57         }\r
  58 \r
  59 \r
  60         //! Reallocates the array, make it bigger or smaller.\r
  61         /** \param new_size New size of array.\r
  62         \param canShrink Specifies whether the array is reallocated even if\r
  63         enough space is available. Setting this flag to false can speed up\r
  64         array usage, but may use more memory than required by the data.\r
  65         */\r
  66         void reallocate(u32 new_size, bool canShrink=true)\r
  67         {\r
  68                 if (allocated==new_size)\r
  69                         return;\r
  70                 if (!canShrink && (new_size < allocated))\r
  71                         return;\r
  72 \r
  73                 T* old_data = data;\r
  74 \r
  75                 data = allocator.allocate(new_size); //new T[new_size];\r
  76                 allocated = new_size;\r
  77 \r
  78                 // copy old data\r
  79                 const s32 end = used < new_size ? used : new_size;\r
  80 \r
  81                 for (s32 i=0; i<end; ++i)\r
  82                 {\r
  83                         // data[i] = old_data[i];\r
  84                         allocator.construct(&data[i], old_data[i]);\r
  85                 }\r
  86 \r
  87                 // destruct old data\r
  88                 for (u32 j=0; j<used; ++j)\r
  89                         allocator.destruct(&old_data[j]);\r
  90 \r
  91                 if (allocated < used)\r
  92                         used = allocated;\r
  93 \r
  94                 allocator.deallocate(old_data); //delete [] old_data;\r
  95         }\r
  96 \r
  97 \r
  98         //! set a new allocation strategy\r
  99         /** if the maximum size of the array is unknown, you can define how big the\r
 100         allocation should happen.\r
 101         \param newStrategy New strategy to apply to this array. */\r
 102         void setAllocStrategy ( eAllocStrategy newStrategy = ALLOC_STRATEGY_DOUBLE )\r
 103         {\r
 104                 strategy = newStrategy;\r
 105         }\r
 106 \r
 107 \r
 108         //! Adds an element at back of array.\r
 109         /** If the array is too small to add this new element it is made bigger.\r
 110         \param element: Element to add at the back of the array. */\r
 111         void push_back(const T& element)\r
 112         {\r
 113                 insert(element, used);\r
 114         }\r
 115 \r
 116 \r
 117         //! Adds an element at the front of the array.\r
 118         /** If the array is to small to add this new element, the array is\r
 119         made bigger. Please note that this is slow, because the whole array\r
 120         needs to be copied for this.\r
 121         \param element Element to add at the back of the array. */\r
 122         void push_front(const T& element)\r
 123         {\r
 124                 insert(element);\r
 125         }\r
 126 \r
 127 \r
 128         //! Insert item into array at specified position.\r
 129         /**\r
 130         \param element: Element to be inserted\r
 131         \param index: Where position to insert the new element. */\r
 132         void insert(const T& element, u32 index=0)\r
 133         {\r
 134                 _IRR_DEBUG_BREAK_IF(index>used) // access violation\r
 135 \r
 136                 if (used + 1 > allocated)\r
 137                 {\r
 138                         // this doesn't work if the element is in the same\r
 139                         // array. So we'll copy the element first to be sure\r
 140                         // we'll get no data corruption\r
 141                         const T e(element);\r
 142 \r
 143                         // increase data block\r
 144                         u32 newAlloc;\r
 145                         switch ( strategy )\r
 146                         {\r
 147                                 case ALLOC_STRATEGY_DOUBLE:\r
 148                                         newAlloc = used + 5 + (allocated < 500 ? used : used >> 2);\r
 149                                         break;\r
 150                                 default:\r
 151                                 case ALLOC_STRATEGY_SAFE:\r
 152                                         newAlloc = used + 1;\r
 153                                         break;\r
 154                         }\r
 155                         reallocate( newAlloc);\r
 156 \r
 157                         // move array content and construct new element\r
 158                         // first move end one up\r
 159                         for (u32 i=used; i>index; --i)\r
 160                         {\r
 161                                 if (i<used)\r
 162                                         allocator.destruct(&data[i]);\r
 163                                 allocator.construct(&data[i], data[i-1]); // data[i] = data[i-1];\r
 164                         }\r
 165                         // then add new element\r
 166                         if (used > index)\r
 167                                 allocator.destruct(&data[index]);\r
 168                         allocator.construct(&data[index], e); // data[index] = e;\r
 169                 }\r
 170                 else\r
 171                 {\r
 172                         // element inserted not at end\r
 173                         if ( used > index )\r
 174                         {\r
 175                                 // create one new element at the end\r
 176                                 allocator.construct(&data[used], data[used-1]);\r
 177 \r
 178                                 // move the rest of the array content\r
 179                                 for (u32 i=used-1; i>index; --i)\r
 180                                 {\r
 181                                         data[i] = data[i-1];\r
 182                                 }\r
 183                                 // insert the new element\r
 184                                 data[index] = element;\r
 185                         }\r
 186                         else\r
 187                         {\r
 188                                 // insert the new element to the end\r
 189                                 allocator.construct(&data[index], element);\r
 190                         }\r
 191                 }\r
 192                 // set to false as we don't know if we have the comparison operators\r
 193                 is_sorted = false;\r
 194                 ++used;\r
 195         }\r
 196 \r
 197 \r
 198         //! Clears the array and deletes all allocated memory.\r
 199         void clear()\r
 200         {\r
 201                 if (free_when_destroyed)\r
 202                 {\r
 203                         for (u32 i=0; i<used; ++i)\r
 204                                 allocator.destruct(&data[i]);\r
 205 \r
 206                         allocator.deallocate(data); // delete [] data;\r
 207                 }\r
 208                 data = 0;\r
 209                 used = 0;\r
 210                 allocated = 0;\r
 211                 is_sorted = true;\r
 212         }\r
 213 \r
 214 \r
 215         //! Sets pointer to new array, using this as new workspace.\r
 216         /** Make sure that set_free_when_destroyed is used properly.\r
 217         \param newPointer: Pointer to new array of elements.\r
 218         \param size: Size of the new array.\r
 219         \param _is_sorted Flag which tells whether the new array is already\r
 220         sorted.\r
 221         \param _free_when_destroyed Sets whether the new memory area shall be\r
 222         freed by the array upon destruction, or if this will be up to the user\r
 223         application. */\r
 224         void set_pointer(T* newPointer, u32 size, bool _is_sorted=false, bool _free_when_destroyed=true)\r
 225         {\r
 226                 clear();\r
 227                 data = newPointer;\r
 228                 allocated = size;\r
 229                 used = size;\r
 230                 is_sorted = _is_sorted;\r
 231                 free_when_destroyed=_free_when_destroyed;\r
 232         }\r
 233 \r
 234 \r
 235         //! Sets if the array should delete the memory it uses upon destruction.\r
 236         /** Also clear and set_pointer will only delete the (original) memory\r
 237         area if this flag is set to true, which is also the default. The\r
 238         methods reallocate, set_used, push_back, push_front, insert, and erase\r
 239         will still try to deallocate the original memory, which might cause\r
 240         troubles depending on the intended use of the memory area.\r
 241         \param f If true, the array frees the allocated memory in its\r
 242         destructor, otherwise not. The default is true. */\r
 243         void set_free_when_destroyed(bool f)\r
 244         {\r
 245                 free_when_destroyed = f;\r
 246         }\r
 247 \r
 248 \r
 249         //! Sets the size of the array and allocates new elements if necessary.\r
 250         /** Please note: This is only secure when using it with simple types,\r
 251         because no default constructor will be called for the added elements.\r
 252         \param usedNow Amount of elements now used. */\r
 253         void set_used(u32 usedNow)\r
 254         {\r
 255                 if (allocated < usedNow)\r
 256                         reallocate(usedNow);\r
 257 \r
 258                 used = usedNow;\r
 259         }\r
 260 \r
 261 \r
 262         //! Assignment operator\r
 263         const array<T, TAlloc>& operator=(const array<T, TAlloc>& other)\r
 264         {\r
 265                 if (this == &other)\r
 266                         return *this;\r
 267                 strategy = other.strategy;\r
 268 \r
 269                 if (data)\r
 270                         clear();\r
 271 \r
 272                 //if (allocated < other.allocated)\r
 273                 if (other.allocated == 0)\r
 274                         data = 0;\r
 275                 else\r
 276                         data = allocator.allocate(other.allocated); // new T[other.allocated];\r
 277 \r
 278                 used = other.used;\r
 279                 free_when_destroyed = true;\r
 280                 is_sorted = other.is_sorted;\r
 281                 allocated = other.allocated;\r
 282 \r
 283                 for (u32 i=0; i<other.used; ++i)\r
 284                         allocator.construct(&data[i], other.data[i]); // data[i] = other.data[i];\r
 285 \r
 286                 return *this;\r
 287         }\r
 288 \r
 289 \r
 290         //! Equality operator\r
 291         bool operator == (const array<T, TAlloc>& other) const\r
 292         {\r
 293                 if (used != other.used)\r
 294                         return false;\r
 295 \r
 296                 for (u32 i=0; i<other.used; ++i)\r
 297                         if (data[i] != other[i])\r
 298                                 return false;\r
 299                 return true;\r
 300         }\r
 301 \r
 302 \r
 303         //! Inequality operator\r
 304         bool operator != (const array<T, TAlloc>& other) const\r
 305         {\r
 306                 return !(*this==other);\r
 307         }\r
 308 \r
 309 \r
 310         //! Direct access operator\r
 311         T& operator [](u32 index)\r
 312         {\r
 313                 _IRR_DEBUG_BREAK_IF(index>=used) // access violation\r
 314 \r
 315                 return data[index];\r
 316         }\r
 317 \r
 318 \r
 319         //! Direct const access operator\r
 320         const T& operator [](u32 index) const\r
 321         {\r
 322                 _IRR_DEBUG_BREAK_IF(index>=used) // access violation\r
 323 \r
 324                 return data[index];\r
 325         }\r
 326 \r
 327 \r
 328         //! Gets last element.\r
 329         T& getLast()\r
 330         {\r
 331                 _IRR_DEBUG_BREAK_IF(!used) // access violation\r
 332 \r
 333                 return data[used-1];\r
 334         }\r
 335 \r
 336 \r
 337         //! Gets last element\r
 338         const T& getLast() const\r
 339         {\r
 340                 _IRR_DEBUG_BREAK_IF(!used) // access violation\r
 341 \r
 342                 return data[used-1];\r
 343         }\r
 344 \r
 345 \r
 346         //! Gets a pointer to the array.\r
 347         /** \return Pointer to the array. */\r
 348         T* pointer()\r
 349         {\r
 350                 return data;\r
 351         }\r
 352 \r
 353 \r
 354         //! Gets a const pointer to the array.\r
 355         /** \return Pointer to the array. */\r
 356         const T* const_pointer() const\r
 357         {\r
 358                 return data;\r
 359         }\r
 360 \r
 361 \r
 362         //! Get number of occupied elements of the array.\r
 363         /** \return Size of elements in the array which are actually occupied. */\r
 364         u32 size() const\r
 365         {\r
 366                 return used;\r
 367         }\r
 368 \r
 369 \r
 370         //! Get amount of memory allocated.\r
 371         /** \return Amount of memory allocated. The amount of bytes\r
 372         allocated would be allocated_size() * sizeof(ElementTypeUsed); */\r
 373         u32 allocated_size() const\r
 374         {\r
 375                 return allocated;\r
 376         }\r
 377 \r
 378 \r
 379         //! Check if array is empty.\r
 380         /** \return True if the array is empty false if not. */\r
 381         bool empty() const\r
 382         {\r
 383                 return used == 0;\r
 384         }\r
 385 \r
 386 \r
 387         //! Sorts the array using heapsort.\r
 388         /** There is no additional memory waste and the algorithm performs\r
 389         O(n*log n) in worst case. */\r
 390         void sort()\r
 391         {\r
 392                 if (!is_sorted && used>1)\r
 393                         heapsort(data, used);\r
 394                 is_sorted = true;\r
 395         }\r
 396 \r
 397 \r
 398         //! Performs a binary search for an element, returns -1 if not found.\r
 399         /** The array will be sorted before the binary search if it is not\r
 400         already sorted. Caution is advised! Be careful not to call this on\r
 401         unsorted const arrays, or the slower method will be used.\r
 402         \param element Element to search for.\r
 403         \return Position of the searched element if it was found,\r
 404         otherwise -1 is returned. */\r
 405         s32 binary_search(const T& element)\r
 406         {\r
 407                 sort();\r
 408                 return binary_search(element, 0, used-1);\r
 409         }\r
 410 \r
 411 \r
 412         //! Performs a binary search for an element if possible, returns -1 if not found.\r
 413         /** This method is for const arrays and so cannot call sort(), if the array is\r
 414         not sorted then linear_search will be used instead. Potentially very slow!\r
 415         \param element Element to search for.\r
 416         \return Position of the searched element if it was found,\r
 417         otherwise -1 is returned. */\r
 418         s32 binary_search(const T& element) const\r
 419         {\r
 420                 if (is_sorted)\r
 421                         return binary_search(element, 0, used-1);\r
 422                 else\r
 423                         return linear_search(element);\r
 424         }\r
 425 \r
 426 \r
 427         //! Performs a binary search for an element, returns -1 if not found.\r
 428         /** \param element: Element to search for.\r
 429         \param left First left index\r
 430         \param right Last right index.\r
 431         \return Position of the searched element if it was found, otherwise -1\r
 432         is returned. */\r
 433         s32 binary_search(const T& element, s32 left, s32 right) const\r
 434         {\r
 435                 if (!used)\r
 436                         return -1;\r
 437 \r
 438                 s32 m;\r
 439 \r
 440                 do\r
 441                 {\r
 442                         m = (left+right)>>1;\r
 443 \r
 444                         if (element < data[m])\r
 445                                 right = m - 1;\r
 446                         else\r
 447                                 left = m + 1;\r
 448 \r
 449                 } while((element < data[m] || data[m] < element) && left<=right);\r
 450                 // this last line equals to:\r
 451                 // " while((element != array[m]) && left<=right);"\r
 452                 // but we only want to use the '<' operator.\r
 453                 // the same in next line, it is "(element == array[m])"\r
 454 \r
 455 \r
 456                 if (!(element < data[m]) && !(data[m] < element))\r
 457                         return m;\r
 458 \r
 459                 return -1;\r
 460         }\r
 461 \r
 462 \r
 463         //! Performs a binary search for an element, returns -1 if not found.\r
 464         //! it is used for searching a multiset\r
 465         /** The array will be sorted before the binary search if it is not\r
 466         already sorted.\r
 467         \param element Element to search for.\r
 468         \param &last return lastIndex of equal elements\r
 469         \return Position of the first searched element if it was found,\r
 470         otherwise -1 is returned. */\r
 471         s32 binary_search_multi(const T& element, s32 &last)\r
 472         {\r
 473                 sort();\r
 474                 s32 index = binary_search(element, 0, used-1);\r
 475                 if ( index < 0 )\r
 476                         return index;\r
 477 \r
 478                 // The search can be somewhere in the middle of the set\r
 479                 // look linear previous and past the index\r
 480                 last = index;\r
 481 \r
 482                 while ( index > 0 && !(element < data[index - 1]) && !(data[index - 1] < element) )\r
 483                 {\r
 484                         index -= 1;\r
 485                 }\r
 486                 // look linear up\r
 487                 while ( last < (s32) used - 1 && !(element < data[last + 1]) && !(data[last + 1] < element) )\r
 488                 {\r
 489                         last += 1;\r
 490                 }\r
 491 \r
 492                 return index;\r
 493         }\r
 494 \r
 495 \r
 496         //! Finds an element in linear time, which is very slow.\r
 497         /** Use binary_search for faster finding. Only works if ==operator is\r
 498         implemented.\r
 499         \param element Element to search for.\r
 500         \return Position of the searched element if it was found, otherwise -1\r
 501         is returned. */\r
 502         s32 linear_search(const T& element) const\r
 503         {\r
 504                 for (u32 i=0; i<used; ++i)\r
 505                         if (element == data[i])\r
 506                                 return (s32)i;\r
 507 \r
 508                 return -1;\r
 509         }\r
 510 \r
 511 \r
 512         //! Finds an element in linear time, which is very slow.\r
 513         /** Use binary_search for faster finding. Only works if ==operator is\r
 514         implemented.\r
 515         \param element: Element to search for.\r
 516         \return Position of the searched element if it was found, otherwise -1\r
 517         is returned. */\r
 518         s32 linear_reverse_search(const T& element) const\r
 519         {\r
 520                 for (s32 i=used-1; i>=0; --i)\r
 521                         if (data[i] == element)\r
 522                                 return i;\r
 523 \r
 524                 return -1;\r
 525         }\r
 526 \r
 527 \r
 528         //! Erases an element from the array.\r
 529         /** May be slow, because all elements following after the erased\r
 530         element have to be copied.\r
 531         \param index: Index of element to be erased. */\r
 532         void erase(u32 index)\r
 533         {\r
 534                 _IRR_DEBUG_BREAK_IF(index>=used) // access violation\r
 535 \r
 536                 for (u32 i=index+1; i<used; ++i)\r
 537                 {\r
 538                         allocator.destruct(&data[i-1]);\r
 539                         allocator.construct(&data[i-1], data[i]); // data[i-1] = data[i];\r
 540                 }\r
 541 \r
 542                 allocator.destruct(&data[used-1]);\r
 543 \r
 544                 --used;\r
 545         }\r
 546 \r
 547 \r
 548         //! Erases some elements from the array.\r
 549         /** May be slow, because all elements following after the erased\r
 550         element have to be copied.\r
 551         \param index: Index of the first element to be erased.\r
 552         \param count: Amount of elements to be erased. */\r
 553         void erase(u32 index, s32 count)\r
 554         {\r
 555                 if (index>=used || count<1)\r
 556                         return;\r
 557                 if (index+count>used)\r
 558                         count = used-index;\r
 559 \r
 560                 u32 i;\r
 561                 for (i=index; i<index+count; ++i)\r
 562                         allocator.destruct(&data[i]);\r
 563 \r
 564                 for (i=index+count; i<used; ++i)\r
 565                 {\r
 566                         if (i-count >= index+count) // not already destructed before loop\r
 567                                 allocator.destruct(&data[i-count]);\r
 568 \r
 569                         allocator.construct(&data[i-count], data[i]); // data[i-count] = data[i];\r
 570 \r
 571                         if (i >= used-count) // those which are not overwritten\r
 572                                 allocator.destruct(&data[i]);\r
 573                 }\r
 574 \r
 575                 used-= count;\r
 576         }\r
 577 \r
 578 \r
 579         //! Sets if the array is sorted\r
 580         void set_sorted(bool _is_sorted)\r
 581         {\r
 582                 is_sorted = _is_sorted;\r
 583         }\r
 584 \r
 585 \r
 586         //! Swap the content of this array container with the content of another array\r
 587         /** Afterward this object will contain the content of the other object and the other\r
 588         object will contain the content of this object.\r
 589         \param other Swap content with this object */\r
 590         void swap(array<T, TAlloc>& other)\r
 591         {\r
 592                 core::swap(data, other.data);\r
 593                 core::swap(allocated, other.allocated);\r
 594                 core::swap(used, other.used);\r
 595                 core::swap(allocator, other.allocator); // memory is still released by the same allocator used for allocation\r
 596                 eAllocStrategy helper_strategy(strategy); // can't use core::swap with bitfields\r
 597                 strategy = other.strategy;\r
 598                 other.strategy = helper_strategy;\r
 599                 bool helper_free_when_destroyed(free_when_destroyed);\r
 600                 free_when_destroyed = other.free_when_destroyed;\r
 601                 other.free_when_destroyed = helper_free_when_destroyed;\r
 602                 bool helper_is_sorted(is_sorted);\r
 603                 is_sorted = other.is_sorted;\r
 604                 other.is_sorted = helper_is_sorted;\r
 605         }\r
 606 \r
 607         typedef TAlloc allocator_type;\r
 608         typedef T value_type;\r
 609         typedef u32 size_type;\r
 610 \r
 611 private:\r
 612         T* data;\r
 613         u32 allocated;\r
 614         u32 used;\r
 615         TAlloc allocator;\r
 616         eAllocStrategy strategy:4;\r
 617         bool free_when_destroyed:1;\r
 618         bool is_sorted:1;\r
 619 };\r
 620 \r
 621 \r
 622 } // end namespace core\r
 623 } // end namespace irr\r
 624 \r
 625 #endif\r
 626 \r