From ee75ac99a509ff564373175451ff78caae220e37 Mon Sep 17 00:00:00 2001 From: Relintai Date: Sat, 6 Jan 2024 17:45:49 +0100 Subject: [PATCH] Docs pt2. --- tools/doc/index_template.md.html | 292 +++++++++++++++++++++++++++++++ 1 file changed, 292 insertions(+) diff --git a/tools/doc/index_template.md.html b/tools/doc/index_template.md.html index 473481d..f6fe96e 100644 --- a/tools/doc/index_template.md.html +++ b/tools/doc/index_template.md.html @@ -351,14 +351,306 @@ Main Containers ------------------------------------------------------------------ +Helper Structs + + +
Pair + + |||STRUCT_Pair||| + +
+ + +
KeyValue + + |||STRUCT_KeyValue||| + +
+ + +
Comparator + + |||STRUCT_Comparator||| + +
+ +Helper Classes + + +
CowData + + A helper class that implements COW (Copy-on-Write) functionality. + + |||CLASS_CowData||| + +
+ + +
VectorWriteProxy + + |||CLASS_VectorWriteProxy||| + +
+ +Lists + + +
List + + |||CLASS_List||| + +
+ +Vectors + + +
Vector + + Vector with COW support. + + |||CLASS_Vector||| + +
+ + +
PoolVector + + Vector that does not fragment memory. + + |||CLASS_PoolVector||| + +
+ + +
LocalVector + + Simple vector. Uses unsigned ints as indexes. + + Saves on allocation calls by overallocating memory. + + This is the most similar to std::vector. + + |||CLASS_LocalVector||| + +
+ + +
LocalVectori + + Simple vector. Uses signed ints as indexes. + + Saves on allocation calls by overallocating memory. + + |||CLASS_LocalVectori||| + +
+ + +
TightLocalVector + + Simple vector. Uses unsigned ints as indexes. + + Unlike LocalVector it always only allocates the space it needs. + + |||CLASS_TightLocalVector||| + +
+ + +
TightLocalVectori + + Simple vector. Uses signed ints as indexes. + + Unlike LocalVector it always only allocates the space it needs. + + |||CLASS_TightLocalVectori||| + +
+ +Sets + + +
RBSet + + |||CLASS_RBSet||| + +
+ + +
VSet + + |||CLASS_VSet||| + +
+ + +
HashSet + + |||CLASS_HashSet||| + +
+ +Maps + + +
RBMap + + |||CLASS_RBMap||| + +
+ + +
VMap + + |||CLASS_VMap||| + +
+ +HashMaps + + +
OGHashMap + + Simple HashMap implementation. + + |||CLASS_OGHashMap||| + +
+ + +
HashMap + + HashMap implementation that uses open addressing with Robin Hood hashing. + + Use this by default. + + |||CLASS_HashMap||| + +
+ + +
OrderedHashMap + + HashMap implementation that keeps the order of it's elements. + + |||CLASS_OrderedHashMap||| + +
+ +Special + + +
SortArray + + |||CLASS_SortArray||| + +
+ + +
RingBuffer + + |||CLASS_RingBuffer||| + +
+ + + Files ------------------------------------------------------------------ +Time +------------------------------------------------------------------ + + +
STime + + |||CLASS_STime||| + +
+ Threading ------------------------------------------------------------------ +TODO There are multiples of the same classes due to defines. Implement a way to select from them. + +TODO also get Thread. + +Atomics + + +
SafeNumeric + + |||CLASS_SafeNumeric||| + +
+ + +
SafeFlag + + |||CLASS_SafeFlag||| + +
+ + +
SafeRefCount + + |||CLASS_SafeRefCount||| + +
+ +Mutex + + +
Mutex + + Typedefined to Mutex. + + |||CLASS_MutexImpl||| + +
+ + +
MutexLock + + Helper class to lock and automatically release it on leaving scope. + + |||CLASS_MutexLock||| + +
+ +RWLock + + +
RWLock + + |||CLASS_RWLock||| + +
+ + +
RWLockRead + + |||CLASS_RWLockRead||| + +
+ + +
RWLockWrite + + |||CLASS_RWLockWrite||| + +
+ +SpinLock + + +
SpinLock + + |||CLASS_SpinLock||| + +
OBJECT ====================================================================================