mirror of
https://github.com/Relintai/sfw.git
synced 2024-11-08 07:52:09 +01:00
Docs pt2.
This commit is contained in:
parent
06a841b2d0
commit
ee75ac99a5
@ -351,14 +351,306 @@ Main
|
||||
Containers
|
||||
------------------------------------------------------------------
|
||||
|
||||
Helper Structs
|
||||
|
||||
<a name="STRUCT_Pair"></a>
|
||||
<details><summary>Pair</summary>
|
||||
|
||||
|||STRUCT_Pair|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="STRUCT_KeyValue"></a>
|
||||
<details><summary>KeyValue</summary>
|
||||
|
||||
|||STRUCT_KeyValue|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="STRUCT_Comparator"></a>
|
||||
<details><summary>Comparator</summary>
|
||||
|
||||
|||STRUCT_Comparator|||
|
||||
|
||||
</details>
|
||||
|
||||
Helper Classes
|
||||
|
||||
<a name="CLASS_CowData"></a>
|
||||
<details><summary>CowData</summary>
|
||||
|
||||
A helper class that implements COW (Copy-on-Write) functionality.
|
||||
|
||||
|||CLASS_CowData|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_VectorWriteProxy"></a>
|
||||
<details><summary>VectorWriteProxy</summary>
|
||||
|
||||
|||CLASS_VectorWriteProxy|||
|
||||
|
||||
</details>
|
||||
|
||||
Lists
|
||||
|
||||
<a name="CLASS_List"></a>
|
||||
<details><summary>List</summary>
|
||||
|
||||
|||CLASS_List|||
|
||||
|
||||
</details>
|
||||
|
||||
Vectors
|
||||
|
||||
<a name="CLASS_Vector"></a>
|
||||
<details><summary>Vector</summary>
|
||||
|
||||
Vector with COW support.
|
||||
|
||||
|||CLASS_Vector|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_PoolVector"></a>
|
||||
<details><summary>PoolVector</summary>
|
||||
|
||||
Vector that does not fragment memory.
|
||||
|
||||
|||CLASS_PoolVector|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_LocalVector"></a>
|
||||
<details><summary>LocalVector</summary>
|
||||
|
||||
Simple vector. Uses unsigned ints as indexes.
|
||||
|
||||
Saves on allocation calls by overallocating memory.
|
||||
|
||||
This is the most similar to std::vector.
|
||||
|
||||
|||CLASS_LocalVector|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_LocalVectori"></a>
|
||||
<details><summary>LocalVectori</summary>
|
||||
|
||||
Simple vector. Uses signed ints as indexes.
|
||||
|
||||
Saves on allocation calls by overallocating memory.
|
||||
|
||||
|||CLASS_LocalVectori|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_TightLocalVector"></a>
|
||||
<details><summary>TightLocalVector</summary>
|
||||
|
||||
Simple vector. Uses unsigned ints as indexes.
|
||||
|
||||
Unlike LocalVector it always only allocates the space it needs.
|
||||
|
||||
|||CLASS_TightLocalVector|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_TightLocalVectori"></a>
|
||||
<details><summary>TightLocalVectori</summary>
|
||||
|
||||
Simple vector. Uses signed ints as indexes.
|
||||
|
||||
Unlike LocalVector it always only allocates the space it needs.
|
||||
|
||||
|||CLASS_TightLocalVectori|||
|
||||
|
||||
</details>
|
||||
|
||||
Sets
|
||||
|
||||
<a name="CLASS_RBSet"></a>
|
||||
<details><summary>RBSet</summary>
|
||||
|
||||
|||CLASS_RBSet|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_VSet"></a>
|
||||
<details><summary>VSet</summary>
|
||||
|
||||
|||CLASS_VSet|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_HashSet"></a>
|
||||
<details><summary>HashSet</summary>
|
||||
|
||||
|||CLASS_HashSet|||
|
||||
|
||||
</details>
|
||||
|
||||
Maps
|
||||
|
||||
<a name="CLASS_RBMap"></a>
|
||||
<details><summary>RBMap</summary>
|
||||
|
||||
|||CLASS_RBMap|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_VMap"></a>
|
||||
<details><summary>VMap</summary>
|
||||
|
||||
|||CLASS_VMap|||
|
||||
|
||||
</details>
|
||||
|
||||
HashMaps
|
||||
|
||||
<a name="CLASS_OGHashMap"></a>
|
||||
<details><summary>OGHashMap</summary>
|
||||
|
||||
Simple HashMap implementation.
|
||||
|
||||
|||CLASS_OGHashMap|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_HashMap"></a>
|
||||
<details><summary>HashMap</summary>
|
||||
|
||||
HashMap implementation that uses open addressing with Robin Hood hashing.
|
||||
|
||||
Use this by default.
|
||||
|
||||
|||CLASS_HashMap|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_OrderedHashMap"></a>
|
||||
<details><summary>OrderedHashMap</summary>
|
||||
|
||||
HashMap implementation that keeps the order of it's elements.
|
||||
|
||||
|||CLASS_OrderedHashMap|||
|
||||
|
||||
</details>
|
||||
|
||||
Special
|
||||
|
||||
<a name="CLASS_SortArray"></a>
|
||||
<details><summary>SortArray</summary>
|
||||
|
||||
|||CLASS_SortArray|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_RingBuffer"></a>
|
||||
<details><summary>RingBuffer</summary>
|
||||
|
||||
|||CLASS_RingBuffer|||
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
|
||||
Files
|
||||
------------------------------------------------------------------
|
||||
|
||||
|
||||
Time
|
||||
------------------------------------------------------------------
|
||||
|
||||
<a name="CLASS_STime"></a>
|
||||
<details><summary>STime</summary>
|
||||
|
||||
|||CLASS_STime|||
|
||||
|
||||
</details>
|
||||
|
||||
Threading
|
||||
------------------------------------------------------------------
|
||||
|
||||
TODO There are multiples of the same classes due to defines. Implement a way to select from them.
|
||||
|
||||
TODO also get Thread.
|
||||
|
||||
Atomics
|
||||
|
||||
<a name="CLASS_SafeNumeric"></a>
|
||||
<details><summary>SafeNumeric</summary>
|
||||
|
||||
|||CLASS_SafeNumeric|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_SafeFlag"></a>
|
||||
<details><summary>SafeFlag</summary>
|
||||
|
||||
|||CLASS_SafeFlag|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_SafeRefCount"></a>
|
||||
<details><summary>SafeRefCount</summary>
|
||||
|
||||
|||CLASS_SafeRefCount|||
|
||||
|
||||
</details>
|
||||
|
||||
Mutex
|
||||
|
||||
<a name="CLASS_MutexImpl"></a>
|
||||
<details><summary>Mutex</summary>
|
||||
|
||||
Typedefined to Mutex.
|
||||
|
||||
|||CLASS_MutexImpl|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_MutexLock"></a>
|
||||
<details><summary>MutexLock</summary>
|
||||
|
||||
Helper class to lock and automatically release it on leaving scope.
|
||||
|
||||
|||CLASS_MutexLock|||
|
||||
|
||||
</details>
|
||||
|
||||
RWLock
|
||||
|
||||
<a name="CLASS_RWLock"></a>
|
||||
<details><summary>RWLock</summary>
|
||||
|
||||
|||CLASS_RWLock|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_RWLockRead"></a>
|
||||
<details><summary>RWLockRead</summary>
|
||||
|
||||
|||CLASS_RWLockRead|||
|
||||
|
||||
</details>
|
||||
|
||||
<a name="CLASS_RWLockWrite"></a>
|
||||
<details><summary>RWLockWrite</summary>
|
||||
|
||||
|||CLASS_RWLockWrite|||
|
||||
|
||||
</details>
|
||||
|
||||
SpinLock
|
||||
|
||||
<a name="CLASS_SpinLock"></a>
|
||||
<details><summary>SpinLock</summary>
|
||||
|
||||
|||CLASS_SpinLock|||
|
||||
|
||||
</details>
|
||||
|
||||
OBJECT
|
||||
====================================================================================
|
||||
|
Loading…
Reference in New Issue
Block a user