Skip to content

Commit 4ae886b

Browse files
authored
Update README.md
1 parent c5fa5d9 commit 4ae886b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Rea
22
Rea is a lightweight library of data structures implemented in C++11, designed for constant time insertion, erasure, lookup, and fastest possible iteration. Great for using in games or any other software which needs to manage thousands upon thousands of objects.
33

4-
There are 6 data structures included in this library : `slot_list`, `controlled_slot_list`, `versioned_slot_list`, `regulated_slot_list`, `slot_map` and `versioned_slot_map`. The two key data structures are `slot_list` and `slot_map`: the other four are only simple variations of those 2.
4+
There are 6 data structures included in this library : `slot_list`, `controlled_slot_list`, `versioned_slot_list`, `regulated_slot_list`, `slot_map` and `versioned_slot_map`. The two key data structures are `slot_list` and `slot_map`: the other four are only simple variations of those two.
55

66
# SlotList
77
Use SlotList when you have to insert, erase, or look up data in constant time, without the need for constantly repeated iteration. If you require all of those things plus fast iteration, use SlotMap.
@@ -14,7 +14,7 @@ Whenever you insert a value into the SlotList you get its id, which you can late
1414
While you can use the ids to iterate over all stored objects, it's not advisable to do it repeatedly: you might be jumping all over memory and hence destroying cache locality. As stated above, for iteration use SlotMap.
1515

1616
## Usage
17-
All SlotLists have the same first, and the last 2 template arguments.
17+
All SlotLists have the same first, and the last two template arguments.
1818
```cpp
1919
some_slot_list<T, // value_type
2020
.
@@ -203,7 +203,7 @@ As stated earlier the main difference between the SlotList and the SlotMap is in
203203
204204
Considering all of the users objects are kept in a contiguous array, and all erased objects are destructed, there is no need for controlled or regulated version of SlotMap.
205205
206-
All SlotMaps, just like all SlotLists, have the same first, and the last 2 template arguments.
206+
All SlotMaps, just like all SlotLists, have the same first, and the last two template arguments.
207207
```cpp
208208
some_slot_map<T, // value_type
209209
.

0 commit comments

Comments
 (0)