-
Notifications
You must be signed in to change notification settings - Fork 33
/
Copy pathplf_colony.h
5783 lines (4538 loc) · 206 KB
/
plf_colony.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
// Copyright (c) 2024, Matthew Bentley (mattreecebentley@gmail.com) www.plflib.org
// zLib license (https://www.zlib.net/zlib_license.html):
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented; you must not
// claim that you wrote the original software. If you use this software
// in a product, an acknowledgement in the product documentation would be
// appreciated but is not required.
// 2. Altered source versions must be plainly marked as such, and must not be
// misrepresented as being the original software.
// 3. This notice may not be removed or altered from any source distribution.
#ifndef PLF_COLONY_H
#define PLF_COLONY_H
// Compiler-specific defines:
// Define default cases before possibly redefining:
#define PLF_NOEXCEPT throw()
#define PLF_NOEXCEPT_ALLOCATOR
#define PLF_CONSTEXPR
#define PLF_CONSTFUNC
#define PLF_EXCEPTIONS_SUPPORT
#if ((defined(__clang__) || defined(__GNUC__)) && !defined(__EXCEPTIONS)) || (defined(_MSC_VER) && !defined(_CPPUNWIND))
#undef PLF_EXCEPTIONS_SUPPORT
#include <exception> // std::terminate
#endif
#if defined(_MSC_VER) && !defined(__clang__) && !defined(__GNUC__)
// Suppress incorrect (unfixed MSVC bug at warning level 4) warnings re: constant expressions in constexpr-if statements
#pragma warning ( push )
#pragma warning ( disable : 4127 )
#if _MSC_VER >= 1600
#define PLF_MOVE_SEMANTICS_SUPPORT
#endif
#if _MSC_VER >= 1700
#define PLF_TYPE_TRAITS_SUPPORT
#define PLF_ALLOCATOR_TRAITS_SUPPORT
#endif
#if _MSC_VER >= 1800
#define PLF_VARIADICS_SUPPORT // Variadics, in this context, means both variadic templates and variadic macros are supported
#define PLF_DEFAULT_TEMPLATE_ARGUMENT_SUPPORT
#define PLF_INITIALIZER_LIST_SUPPORT
#endif
#if _MSC_VER >= 1900
#define PLF_ALIGNMENT_SUPPORT
#undef PLF_NOEXCEPT
#undef PLF_NOEXCEPT_ALLOCATOR
#define PLF_NOEXCEPT noexcept
#define PLF_NOEXCEPT_ALLOCATOR noexcept(noexcept(allocator_type()))
#define PLF_IS_ALWAYS_EQUAL_SUPPORT
#endif
#if defined(_MSVC_LANG) && (_MSVC_LANG >= 201703L)
#undef PLF_CONSTEXPR
#define PLF_CONSTEXPR constexpr
#endif
#if defined(_MSVC_LANG) && (_MSVC_LANG >= 202002L) && _MSC_VER >= 1929
#define PLF_CPP20_SUPPORT
#undef PLF_CONSTFUNC
#define PLF_CONSTFUNC constexpr
#endif
#elif defined(__cplusplus) && __cplusplus >= 201103L // C++11 support, at least
#if defined(__GNUC__) && defined(__GNUC_MINOR__) && !defined(__clang__) // If compiler is GCC/G++
#if (__GNUC__ == 4 && __GNUC_MINOR__ >= 3) || __GNUC__ > 4
#define PLF_MOVE_SEMANTICS_SUPPORT
#define PLF_VARIADICS_SUPPORT
#endif
#if (__GNUC__ == 4 && __GNUC_MINOR__ >= 4) || __GNUC__ > 4
#define PLF_DEFAULT_TEMPLATE_ARGUMENT_SUPPORT
#define PLF_INITIALIZER_LIST_SUPPORT
#endif
#if (__GNUC__ == 4 && __GNUC_MINOR__ >= 6) || __GNUC__ > 4
#undef PLF_NOEXCEPT
#undef PLF_NOEXCEPT_ALLOCATOR
#define PLF_NOEXCEPT noexcept
#define PLF_NOEXCEPT_ALLOCATOR noexcept(noexcept(allocator_type()))
#endif
#if (__GNUC__ == 4 && __GNUC_MINOR__ >= 7) || __GNUC__ > 4
#define PLF_ALLOCATOR_TRAITS_SUPPORT
#endif
#if (__GNUC__ == 4 && __GNUC_MINOR__ >= 8) || __GNUC__ > 4
#define PLF_ALIGNMENT_SUPPORT
#endif
#if __GNUC__ >= 5 // GCC v4.9 and below do not support std::is_trivially_copyable
#define PLF_TYPE_TRAITS_SUPPORT
#endif
#if __GNUC__ > 6
#define PLF_IS_ALWAYS_EQUAL_SUPPORT
#endif
#elif defined(__clang__) && !defined(__GLIBCXX__) && !defined(_LIBCPP_CXX03_LANG) && __clang_major__ >= 3
#define PLF_DEFAULT_TEMPLATE_ARGUMENT_SUPPORT
#define PLF_ALLOCATOR_TRAITS_SUPPORT
#define PLF_TYPE_TRAITS_SUPPORT
#if __has_feature(cxx_alignas) && __has_feature(cxx_alignof)
#define PLF_ALIGNMENT_SUPPORT
#endif
#if __has_feature(cxx_noexcept)
#undef PLF_NOEXCEPT
#undef PLF_NOEXCEPT_ALLOCATOR
#define PLF_NOEXCEPT noexcept
#define PLF_NOEXCEPT_ALLOCATOR noexcept(noexcept(allocator_type()))
#define PLF_IS_ALWAYS_EQUAL_SUPPORT
#endif
#if __has_feature(cxx_rvalue_references) && !defined(_LIBCPP_HAS_NO_RVALUE_REFERENCES)
#define PLF_MOVE_SEMANTICS_SUPPORT
#endif
#if __has_feature(cxx_variadic_templates) && !defined(_LIBCPP_HAS_NO_VARIADICS)
#define PLF_VARIADICS_SUPPORT
#endif
#if (__clang_major__ == 3 && __clang_minor__ >= 1) || __clang_major__ > 3
#define PLF_INITIALIZER_LIST_SUPPORT
#endif
#elif defined(__GLIBCXX__) // Using another compiler type with libstdc++ - we are assuming full c++11 compliance for compiler - which may not be true
#define PLF_DEFAULT_TEMPLATE_ARGUMENT_SUPPORT
#if __GLIBCXX__ >= 20080606
#define PLF_MOVE_SEMANTICS_SUPPORT
#define PLF_VARIADICS_SUPPORT
#endif
#if __GLIBCXX__ >= 20090421
#define PLF_INITIALIZER_LIST_SUPPORT
#endif
#if __GLIBCXX__ >= 20120322
#define PLF_ALLOCATOR_TRAITS_SUPPORT
#undef PLF_NOEXCEPT
#undef PLF_NOEXCEPT_ALLOCATOR
#define PLF_NOEXCEPT noexcept
#define PLF_NOEXCEPT_ALLOCATOR noexcept(noexcept(allocator_type()))
#endif
#if __GLIBCXX__ >= 20130322
#define PLF_ALIGNMENT_SUPPORT
#endif
#if __GLIBCXX__ >= 20150422 // libstdc++ v4.9 and below do not support std::is_trivially_copyable
#define PLF_TYPE_TRAITS_SUPPORT
#endif
#if __GLIBCXX__ >= 20160111
#define PLF_IS_ALWAYS_EQUAL_SUPPORT
#endif
#elif defined(_LIBCPP_CXX03_LANG) || defined(_LIBCPP_HAS_NO_RVALUE_REFERENCES) // Special case for checking C++11 support with libCPP
#if !defined(_LIBCPP_HAS_NO_VARIADICS)
#define PLF_VARIADICS_SUPPORT
#endif
#else // Assume type traits and initializer support for other compilers and standard library implementations
#define PLF_DEFAULT_TEMPLATE_ARGUMENT_SUPPORT
#define PLF_MOVE_SEMANTICS_SUPPORT
#define PLF_VARIADICS_SUPPORT
#define PLF_TYPE_TRAITS_SUPPORT
#define PLF_ALLOCATOR_TRAITS_SUPPORT
#define PLF_ALIGNMENT_SUPPORT
#define PLF_INITIALIZER_LIST_SUPPORT
#undef PLF_NOEXCEPT
#undef PLF_NOEXCEPT_ALLOCATOR
#define PLF_NOEXCEPT noexcept
#define PLF_NOEXCEPT_ALLOCATOR noexcept(noexcept(allocator_type()))
#define PLF_IS_ALWAYS_EQUAL_SUPPORT
#endif
#if __cplusplus >= 201703L && ((defined(__clang__) && ((__clang_major__ == 3 && __clang_minor__ == 9) || __clang_major__ > 3)) || (defined(__GNUC__) && __GNUC__ >= 7) || (!defined(__clang__) && !defined(__GNUC__))) // assume correct C++17 implementation for non-gcc/clang compilers
#undef PLF_CONSTEXPR
#define PLF_CONSTEXPR constexpr
#endif
#if __cplusplus > 201704L && ((((defined(__clang__) && !defined(__APPLE_CC__) && __clang_major__ >= 14) || (defined(__GNUC__) && (__GNUC__ > 11 || (__GNUC__ == 11 && __GNUC_MINOR__ > 0)))) && ((defined(_LIBCPP_VERSION) && _LIBCPP_VERSION >= 14) || (defined(__GLIBCXX__) && __GLIBCXX__ >= 201806L))) || (!defined(__clang__) && !defined(__GNUC__)))
#define PLF_CPP20_SUPPORT
#undef PLF_CONSTFUNC
#define PLF_CONSTFUNC constexpr
#endif
#endif
#if defined(PLF_IS_ALWAYS_EQUAL_SUPPORT) && defined(PLF_MOVE_SEMANTICS_SUPPORT) && (__cplusplus >= 201703L || (defined(_MSVC_LANG) && (_MSVC_LANG >= 201703L)))
#define PLF_NOEXCEPT_MOVE_ASSIGN(the_allocator) noexcept(std::allocator_traits<the_allocator>::propagate_on_container_move_assignment::value || std::allocator_traits<the_allocator>::is_always_equal::value)
#define PLF_NOEXCEPT_SWAP(the_allocator) noexcept(std::allocator_traits<the_allocator>::propagate_on_container_swap::value || std::allocator_traits<the_allocator>::is_always_equal::value)
#else
#define PLF_NOEXCEPT_MOVE_ASSIGN(the_allocator)
#define PLF_NOEXCEPT_SWAP(the_allocator)
#endif
#ifdef PLF_ALLOCATOR_TRAITS_SUPPORT
#ifdef PLF_VARIADICS_SUPPORT
#define PLF_CONSTRUCT(the_allocator, allocator_instance, location, ...) std::allocator_traits<the_allocator>::construct(allocator_instance, location, __VA_ARGS__)
#else
#define PLF_CONSTRUCT(the_allocator, allocator_instance, location, data) std::allocator_traits<the_allocator>::construct(allocator_instance, location, data)
#endif
#define PLF_DESTROY(the_allocator, allocator_instance, location) std::allocator_traits<the_allocator>::destroy(allocator_instance, location)
#define PLF_ALLOCATE(the_allocator, allocator_instance, size, hint) std::allocator_traits<the_allocator>::allocate(allocator_instance, size, hint)
#define PLF_DEALLOCATE(the_allocator, allocator_instance, location, size) std::allocator_traits<the_allocator>::deallocate(allocator_instance, location, size)
#else
#ifdef PLF_VARIADICS_SUPPORT
#define PLF_CONSTRUCT(the_allocator, allocator_instance, location, ...) (allocator_instance).construct(location, __VA_ARGS__)
#else
#define PLF_CONSTRUCT(the_allocator, allocator_instance, location, data) (allocator_instance).construct(location, data)
#endif
#define PLF_DESTROY(the_allocator, allocator_instance, location) (allocator_instance).destroy(location)
#define PLF_ALLOCATE(the_allocator, allocator_instance, size, hint) (allocator_instance).allocate(size, hint)
#define PLF_DEALLOCATE(the_allocator, allocator_instance, location, size) (allocator_instance).deallocate(location, size)
#endif
#define PLF_CONSTRUCT_ELEMENT(location, element) PLF_CONSTRUCT(allocator_type, *this, pointer_cast<pointer>(location), element)
#ifndef PLF_SORT_FUNCTION
#define PLF_SORT_FUNCTION std::sort
#define PLF_SORT_FUNCTION_DEFINED
#endif
#include <algorithm> // std::fill_n, std::sort, std::swap
#include <cassert> // assert
#include <cstring> // memset, memcpy, size_t
#include <limits> // std::numeric_limits
#include <memory> // std::allocator, std::to_address
#include <iterator> // std::bidirectional_iterator_tag, iterator_traits, std::move_iterator, std::distance for range insert
#include <stdexcept> // std::length_error
#ifdef PLF_TYPE_TRAITS_SUPPORT
#include <cstddef> // offsetof, used in blank()
#include <type_traits> // std::is_trivially_destructible, type_identity_t, etc
#endif
#ifdef PLF_MOVE_SEMANTICS_SUPPORT
#include <utility> // std::move
#endif
#ifdef PLF_INITIALIZER_LIST_SUPPORT
#include <initializer_list>
#endif
#ifdef PLF_CPP20_SUPPORT
#include <concepts>
#include <compare> // std::strong_ordering
#include <ranges>
namespace plf
{
// For getting std:: overload for reverse_iterator to match colony iterators specifically (see bottom of header):
template <class T>
concept colony_iterator_concept = requires { typename T::colony_iterator_tag; };
#ifndef PLF_FROM_RANGE
#define PLF_FROM_RANGE
// Until such point as standard libraries include std::ranges::from_range_t, including this so the rangesv3 constructor overloads will work unambiguously:
namespace ranges
{
struct from_range_t {};
constexpr from_range_t from_range;
}
#endif
}
#endif
namespace plf
{
#ifndef PLF_TOOLS
#define PLF_TOOLS
// std:: tool replacements for C++03/98/11 support:
template <bool condition, class T = void>
struct enable_if
{
typedef T type;
};
template <class T>
struct enable_if<false, T>
{};
template <bool flag, class is_true, class is_false> struct conditional;
template <class is_true, class is_false> struct conditional<true, is_true, is_false>
{
typedef is_true type;
};
template <class is_true, class is_false> struct conditional<false, is_true, is_false>
{
typedef is_false type;
};
template <class element_type>
struct less
{
bool operator() (const element_type &a, const element_type &b) const PLF_NOEXCEPT
{
return a < b;
}
};
template<class element_type>
struct equal_to
{
const element_type &value;
explicit equal_to(const element_type &store_value) PLF_NOEXCEPT:
value(store_value)
{}
bool operator() (const element_type &compare_value) const PLF_NOEXCEPT
{
return value == compare_value;
}
};
// To enable conversion to void * when allocator supplies non-raw pointers:
template <class source_pointer_type>
static PLF_CONSTFUNC void * void_cast(const source_pointer_type source_pointer) PLF_NOEXCEPT
{
#ifdef PLF_CPP20_SUPPORT
return static_cast<void *>(std::to_address(source_pointer));
#else
return static_cast<void *>(&*source_pointer);
#endif
}
#ifdef PLF_MOVE_SEMANTICS_SUPPORT
template <class iterator_type>
static PLF_CONSTFUNC std::move_iterator<iterator_type> make_move_iterator(iterator_type it)
{
return std::move_iterator<iterator_type>(std::move(it));
}
#endif
enum priority { performance = 1, memory_use = 4};
#endif
struct limits
{
size_t min, max;
PLF_CONSTFUNC limits(const size_t minimum, const size_t maximum) PLF_NOEXCEPT : min(minimum), max(maximum) {}
};
template <class element_type, class allocator_type = std::allocator<element_type>, plf::priority priority = performance>
class colony : private allocator_type // Empty base class optimisation - inheriting allocator functions
{
#ifdef PLF_ALIGNMENT_SUPPORT
typedef typename plf::conditional<(priority == performance && (sizeof(element_type) > 10 || alignof(element_type) > 10)), unsigned short, unsigned char>::type skipfield_type; // Note: unsigned short is equivalent to uint_least16_t ie. Using 16-bit unsigned integer in best-case scenario, greater-than-16-bit unsigned integer where platform doesn't support 16-bit types. unsigned char is always == 1 byte, as opposed to uint_8, which may not be.
#else
typedef typename plf::conditional<(priority == performance && sizeof(element_type) > 10), unsigned short, unsigned char>::type skipfield_type;
#endif
public:
// Standard container typedefs:
#ifdef PLF_ALLOCATOR_TRAITS_SUPPORT
typedef typename std::allocator_traits<allocator_type>::size_type size_type;
typedef typename std::allocator_traits<allocator_type>::difference_type difference_type;
typedef typename std::allocator_traits<allocator_type>::pointer pointer;
typedef typename std::allocator_traits<allocator_type>::const_pointer const_pointer;
#else
typedef typename allocator_type::size_type size_type;
typedef typename allocator_type::difference_type difference_type;
typedef typename allocator_type::pointer pointer;
typedef typename allocator_type::const_pointer const_pointer;
#endif
typedef element_type value_type;
typedef element_type & reference;
typedef const element_type & const_reference;
// Iterator forward declarations:
template <bool is_const> class colony_iterator;
typedef colony_iterator<false> iterator;
typedef colony_iterator<true> const_iterator;
friend class colony_iterator<false>;
friend class colony_iterator<true>;
template <bool is_const_r> class colony_reverse_iterator;
typedef colony_reverse_iterator<false> reverse_iterator;
typedef colony_reverse_iterator<true> const_reverse_iterator;
friend class colony_reverse_iterator<false>;
friend class colony_reverse_iterator<true>;
#ifdef PLF_ALIGNMENT_SUPPORT
// The element as allocated in memory needs to be at-least 2*skipfield_type width in order to support free list indexes in erased element memory space, so:
// make the size of this struct the larger of alignof(T), sizeof(T) or 2*skipfield_type (the latter is only relevant for type char/uchar), and
// make the alignment alignof(T).
// This type is used mainly for correct pointer arithmetic while iterating over elements in memory.
struct alignas(alignof(element_type)) aligned_element_struct
{
// Using char as sizeof is always guaranteed to be 1 byte regardless of the number of bits in a byte on given computer, whereas for example, uint8_t would fail on machines where there are more than 8 bits in a byte eg. Texas Instruments C54x DSPs.
char data[
(sizeof(element_type) < (sizeof(skipfield_type) * 2)) ?
((sizeof(skipfield_type) * 2) < alignof(element_type) ? alignof(element_type) : (sizeof(skipfield_type) * 2)) :
((sizeof(element_type) < alignof(element_type)) ? alignof(element_type) : sizeof(element_type))
];
};
// We combine the allocation of elements and skipfield into one allocation to save performance. This memory must be allocated as an aligned type with the same alignment as T in order for the elements to align with memory boundaries correctly (which won't happen if we allocate as char or uint_8). But the larger the sizeof in the type we use for allocation, the greater the chance of creating a lot of unused memory in the skipfield portion of the allocated block. So we create a type that is sizeof(alignof(T)), as in most cases alignof(T) < sizeof(T). If alignof(t) >= sizeof(t) this makes no difference.
struct alignas(alignof(element_type)) aligned_allocation_struct
{
char data[alignof(element_type)];
};
#else
struct aligned_element_struct
{
char data[(sizeof(element_type) < (sizeof(skipfield_type) * 2)) ? (sizeof(skipfield_type) * 2) : sizeof(element_type)];
};
struct aligned_allocation_struct
{
char data[sizeof(skipfield_type)];
};
#endif
private:
// Calculate the capacity of a group's elements+skipfield memory block when expressed in multiples of the value_type's alignment (rounding up).
static size_type get_aligned_block_capacity(const skipfield_type elements_per_group)
{
return ((elements_per_group * (sizeof(aligned_element_struct) + sizeof(skipfield_type))) + sizeof(skipfield_type) + sizeof(aligned_allocation_struct) - 1) / sizeof(aligned_allocation_struct);
}
// To enable conversion when allocator supplies non-raw pointers:
template <class destination_pointer_type, class source_pointer_type>
static PLF_CONSTFUNC destination_pointer_type pointer_cast(const source_pointer_type source_pointer) PLF_NOEXCEPT
{
#if defined(PLF_TYPE_TRAITS_SUPPORT) && defined(PLF_CPP20_SUPPORT) // constexpr necessary to avoid a branch for every call
if constexpr (std::is_trivial<destination_pointer_type>::value)
{
return reinterpret_cast<destination_pointer_type>(std::to_address(source_pointer));
}
else
{
return destination_pointer_type(std::to_address(source_pointer));
}
#else
return destination_pointer_type(&*source_pointer);
#endif
}
// forward declarations for typedefs below
struct group;
struct item_index_tuple; // for use in sort()
#ifdef PLF_ALLOCATOR_TRAITS_SUPPORT
typedef typename std::allocator_traits<allocator_type>::template rebind_alloc<aligned_element_struct> aligned_allocator_type;
typedef typename std::allocator_traits<allocator_type>::template rebind_alloc<group> group_allocator_type;
typedef typename std::allocator_traits<allocator_type>::template rebind_alloc<skipfield_type> skipfield_allocator_type;
typedef typename std::allocator_traits<allocator_type>::template rebind_alloc<aligned_allocation_struct> aligned_struct_allocator_type;
typedef typename std::allocator_traits<allocator_type>::template rebind_alloc<item_index_tuple> tuple_allocator_type;
typedef typename std::allocator_traits<allocator_type>::template rebind_alloc<unsigned char> uchar_allocator_type;
typedef typename std::allocator_traits<aligned_allocator_type>::pointer aligned_pointer_type; // pointer to the (potentially overaligned) element type, not the original element type
typedef typename std::allocator_traits<group_allocator_type>::pointer group_pointer_type;
typedef typename std::allocator_traits<skipfield_allocator_type>::pointer skipfield_pointer_type;
typedef typename std::allocator_traits<aligned_struct_allocator_type>::pointer aligned_struct_pointer_type;
typedef typename std::allocator_traits<tuple_allocator_type>::pointer tuple_pointer_type;
#else
typedef typename allocator_type::template rebind<aligned_element_struct>::other aligned_allocator_type; // In case compiler supports alignment but not allocator_traits
typedef typename allocator_type::template rebind<group>::other group_allocator_type;
typedef typename allocator_type::template rebind<skipfield_type>::other skipfield_allocator_type;
typedef typename allocator_type::template rebind<aligned_allocation_struct>::other aligned_struct_allocator_type;
typedef typename allocator_type::template rebind<item_index_tuple>::other tuple_allocator_type;
typedef typename allocator_type::template rebind<unsigned char>::other uchar_allocator_type;
typedef typename aligned_allocator_type::pointer aligned_pointer_type;
typedef typename group_allocator_type::pointer group_pointer_type;
typedef typename skipfield_allocator_type::pointer skipfield_pointer_type;
typedef typename aligned_struct_allocator_type::pointer aligned_struct_pointer_type;
typedef typename tuple_allocator_type::pointer tuple_pointer_type;
#endif
// group == element memory block + skipfield + block metadata
struct group
{
skipfield_pointer_type skipfield; // Skipfield storage. The element and skipfield arrays are allocated contiguously, in a single allocation, in this implementation, hence the skipfield pointer also functions as a 'one-past-end' pointer for the elements array. There will always be one additional skipfield node allocated compared to the number of elements. This is to ensure a faster ++ iterator operation (fewer checks are required when this is present). The extra node is unused and always zero, but checked, and not having it will result in out-of-bounds memory errors. This is present before elements in the group struct as it is referenced constantly by the ++ operator, hence having it first results in a minor performance increase.
group_pointer_type next_group; // Next group in the linked list of all groups. NULL if no following group. 2nd in struct because it is so frequently used during iteration.
const aligned_pointer_type elements; // Element storage.
group_pointer_type previous_group; // Previous group in the linked list of all groups. NULL if no preceding group.
skipfield_type free_list_head; // The index of the last erased element in the group. The last erased element will, in turn, contain the number of the index of the next erased element, and so on. If this is == maximum skipfield_type value then free_list is empty ie. no erasures have occurred in the group (or if they have, the erased locations have subsequently been reused via insert/emplace/assign).
const skipfield_type capacity; // The element capacity of this particular group - can also be calculated from reinterpret_cast<aligned_pointer_type>(group->skipfield) - group->elements, however this space is effectively free due to struct padding and the sizeof(skipfield_type), and calculating it once is faster in benchmarking.
skipfield_type size; // The total number of active elements in group - changes with insert and erase commands - used to check for empty group in erase function, as an indication to remove the group. Also used in combination with capacity to check if group is full, which is used in the next/previous/advance/distance overloads, and range-erase.
group_pointer_type erasures_list_next_group, erasures_list_previous_group; // The next and previous groups in the list of groups with erasures ie. with active erased-element free lists. NULL if no next or previous group.
size_type group_number; // Used for comparison (> < >= <= <=>) iterator operators (used by distance function and user).
#ifdef PLF_VARIADICS_SUPPORT
group(aligned_struct_allocator_type &aligned_struct_allocator, const skipfield_type elements_per_group, const group_pointer_type previous):
next_group(NULL),
elements(pointer_cast<aligned_pointer_type>(PLF_ALLOCATE(aligned_struct_allocator_type, aligned_struct_allocator, get_aligned_block_capacity(elements_per_group), (previous == NULL) ? NULL : previous->elements))),
previous_group(previous),
free_list_head(std::numeric_limits<skipfield_type>::max()),
capacity(elements_per_group),
size(1),
erasures_list_next_group(NULL),
erasures_list_previous_group(NULL),
group_number((previous == NULL) ? 0 : previous->group_number + 1u)
{
skipfield = pointer_cast<skipfield_pointer_type>(elements + elements_per_group);
std::memset(plf::void_cast(skipfield), 0, sizeof(skipfield_type) * (static_cast<size_type>(elements_per_group) + 1u));
}
#else
// This is a hack around the fact that allocator_type::construct only supports copy construction in C++03 and copy elision does not occur on the vast majority of compilers in this circumstance. So to avoid running out of memory (and losing performance) from allocating the same block twice, we 'move' in the 'copy' constructor.
group(aligned_struct_allocator_type &aligned_struct_allocator, const skipfield_type elements_per_group, const group_pointer_type previous) PLF_NOEXCEPT:
elements(pointer_cast<aligned_pointer_type>(PLF_ALLOCATE(aligned_struct_allocator_type, aligned_struct_allocator, get_aligned_block_capacity(elements_per_group), (previous == NULL) ? 0 : previous->elements))),
previous_group(previous),
capacity(elements_per_group)
{}
// Not a real copy constructor ie. actually a move constructor. Only used for allocator.construct in C++03 for reasons stated above:
group(const group &source):
skipfield(pointer_cast<skipfield_pointer_type>(source.elements + source.capacity)),
next_group(NULL),
elements(source.elements),
previous_group(source.previous_group),
free_list_head(std::numeric_limits<skipfield_type>::max()),
capacity(source.capacity),
size(1),
erasures_list_next_group(NULL),
erasures_list_previous_group(NULL),
group_number((source.previous_group == NULL) ? 0 : source.previous_group->group_number + 1u)
{
std::memset(plf::void_cast(skipfield), 0, sizeof(skipfield_type) * (static_cast<size_type>(capacity) + 1u));
}
#endif
void reset(const skipfield_type increment, const group_pointer_type next, const group_pointer_type previous, const size_type group_num) PLF_NOEXCEPT
{
next_group = next;
free_list_head = std::numeric_limits<skipfield_type>::max();
previous_group = previous;
size = increment;
erasures_list_next_group = NULL;
erasures_list_previous_group = NULL;
group_number = group_num;
std::memset(plf::void_cast(skipfield), 0, sizeof(skipfield_type) * static_cast<size_type>(capacity)); // capacity + 1 is not necessary here as the final skipfield node is never written to after initialization
}
};
// colony member variables:
iterator end_iterator, begin_iterator;
group_pointer_type erasure_groups_head, // Head of doubly-linked list of groups which have erased-element memory locations available for re-use
unused_groups_head; // Head of singly-linked list of reserved groups retained by erase()/clear() or created by reserve()
size_type total_size, total_capacity;
skipfield_type min_block_capacity, max_block_capacity;
group_allocator_type group_allocator;
aligned_struct_allocator_type aligned_struct_allocator;
skipfield_allocator_type skipfield_allocator;
tuple_allocator_type tuple_allocator;
void check_capacities_conformance(const plf::limits capacities) const
{
PLF_CONSTFUNC plf::limits hard_capacities = block_capacity_hard_limits();
if (capacities.min < hard_capacities.min || capacities.min > capacities.max || capacities.max > hard_capacities.max)
{
#ifdef PLF_EXCEPTIONS_SUPPORT
throw std::length_error("Supplied memory block capacity limits are either invalid or outside of block_capacity_hard_limits()");
#else
std::terminate();
#endif
}
}
void blank() PLF_NOEXCEPT
{
#ifdef PLF_IS_ALWAYS_EQUAL_SUPPORT // allocator_traits always available when is_always_equal is available
if PLF_CONSTEXPR (std::is_standard_layout<colony>::value && std::allocator_traits<allocator_type>::is_always_equal::value && std::is_trivial<group_pointer_type>::value && std::is_trivial<aligned_pointer_type>::value && std::is_trivial<skipfield_pointer_type>::value)
{ // If all pointer types are trivial, we can just nuke the member variables from orbit with memset (NULL is always 0):
std::memset(static_cast<void *>(this), 0, offsetof(colony, min_block_capacity));
}
else
#endif
{
end_iterator.group_pointer = NULL;
end_iterator.element_pointer = NULL;
end_iterator.skipfield_pointer = NULL;
begin_iterator.group_pointer = NULL;
begin_iterator.element_pointer = NULL;
begin_iterator.skipfield_pointer = NULL;
erasure_groups_head = NULL;
unused_groups_head = NULL;
total_size = 0;
total_capacity = 0;
}
}
static PLF_CONSTFUNC size_t max_size_static() PLF_NOEXCEPT
{
#ifdef PLF_ALLOCATOR_TRAITS_SUPPORT
return static_cast<size_t>(std::allocator_traits<allocator_type>::max_size(allocator_type()));
#else
return static_cast<size_t>(allocator_type::max_size());
#endif
}
public:
// Adaptive minimum based around aligned size, sizeof(group) and sizeof(colony):
static PLF_CONSTFUNC skipfield_type block_capacity_default_min() PLF_NOEXCEPT
{
PLF_CONSTFUNC const skipfield_type adaptive_size = static_cast<skipfield_type>(((sizeof(colony) + sizeof(group)) * 2) / sizeof(aligned_element_struct));
PLF_CONSTFUNC const skipfield_type max_block_capacity = block_capacity_default_max(); // Necessary to check against in situations with > 64bit pointer sizes and small sizeof(T)
return std::max(static_cast<skipfield_type>(8), std::min(adaptive_size, max_block_capacity));
}
// Adaptive maximum based on numeric_limits and best outcome from multiple benchmark's (on balance) in terms of memory usage and performance:
static PLF_CONSTFUNC skipfield_type block_capacity_default_max() PLF_NOEXCEPT
{
return static_cast<skipfield_type>(std::min(std::min(static_cast<size_t>(std::numeric_limits<skipfield_type>::max()), static_cast<size_t>(8192u)), max_size_static()));
}
static PLF_CONSTFUNC plf::limits block_capacity_default_limits() PLF_NOEXCEPT
{
return plf::limits(static_cast<size_t>(block_capacity_default_min()), static_cast<size_t>(block_capacity_default_max()));
}
// Default constructors:
PLF_CONSTFUNC explicit colony(const allocator_type &alloc) PLF_NOEXCEPT:
allocator_type(alloc),
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(block_capacity_default_min()),
max_block_capacity(block_capacity_default_max()),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{}
PLF_CONSTFUNC colony() PLF_NOEXCEPT_ALLOCATOR:
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(block_capacity_default_min()),
max_block_capacity(block_capacity_default_max()),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{}
PLF_CONSTFUNC colony(const plf::limits block_limits, const allocator_type &alloc) PLF_NOEXCEPT:
allocator_type(alloc),
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(static_cast<skipfield_type>(block_limits.min)),
max_block_capacity(static_cast<skipfield_type>(block_limits.max)),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{
check_capacities_conformance(block_limits);
}
PLF_CONSTFUNC explicit colony(const plf::limits block_limits):
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(static_cast<skipfield_type>(block_limits.min)),
max_block_capacity(static_cast<skipfield_type>(block_limits.max)),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{
check_capacities_conformance(block_limits);
}
// Copy constructors:
#ifdef PLF_CPP20_SUPPORT
colony(const colony &source, const std::type_identity_t<allocator_type> &alloc):
#else
colony(const colony &source, const allocator_type &alloc):
#endif
allocator_type(alloc),
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(std::max(source.min_block_capacity, static_cast<skipfield_type>(std::min(source.total_size, static_cast<size_type>(source.max_block_capacity))))), // min group size is set to value closest to total number of elements in source colony, in order to not create unnecessary small groups in the range-insert below, then reverts to the original min group size afterwards. This effectively saves a call to reserve.
max_block_capacity(source.max_block_capacity),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{ // can skip checking for skipfield conformance here as source will have already checked theirs. Same applies for other copy and move constructors below
range_assign(source.begin_iterator, source.total_size);
min_block_capacity = source.min_block_capacity; // reset to correct value for future operations
}
colony(const colony &source):
#if defined(__cplusplus) && __cplusplus >= 201103L
allocator_type(std::allocator_traits<allocator_type>::select_on_container_copy_construction(source)),
#else
allocator_type(source),
#endif
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(std::max(source.min_block_capacity, static_cast<skipfield_type>(std::min(source.total_size, static_cast<size_type>(source.max_block_capacity))))),
max_block_capacity(source.max_block_capacity),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{
range_assign(source.begin_iterator, source.total_size);
min_block_capacity = source.min_block_capacity; // reset to correct value for future operations
}
#ifdef PLF_MOVE_SEMANTICS_SUPPORT
// Move constructors:
#ifdef PLF_CPP20_SUPPORT
colony(colony &&source, const std::type_identity_t<allocator_type> &alloc):
#else
colony(colony &&source, const allocator_type &alloc):
#endif
allocator_type(alloc),
end_iterator(source.end_iterator),
begin_iterator(source.begin_iterator),
erasure_groups_head(source.erasure_groups_head),
unused_groups_head(source.unused_groups_head),
total_size(source.total_size),
total_capacity(source.total_capacity),
min_block_capacity(source.min_block_capacity),
max_block_capacity(source.max_block_capacity),
group_allocator(alloc),
aligned_struct_allocator(alloc),
skipfield_allocator(alloc),
tuple_allocator(alloc)
{
assert(&source != this);
#ifdef PLF_IS_ALWAYS_EQUAL_SUPPORT
if PLF_CONSTEXPR (!std::allocator_traits<allocator_type>::is_always_equal::value)
#endif
{
if (alloc != static_cast<allocator_type &>(source))
{
blank();
range_assign(std::make_move_iterator(source.begin_iterator), source.total_size);
source.destroy_all_data();
}
}
source.blank();
}
colony(colony &&source) PLF_NOEXCEPT:
allocator_type(std::move(static_cast<allocator_type &>(source))),
end_iterator(std::move(source.end_iterator)),
begin_iterator(std::move(source.begin_iterator)),
erasure_groups_head(std::move(source.erasure_groups_head)),
unused_groups_head(std::move(source.unused_groups_head)),
total_size(source.total_size),
total_capacity(source.total_capacity),
min_block_capacity(source.min_block_capacity),
max_block_capacity(source.max_block_capacity),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{
assert(&source != this);
source.blank();
}
#endif
// Fill constructors:
colony(const size_type fill_number, const element_type &element, const plf::limits block_limits, const allocator_type &alloc = allocator_type()):
allocator_type(alloc),
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(static_cast<skipfield_type>(block_limits.min)),
max_block_capacity(static_cast<skipfield_type>(block_limits.max)),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{
check_capacities_conformance(block_limits);
assign(fill_number, element);
}
colony(const size_type fill_number, const element_type &element, const allocator_type &alloc = allocator_type()) :
allocator_type(alloc),
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(block_capacity_default_min()),
max_block_capacity(block_capacity_default_max()),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{
assign(fill_number, element);
}
// Default-value fill constructors:
colony(const size_type fill_number, const plf::limits block_limits, const allocator_type &alloc = allocator_type()):
allocator_type(alloc),
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(static_cast<skipfield_type>(block_limits.min)),
max_block_capacity(static_cast<skipfield_type>(block_limits.max)),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{
check_capacities_conformance(block_limits);
assign(fill_number, element_type());
}
colony(const size_type fill_number, const allocator_type &alloc = allocator_type()):
allocator_type(alloc),
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(block_capacity_default_min()),
max_block_capacity(block_capacity_default_max()),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{
assign(fill_number, element_type());
}
// Range constructors:
template<typename iterator_type>
colony(const typename plf::enable_if<!std::numeric_limits<iterator_type>::is_integer, iterator_type>::type &first, const iterator_type &last, const plf::limits block_limits, const allocator_type &alloc = allocator_type()):
allocator_type(alloc),
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(static_cast<skipfield_type>(block_limits.min)),
max_block_capacity(static_cast<skipfield_type>(block_limits.max)),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{
check_capacities_conformance(block_limits);
assign<iterator_type>(first, last);
}
template<typename iterator_type>
colony(const typename plf::enable_if<!std::numeric_limits<iterator_type>::is_integer, iterator_type>::type &first, const iterator_type &last, const allocator_type &alloc = allocator_type()):
allocator_type(alloc),
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(block_capacity_default_min()),
max_block_capacity(block_capacity_default_max()),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{
assign<iterator_type>(first, last);
}
#ifdef PLF_INITIALIZER_LIST_SUPPORT
// Initializer-list constructors:
colony(const std::initializer_list<element_type> &element_list, const plf::limits block_limits, const allocator_type &alloc = allocator_type()):
allocator_type(alloc),
erasure_groups_head(NULL),
unused_groups_head(NULL),
total_size(0),
total_capacity(0),
min_block_capacity(static_cast<skipfield_type>(block_limits.min)),
max_block_capacity(static_cast<skipfield_type>(block_limits.max)),
group_allocator(*this),
aligned_struct_allocator(*this),
skipfield_allocator(*this),
tuple_allocator(*this)
{
check_capacities_conformance(block_limits);
range_assign(element_list.begin(), static_cast<size_type>(element_list.size()));
}