-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathlist.h
1918 lines (1636 loc) · 72.8 KB
/
list.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* clang-format off */
/*****************************************************************************
The MIT License
Copyright © 2005 Pavel Karelin (hkarel), <hkarel@yandex.ru>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
---
В модуле реализован класс-список (List) с доступом к элементам по индексу.
Реализованы механизмы:
- быстрой сортировки;
- частичной сортировки;
- быстрого поиска;
- грубого поиска;
- возможность добавлять элементы в список без нарушения порядка
сортировки
*****************************************************************************/
#pragma once
#include <exception>
#include <string.h>
#include "break_point.h"
namespace lst {
/// @brief Определяет является ли список владельцем (контейнером)
/// для элементов
enum class Container {No = 0, Yes = 1};
/// @brief Определяет необходимость сжатия списка после удаления
/// из него элемента
enum class CompressList {No = 0, Yes = 1};
/// @brief Признак поиска простым перебором (метод грубой силы)
enum class BruteForce {No = 0, Yes = 1};
/// @brief Флаги направления сортировки
enum class SortMode
{
Down = 0, /// Сортировать по убыванию
Up = 1 /// Сортировать по возрастанию
};
/// @brief Флаги сдвига списка
enum class ShiftMode
{
Left = 0, /// Сдвинуть элементы списка влево
Right = 1 /// Сдвинуть элементы списка вправо
};
/// @brief Флаги состояний сортировки
enum class SortState
{
Unknown = 0, /// Список находится в не отсортированном состоянии
Up = 1, /// Список отсортирован по возрастанию
Down = 2, /// Список отсортирован по убыванию
CustomUp = 3, /// Список частично отсортирован по возрастанию
CustomDown = 4 /// Список частично отсортирован по убыванию
};
class FindResult;
template<typename ListT, typename CompareT>
FindResult find(const ListT&, const CompareT&);
template<typename ListT, typename CompareL>
FindResult firstFindResultL(const ListT&, const CompareL&, const FindResult&);
template<typename ListT, typename CompareL>
FindResult lastFindResultL(const ListT&, const CompareL&, const FindResult&);
template<typename, typename, typename> class CustomList;
template<typename, typename, typename> class List;
/// @brief Проверяет принадлежность значения index диапазону [minVal-maxVal)
///
/// Значение minVal включено в диапазон проверки, maxVal - нет
template<typename T>
inline bool inRange(T index, T minVal, T maxVal)
{
return ((index >= minVal) && (index < maxVal));
}
/// @brief Функция проверяет находится ли значение index в границах списка
///
/// Если index удовлетворяет условию 0 <= index < count() функция вернет TRUE
template<typename ListType>
inline bool checkBounds(int index, const ListType& list)
{
return inRange(index, 0, list.size());
}
/**
@brief Класс ListExcept. Используется для обработки исключений
*/
class ListExcept : public std::exception
{
char _msg[512];
public:
ListExcept(const char* msg, const char* func)
{
memset(_msg, 0, sizeof(_msg));
strcat(_msg, "Function [");
strcat(_msg, func);
strcat(_msg, "]: ");
strcat(_msg, msg);
}
virtual const char* what() const noexcept {return _msg;}
};
constexpr const char* ERR_NOCREATE_OBJ =
"Impossible create object of the class. (Container::No)";
#if defined(_MSC_VER)
#define LIST_EXCEPT(MSG) ListExcept(MSG, __FUNCTION__)
#else
#define LIST_EXCEPT(MSG) ListExcept(MSG, __func__)
#endif
#ifndef NDEBUG
# define CHECK_BORDERS(INDEX) \
if ((INDEX < 0) || (INDEX >= d->count)) throw LIST_EXCEPT("Index out of bounds");
# define CHECK_NOTLESS(INDEX, LESS) \
if (INDEX < LESS) throw LIST_EXCEPT("Index must not be less than "#LESS);
# define CHECK_INTERNAL_DATA_PTR(DPTR) \
if (DPTR == nullptr) throw LIST_EXCEPT("Internal data-pointer is null");
#else
# define CHECK_BORDERS(INDEX)
# define CHECK_NOTLESS(INDEX, LESS)
# define CHECK_INTERNAL_DATA_PTR(DPTR)
#endif // NDEBUG
/**
@brief Класс BreakCompare. Используется в функциях/стратегиях сравнения
элементов для прерырания процессов сортировки или поиска
*/
struct BreakCompare {};
/**
@brief Класс FindResult - результат функций поиска.
Для отсортированного списка:
- если элемент найден, то success() == true, а index() вернет позицию эле-
мента в списке;
- если элемент не найден, то success() == false, а index() вернет позицию
в которую можно вставить ненайденный элемент, и список при этом останется
отсортированным.
Для вставки элемента в отсортированный список используется функция
List::addInSort()
Для неотсортированного списка:
- если элемент найден, то success() == true, а функция index() вернет
позицию элемента в списке;
- если элемент не найден, то success() == false, а функция index()
вернет количество элементов в списке (count)
*/
class FindResult
{
public:
FindResult() : _index(-1), _success(false), _bruteForce(false) {}
bool success() const noexcept {return _success;}
bool failed() const noexcept {return !_success;}
int index() const noexcept {return _index;}
bool bruteForce() const noexcept {return _bruteForce;}
explicit operator bool() const noexcept {return _success;}
private:
int _index;
unsigned _success : 1;
unsigned _bruteForce : 1;
unsigned _reserved : 30;
FindResult(bool success, BruteForce bruteForce, int index)
: _index(index), _success(success), _bruteForce(bool(bruteForce))
{}
template<typename, typename, typename> friend class CustomList;
template<typename ListT, typename CompareT>
friend FindResult find(const ListT&, const CompareT&);
template<typename ListT, typename CompareL>
friend FindResult firstFindResultL(const ListT&, const CompareL&, const FindResult&);
template<typename ListT, typename CompareL>
friend FindResult lastFindResultL(const ListT&, const CompareL&, const FindResult&);
};
struct FindResultRange
{
FindResult first;
FindResult last;
};
/**
@brief Сервисная структура, используется для агрегации расширенных параметров
поиска
*/
struct FindExtParams
{
/// Признак поиска простым перебором (метод грубой силы).
/// Если bruteForce = Yes поиск будет происходить простым перебором, даже для
/// отсортированного списка
BruteForce bruteForce = {BruteForce::No};
/// Индекс с которого начинается поиск.
/// Если startFindIndex >= list::count(), то функция поиска вернет результат
/// со статусом FindResult::failed() = TRUE. При этом если элемент с данным
/// статусом будет добавлен в отсортированный список через функцию addInSort(),
/// то флаг сортировки будет сброшен (см. пояснения к функции list::addInSort())
int startFindIndex = {0};
FindExtParams() = default;
FindExtParams(BruteForce bruteForce)
: bruteForce(bruteForce), startFindIndex(0)
{}
};
/**
@brief Сервисная структура, используется для агрегации расширенных параметров
сортировки
*/
struct SortExtParams
{
/// loSortBorder, hiSortBorder Границы сортировки, позволяют производить
/// сортировку по указанному диапазону. При назначении диапазона соблюдаются
/// следующие требования:
/// 1) 0 <= loSortBorder < count(), в противном случае loSortBorder
/// выставляется в 0;
/// 2) loSortBorder < hiSortBorder <= count(), в противном случае
/// hiSortBorder выставляется в count (количество элементов в списке).
/// Значения по умолчанию {0, -1} предполагают сортировку по всему диапазону
int loSortBorder = {0};
int hiSortBorder = {-1};
SortExtParams() = default;
SortExtParams(int loSortBorder, int hiSortBorder = -1)
: loSortBorder(loSortBorder), hiSortBorder(hiSortBorder)
{}
};
/**
@brief Функции выполняют поиск перебором (грубый поиск).
Первые две функции выполнены для использования с lambda-функциями
с сигнатурой:
int [](const ListT::ValueType* item), где item элемент списка.
Следующие три функции в качестве compare-элемента используют функцию
или функтор со следующей сигнатурой:
int function(const T* item1, const ListT::ValueType* item2)
Примечание: в качестве контейнера ListT можно использовать std::vector
*/
template<typename ListT, typename CompareL>
FindResult find(const ListT& list, const CompareL& compare);
template<typename ListT, typename CompareL>
auto findItem(const ListT& list, const CompareL& compare) -> typename ListT::pointer;
//---
template<typename T, typename ListT, typename CompareT>
FindResult find(const T* item, const ListT& list, const CompareT& compare);
template<typename T, typename ListT, typename CompareT>
FindResult findRef(const T& item, const ListT& list, const CompareT& compare);
template<typename T, typename ListT, typename CompareT>
T* findItem(const T* item, const ListT& list, const CompareT& compare);
/**
@brief Группа функций выполняет поиск первого или последнего элемента в после-
довательности одинаковых значений.
Если список содержит не уникальные значения, то при его сортировке одинаковые
значения будут идти друг за другом. При использовании функций быстрого поиска
в таком списке, с высокой долей вероятности, найденное значение будет
не первым, и не последним в последовательности одинаковых значений. Однако,
наиболее часто требуются первое или последнее значения.
В качестве результата возвращается индекс первого/последнего элемента в после-
довательности
*/
/// Примечание: в качестве compare-элемента используется lambda-функция
/// с сигнатурой:
/// int [](const ListT::ValueType* item), где item элемент списка
template<typename ListT, typename CompareL>
FindResult firstFindResultL(const ListT& list, const CompareL& compare,
const FindResult& fr);
template<typename ListT, typename CompareL>
FindResult lastFindResultL(const ListT& list, const CompareL& compare,
const FindResult& fr);
/// Примечание: в качестве compare-элемента используется функция или функтор
/// с сигнатурой:
/// int function(const ListT::ValueType* item1, const ListT::ValueType* item2)
template<typename ListT, typename CompareT>
FindResult firstFindResult(const ListT& list, const CompareT& compare,
const FindResult& fr);
template<typename ListT, typename CompareT>
FindResult lastFindResult(const ListT& list, const CompareT& compare,
const FindResult& fr);
/**
@brief Группа функций выполняет поиск первого и последнего элемента в после-
довательности одинаковых значений
*/
template<typename ListT, typename CompareL>
FindResultRange rangeFindResultL(const ListT& list, const CompareL& compare,
const FindResult& fr);
template<typename ListT, typename CompareT>
FindResultRange rangeFindResult(const ListT& list, const CompareT& compare,
const FindResult& fr);
/**
@brief Макрос используется в классе-стратегии сортировки и поиска
*/
#define LIST_COMPARE_ITEM(ITEM1, ITEM2) \
((ITEM1 > ITEM2) ? 1 : ((ITEM1 < ITEM2) ? -1 : 0))
/**
@brief Макрос используется в классе-стратегии сортировки и поиска в тех
случаях, когда сортировка или поиск выполняются по нескольким полям.
Ниже приведен пример использования. Здесь сортировка выполняется по трем
полям с убывающим приоритетом сравнения от field1 к field3.
struct Compare
{
int operator() (const Type* item1, const Type* item2) const
{
LIST_COMPARE_MULTI_ITEM( item1->field1, item2->field1)
LIST_COMPARE_MULTI_ITEM( item1->field2, item2->field2)
return LIST_COMPARE_ITEM(item1->field3, item2->field3);
}
};
Альтернативный вариант записи
struct Compare
{
int operator() (const Type* item1, const Type* item2) const
{
LIST_COMPARE_MULTI_ITEM(item1->field1, item2->field1)
LIST_COMPARE_MULTI_ITEM(item1->field2, item2->field2)
LIST_COMPARE_MULTI_ITEM(item1->field3, item2->field3)
return 0;
}
};
*/
#define LIST_COMPARE_MULTI_ITEM(ITEM1, ITEM2) \
if (ITEM1 != ITEM2) return (ITEM1 < ITEM2) ? -1 : 1;
/**
@brief Класс-стратегия используется для сортировки и поиска.
*/
template<typename T> struct CompareItem
{
/// @param[in] item1 Первый сравниваемый элемент.
/// @param[in] item2 Второй сравниваемый элемент.
/// @return Результат сравнения.
/// Примечание: Оператор не должен быть виртуальным. Если оператор сделать
/// виртуальным, то для каждого инстанциируемого класса придется определять
/// операторы "<", ">", "==", что сводит "на нет" идею класса-стратегии
/// применительно к сортировке
int operator() (const T* item1, const T* item2) const
{
return LIST_COMPARE_ITEM(*item1, *item2);
}
};
/**
@brief Фиктивный класс-стратегия используется в тех случаях, когда нужно явно
указать, что никакие стратегии сортировки использовать не планируется
*/
struct CompareItemDummy {};
/**
@brief Распределитель памяти для элементов списка
*/
template<typename T> struct AllocItem
{
/// @brief Функция создания объектов.
///
/// Примечания:
/// 1) Должно быть две функции create(). Если использовать только одну
/// функцию вида:
/// T* create(const T* x = 0) {return (x) ? new T(*x) : new T();}
/// то компилятор будет требовать обязательное наличие конструктора
/// копирования у инстанциируемого класса;
/// 2) Функции create()/destroy() не могут быть статическими, так как
/// аллокатор может иметь состояния;
/// 3) Функции create()/destroy() должны быть неконстантными, так как их
/// вызов в конкретных реализациях может приводить к изменению состояния
/// экземпляра распределителя памяти
T* create() {return new T();}
T* create(const T* x) {return (x) ? new T(*x) : new T();}
/// @brief Функция разрушения элементов
void destroy(T* x) {
static_assert(sizeof(T) > 0, "Can't delete pointer to incomplete type");
delete x;
}
};
/**
@brief Класс CustomList.
Класс не является потокобезопасным, следует с осторожностью допускать
одновременный вызов методов данного класса из разных потоков
*/
template<
typename T,
typename Compare,
typename Allocator
>
class CustomList
{
public:
typedef T* PointerType;
typedef T ValueType;
typedef Compare CompareType;
typedef Allocator AllocatorType;
typedef CustomList<T, Compare, Allocator> CustomListType;
// Для совместимости с STL
typedef T* pointer;
typedef const T* const_pointer;
typedef T& reference;
typedef const T& const_reference;
typedef T** iterator;
typedef const T** const_iterator;
typedef T value_type;
public:
/// @brief Функция поиска по адресу элемента.
///
/// @param[in] item Искомый элемент.
/// @return Индекс искомого элемента, в случае неудачи возвращает -1
int indexOf(const T* item) const;
/// @brief Функция поиска по адресу элемента.
///
/// @param[in] item Искомый элемент.
/// @param[out] index В случае удачи содержит индекс искомого элемента.
/// @return В случае удачного поиска возвращает TRUE
bool indexOf2(const T* item, int& index) const;
/// @brief Функция проверяет находится ли значение index в границах списка.
///
/// Если index удовлетворяет условию 0 <= index < count(), то функция
/// возвращает TRUE, в противном случае функция возвращает FALSE
bool checkBounds(int index) const {return inRange(index, 0, d->count);}
/// @brief Функции поиска.
///
/// @param[in] item Искомый элемент.
/// @param[in] extParams Используется для задания расширенных параметров
/// поиска.
/// @return Структура с результатом поиска
template<typename U>
FindResult find(const U* item,
const FindExtParams& extParams = FindExtParams()) const;
/// @brief Перегруженные функции поиска, определена для удобства использования.
///
/// @return Возвращает указатель на искомый элемент, если элемент не найден -
/// функция вернет nullptr
template<typename U>
T* findItem(const U* item,
const FindExtParams& extParams = FindExtParams()) const;
/// @brief Перегруженные функции поиска, определена для удобства использования.
///
/// @param[in] item Искомый элемент передаваемый по ссылке
template<typename U>
FindResult findRef(const U& item,
const FindExtParams& extParams = FindExtParams()) const;
/// @brief Перегруженные функции поиска, определены для удобства использования.
///
/// Позволяет выполнять поиск со стратегией поиска отличной от той,
/// что была определена в классе-контейнере
template<typename U, typename CompareU>
FindResult find(const U* item, const CompareU& compare,
const FindExtParams& extParams = FindExtParams()) const;
template<typename U, typename CompareU>
T* findItem(const U* item, const CompareU& compare,
const FindExtParams& extParams = FindExtParams()) const;
template<typename U, typename CompareU>
FindResult findRef(const U& item, const CompareU& compare,
const FindExtParams& extParams = FindExtParams()) const;
/// @brief Функции поиска.
///
/// В качестве стратегии поиска используется lambda-функция с сигнатурой
/// int [](const CustomList::ValueType* item)
template<typename CompareL>
FindResult findL(const CompareL& compare,
const FindExtParams& extParams = FindExtParams()) const;
template<typename CompareL>
T* findItemL(const CompareL& compare,
const FindExtParams& extParams = FindExtParams()) const;
/// @brief Доступ к элементу списка по индексу.
///
/// @return Возвращает указатель на элемент
T* item(int index) const {CHECK_BORDERS(index); return d_func()->list[index];}
/// @brief Доступ к элементу списка по индексу.
///
/// @return Возвращает ссылку на элемент
T& itemRef(int index) {return *item(index);}
const T& itemRef(int index) const {return *item(index);}
/// @brief Доступ к элементу списка по индексу.
///
/// @return Возвращает ссылку на элемент, аналогично функции itemRef()
T& operator[] (int index) {return *item(index);}
const T& operator[] (int index) const {return *item(index);}
/// @brief Доступ к элементу списка по индексу.
///
/// @return Возвращает ссылку на элемент. Функция обеспечивает совместимость
/// с STL
const T& at(int index) const {return *item(index);}
/// @brief Возвращает указатель на адрес первого элемента в линейном массиве
/// указателей на элементы
T** listBegin() const {return d_func()->list;}
/// @brief Возвращает указатель на адрес идущий за последним элементом
/// в линейном массиве указателей на элементы
T** listEnd() const {return (d_func()->list + d_func()->count);}
/// @brief Возвращает указатель на адрес первого элемента в линейном массиве
/// указателей на элементы.
///
/// Используется в конструкции вида: for (T* t : List)
T** begin() const {return listBegin();}
/// @brief Возвращает указатель на адрес идущий за последним элементом
/// в линейном массиве указателей на элементы.
///
/// Используется в конструкции вида: for (T* t : List)
T** end() const {return listEnd();}
/// @brief Возвращает количество элементов в списке
int count() const {return d_func()->count;}
/// @brief Возвращает зарезервированную длинну массива list()
int capacity() const {return d_func()->capacity;}
/// @brief Признак того, что список является контейнером.
///
/// Если container() == Container::Yes, то при разрушении или очистке списка
/// все элементы будут автоматически разрушены, в противном случае элементы
/// списка разрушены не будут
Container container() const {return d_func()->container;}
/// @brief Определяет состояние сортировки
SortState sortState() const {return d_func()->sortState;}
/// @brief Возвращает ссылку на стратегию сортировки
Compare& compare() {return d_func()->compare;}
/// @brief Возвращает константную ссылку на стратегию сортировки
const Compare& compare() const {return d_func()->compare;}
/// @brief Возвращает ссылку на распределитель памяти
Allocator& allocator() {return d_func()->allocator;}
/// @brief Возвращает константную ссылку на распределитель памяти
const Allocator& allocator() const {return d_func()->allocator;}
/// @brief Возвращает количество элементов в списке. Функция обеспечивает
/// совместимость с STL
int size() const {return count();}
/// @brief Возвращает true если список пуст
bool empty() const {return (count() == 0);}
/// @brief Возвращает первый элемент в списке. Если список пустой,
/// то возвращает нуль
T* first() const {return (d_func()->count) ? d->list[0] : nullptr;}
/// @brief Возвращает последний элемент в списке. Если список пустой,
/// то возвращает нуль
T* last() const {return (d_func()->count) ? d->list[d->count - 1] : nullptr;}
template<typename IteratorT> class Range
{
public:
IteratorT** begin() const {return _begin;}
IteratorT** end() const {return _end;}
private:
Range() {}
IteratorT** _begin;
IteratorT** _end;
template<typename, typename, typename> friend class CustomList;
};
typedef Range<T> RangeType;
/// @brief Сервисные функции, возвращают структуру Range содержащую пару
/// итераторов указывающих на первый элемент и на элемент идущий
/// за последним для заданного диапазона значений.
///
/// Основное назначение этих функций - это использование в конструкции
/// вида: for (T* t : range).
/// @param[in] index1 Индекс первого элемента в диапазоне.
/// @param[in] index2 Индекс последнего элемента в диапазоне.
/// @return Структура Range определяющая диапазон
RangeType range(int index1, int index2) const;
RangeType range(const FindResultRange&) const;
private:
CustomList() {}
~CustomList() {}
private:
CustomList(CustomListType&&) = delete;
CustomList(const CustomListType&) = delete;
CustomListType& operator= (CustomListType&&) = delete;
CustomListType& operator= (const CustomListType&) = delete;
private:
template<typename DataT> struct Data
{
DataT** list = {nullptr};
int count = {0};
int capacity = {0};
SortState sortState = {SortState::Unknown};
Container container = {Container::Yes};
Compare compare;
Allocator allocator;
};
typedef Data<T> DataType;
DataType* d = {nullptr};
DataType* d_func() const {CHECK_INTERNAL_DATA_PTR(d); return d;}
template<typename, typename, typename> friend class List;
};
/**
@brief Класс List.
Класс не является потокобезопасным
*/
template<
typename T,
typename Compare = CompareItem<T>,
typename Allocator = AllocItem<T>
>
class List : public CustomList<T, Compare, Allocator>
{
public:
typedef List<T, Compare, Allocator> SelfListType;
typedef CustomList<T, Compare, Allocator> CustomListType;
typedef typename CustomListType::PointerType PointerType;
typedef typename CustomListType::ValueType ValueType;
typedef typename CustomListType::CompareType CompareType;
typedef typename CustomListType::AllocatorType AllocatorType;
typedef typename CustomListType::RangeType RangeType;
// Для совместимости с STL
typedef typename CustomListType::pointer pointer;
typedef typename CustomListType::const_pointer const_pointer;
typedef typename CustomListType::reference reference;
typedef typename CustomListType::const_reference const_reference;
typedef typename CustomListType::iterator iterator;
typedef typename CustomListType::const_iterator const_iterator;
typedef typename CustomListType::value_type value_type;
public:
List();
List(const Allocator&, Container container = Container::Yes);
explicit List(Container container);
List(SelfListType&&);
List(const SelfListType&) = delete;
~List();
SelfListType& operator= (SelfListType&&);
SelfListType& operator= (const SelfListType&) = delete;
/// @brief Добавляет новый элемент T в конец списка.
///
/// Класс элемента должен иметь конструктор по умолчанию.
/// @return Возвращает указатель на добавленный элемент
T* add();
/// @brief Добавляет уже созданный элемент T в конец списка.
///
/// @param[in] item Добавляемый элемент.
/// @return Возвращает указатель на добавленный элемент
T* add(T* item);
/// @brief Добавляет копию элемента T в конец списка.
///
/// @return Возвращает указатель на добавленный элемент
T* addCopy(const T& item);
/// @brief Добавляет новый элемент T в указанную позицию в списке.
///
/// Если index больше количества элементов в списке (count()), то элемент
/// будет добавлен в конец списка. Класс элемента T должен иметь конструктор
/// по умолчанию.
/// @param[in] index Позиция вставки нового элемента.
/// @return Возвращает указатель на добавленный элемент
T* insert(int index = 0);
/// @brief Добавляет существующий элемент T в указанную позицию в списке.
///
/// Если index больше количества элементов в списке (count()), то элемент
/// будет добавлен в конец списка. Класс элемента T должен иметь конструктор
/// по умолчанию.
/// @param[in] item Добавляемый элемент.
/// @param[in] index Позиция вставки нового элемента.
/// @return Возвращает указатель на добавленный элемент
T* insert(T* item, int index = 0);
/// @brief Добавляет копию элемента T в указанную позицию в списке.
T* insertCopy(const T& item, int index = 0);
/// @brief Удаляет элемент из списка.
///
/// При удалении элемента из списка происходит его разрушение.
/// @param[in] index Индекс удаляемого элемента.
/// @param[in] compressList Признак сжатия списка. Если compressList
/// равен CompressList::No, то ячейкам в массиве списка присваивается 0.
/// Таким образом получается разряженный список содержащий null-значения
void remove(int index, CompressList compressList = CompressList::Yes);
/// @brief Удаляет элемент из списка.
///
/// При удалении элемента из списка происходит его разрушение.
/// @param[in] item Элемент удаляемый из списка.
/// @param[in] compressList Признак сжатия списка.
/// @return Индекс удаленного элемента, если элемент не присутствовал
/// в списке возвращает int(-1)
int removeItem(T* item, CompressList compressList = CompressList::Yes);
/// @brief Удаляет последний элемент из списка.
///
/// При удалении элемента из списка происходит его разрушение
void removeLast();
/// @brief Удаляет элементы из списка согласно условию condition.
///
/// При удалении элементов из списка происходит их разрушение.
/// @param[in] condition Функор или функция с сигнатурой bool condition(T*).
/// Если condition возвращает TRUE, то элемент удаляется из списка.
/// @param[in] compressList Признак сжатия списка
template<typename Condition>
void removeCond(const Condition& condition,
CompressList compressList = CompressList::Yes);
/// @brief Удаляет элементы из списка.
///
/// При удалении элементов из списка происходит их разрушение.
/// @param[in] index Индекс с которого начнется удаление элементов.
/// @param[in] count Количество удаляемых элементов.
/// @param[in] compressList Признак сжатия списка
void removes(int index, int count,
CompressList compressList = CompressList::Yes);
/// @brief Заменяет элемент в списке.
///
/// @param[in] index Индекс в котором будет произведена замена.
/// @param[in] item Новый элемент в списке.
/// @param[in] keepSortState Признак сохранения флага сортировки
void replace(int index, T* item, bool keepSortState = false);
/// @brief Удаляет элемент из списка, при этом разрушения элемента не происходит.
///
/// @param[in] index Индекс удаляемого элемента.
/// @param[in] compressList Признак сжатия списка (см. описание для remove()).
/// @return Возвращает указатель на удаленный из списка элемент
T* release(int index, CompressList compressList = CompressList::Yes);
/// @brief Удаляет элемент из списка, при этом разрушения элемента не происходит.
///
/// @param[in] item Удаляемый элемент.
/// @param[in] compressList Признак сжатия списка (см. описание для remove()).
/// @return В случае успешного удаления возвращает индекс удаленного элемента
int releaseItem(T* item, CompressList compressList = CompressList::Yes);
/// @brief Удаляет последний элемент из списка при этом разрушения элемента
/// не происходит.
///
/// Типичное использование этого оператора в конструкциях вида:
/// while (T* t = list.releaseLast()) {
/// ...
/// delete t;
/// }
/// Такой подход может иметь преимущества по скорости при условии большого
/// количества элементов в списке перед конструкцией вида:
/// while (list.count()) {
/// T* t = list.release(0);
/// ...
/// delete t;
/// }
/// Если в списке нет элементов будет возвращен nullptr
T* releaseLast();
/// @brief Меняет местами элементы в списке.
///
/// @param[in] index1 Индекс первого элемента.
/// @param[in] index2 Индекс второго элемента
void exchange(int index1, int index2);
/// @brief Перемещает элемент из позиции curIndex в позицию newIndex
void move(int curIndex, int newIndex);
/// @brief Очищает список элементов
void clear();
/// @brief Устанавливает новый размер массива указателей на элементы списка.
///
/// Указатель на массив указателей элементов списка можно получить через
/// функцию listBegin().
/// @param[in] newCapacity Новая длинна массива указателей
void setCapacity(int newCapacity);
/// @brief Изменяет глобальную стратегию сортировки и поиска.
void setCompare(const Compare& val) {d_func()->compare = val;}
/// @brief Функция сжатия списка.
///
/// Удаляет нулевые ячейки, которые могли образоваться в массиве указателей
/// на элементы при вызове методов удаления элементов (remove(), release())
/// с параметром compressList равным CompressList::No
void compressList();
/// @brief Функция добавляет элемент в отсортированный список
/// (флаг сортировки не сбрасывается).
///
/// Предполагается, что вставка нового элемента не нарушит порядок сортировки
/// элементов в отсортированном списке. Чтобы порядок сортировки оставался
/// неизменным - индекс вставки должен быть корректным. Корректный индекс
/// можно определить при помощи функции find() и структуры FindResult.
/// Если элемент не найден в списке, то в структуре FindResult будет возвращен
/// индекс для корректной вставки элемента в список.
/// Если флаг сортировки не определен (список не отсортирован), то элемент
/// будет добавлен в конец списка. При частичной сортировке - флаг состояния
/// сортировки будет сброшен, а элемент будет добавлен в конец списка.
/// ПРИМЕЧАНИЕ: В случае, когда перед вставкой элемента производится поиск
/// с флагом bruteForce = TRUE, и результат поиска FindResult используется
/// для вставки нового элемента через addInSort() - элемент будет добавлен
/// в конец списка, а флаг состояния сортировки будет сброшен.
/// @param[in] item Добавляемый элемент.
/// @param[in] fr Позиция вставки нового элемента.
/// @return Возвращает указатель на добавленный элемент
T* addInSort(T* item, const FindResult& fr);
/// @brief Функция добавляет копию элемента в отсортированный список
/// (флаг сортировки не сбрасывается)
T* addCopyInSort(const T& item, const FindResult& fr);
/// @brief Функция назначает список list текущему контейнеру.
///
/// При назначении нового списка - исходный список очищается. Так же пере-
/// назначаются все основные характеристики, такие как capacity, count,
/// compare, container, sortState
void assign(const CustomListType& list);
/// @brief Функция для расширенной сортировки.
///
/// В функции реализован алгоритм быстрой сортировки.
/// Функция сортировки может быть вызвана для пустого списка или для списка
/// с одним элементом, при этом выставляется соответствующий флаг сортировки.
/// Это сделано для того чтобы функция addInSort() работала корректно.
/// @param[in] compare Стратегия сортировки (см. класс CompareItem).
/// Параметр стратегии сортировки специально сделан не константной
/// ссылкой, это позволяет менять состояние элемента compare
/// в процессе сортировки.
/// @param[in] sortMode Определяет направление сортировки - по возрастанию
/// или убыванию.
/// @param[in] extParams Используется для задания расширенных параметров
/// сортировки
template<typename CompareU>
void sort(CompareU& compare, SortMode sortMode = SortMode::Up,
const SortExtParams& extParams = SortExtParams());
/// @brief Функция сортировки (используется стратегия сортировки по умолчанию)
void sort(SortMode sortMode = SortMode::Up,
const SortExtParams& extParams = SortExtParams());
/// @brief Функция для расширенной сортировки.
///
/// К имени функции добавлен индекс "2", это сделано для того чтобы избежать
/// конфликта имен в компиляторе от Borland.
/// Объект стратегии сортировки CompareU создается внутри функции
template<typename CompareU>
void sort2(SortMode sortMode = SortMode::Up,
const SortExtParams& extParams = SortExtParams());
/// @brief Выполняет обмен данных между списками
void swap(SelfListType&);
/*
Функции временно заблокированы, необходимо тестирование
*/
//void shift(ShiftMode shiftMode, int shift = 1);
//void shiftLeft (int shift = 1); // сдвинуть список влево
//void shiftRight(int shift = 1); // сдвинуть список вправо
private:
typedef typename CustomListType::DataType DataType;
DataType* d_func() {return CustomListType::d_func();}
/// Инициализирует основные параметры контейнера, используется в конструкторах
void init(Container container);
template<typename CompareU>
static void qsort(T** sortList, int L, int R, CompareU& compare,
SortMode sortMode);
void grow();
void setCount(int val) {d_func()->count = val;}
void setSortState(SortState val) {d_func()->sortState = val;}
void setAllocator(const Allocator& val) {d_func()->allocator = val;}
void setContainer(Container val) {d_func()->container = val;}
};
//------------------------ Implementation CustomList -------------------------
#define DECL_IMPL_CUSTLIST_CONSTR \
template<typename T, typename Compare, typename Allocator> \
CustomList<T, Compare, Allocator>
#define DECL_IMPL_CUSTLIST(TYPE) \
template<typename T, typename Compare, typename Allocator> \
TYPE CustomList<T, Compare, Allocator>
#define DECL_IMPL_CUSTLIST_INTERN_TYPE(TYPE) \
template<typename T, typename Compare, typename Allocator> \
typename CustomList<T, Compare, Allocator>::TYPE CustomList<T, Compare, Allocator>
#define DECL_IMPL_CUSTLIST_SUBTMPL1(TYPE, SUBT1) \
template<typename T, typename Compare, typename Allocator> \
template<typename SUBT1> \
TYPE CustomList<T, Compare, Allocator>
#define DECL_IMPL_CUSTLIST_SUBTMPL2(TYPE, SUBT1, SUBT2) \
template<typename T, typename Compare, typename Allocator> \
template<typename SUBT1, typename SUBT2> \
TYPE CustomList<T, Compare, Allocator>
DECL_IMPL_CUSTLIST(int)::indexOf(const T* item) const
{
int index;
indexOf2(item, index);
return index;
}
DECL_IMPL_CUSTLIST(bool)::indexOf2(const T* item, int& index) const
{
T** it = listBegin();
T** end = listEnd();
while (it != end)
{
if (*it == item)
{
index = int(it - listBegin());
return true;
}
++it;
}