feat: add README

* rename classes * add doc
abeimler · May 25, 2022 · 9b2701c · 9b2701c
1 parent f72c2cf
commit 9b2701c
Show file tree

Hide file tree

Showing 79 changed files with 661 additions and 343 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,126 @@
+# Entity-Component-Systems Benchmark
+
+Simple Benchmark of common Entity-Component-Systems:
+
+* [EntityX](https://github.com/alecthomas/entityx)
+* [EnTT](https://github.com/skypjack/entt)
+* [Ginseng](https://github.com/apples/ginseng)
+* [mustache](https://github.com/kirillochnev/mustache)
+* [OpenEcs](https://github.com/Gronis/OpenEcs)
+
+## TL;DR Results
+
+![Summary SystemsUpdate Plot](img/SystemsUpdate.png)
+_(lower is better)_
+
+|                                     | EntityX   | EnTT    | Ginseng   | mustache   | OOP     |
+|:------------------------------------|:----------|:--------|:----------|:-----------|:--------|
+| Update  10k entities with 2 Systems | 0.0008s   | 0.0002s | 0.0002s   | 0.0007s    | 0.0005s |
+| Update 100k entities with 2 Systems | 0.0092s   | 0.0023s | 0.0026s   | 0.0070s    | 0.0057s |
+| Update 500k entities with 2 Systems | 0.0401s   | 0.0127s | 0.0140s   | 0.0334s    | 0.0198s |
+| Update   1M entities with 2 Systems | 0.0796s   | 0.0240s | 0.0243s   | 0.0631s    | 0.0557s |
+
+### Environment
+
+* **OS:** Linux
+* **CPU:** 3.10GHz @ 4Cores
+* **RAM:** 8 GB
+
+## Details
+
+All benchmarks are located in [`benchmark/benchmarks/`](benchmark/benchmarks/) and are written with [google/benchmark](https://github.com/google/benchmark).
+Each benchmark must implement the template [ECSBenchmark.h](benchmark/benchmarks/ECSBenchmark.h).
+
+Each framework has a sub-project in [`src/`](src) and must implement certain features (see [`src/base`](src/base)).
+
+### Components
+
+1. PositionComponent with `x` and `y` Coord.
+2. DirectionComponent with `x` and `y` for movement
+3. DataComponent with some non-sense data.
+
+### Systems
+
+1. MovementSystem: updates PositionComponent
+2. DataSystem: updates DataComponent
+3. MoreComplexSystem: updates Components with random data and stuff
+
+
+## More Benchmarks
+
+### Create Entities
+
+![CreateEntities Plot](img/CreateEntities.png)
+_(lower is better)_
+
+|                                          | EntityX   | EnTT    | Ginseng   | mustache   | OOP     |
+|:-----------------------------------------|:----------|:--------|:----------|:-----------|:--------|
+| Create  10k entities with two Components | 0.0007s   | 0.0002s | 0.0008s   | 0.0004s    | 0.0000s |
+| Create 100k entities with two Components | 0.0064s   | 0.0021s | 0.0084s   | 0.0034s    | 0.0004s |
+| Create 500k entities with two Components | 0.0369s   | 0.0106s | 0.0438s   | 0.0169s    | 0.0013s |
+| Create   1M entities with two Components | 0.0763s   | 0.0213s | 0.0944s   | 0.0380s    | 0.0026s |
+
+### Destroy Entities
+
+![DestroyEntities Plot](img/DestroyEntities.png)
+_(lower is better)_
+
+|                                           | EntityX   | EnTT    | Ginseng   | mustache   | OOP       |
+|:------------------------------------------|:----------|:--------|:----------|:-----------|:----------|
+| Destroy  10k entities with two Components | 0.0003s   | 0.0003s | 0.0012s   | 0.0002s    | 0.2422s   |
+| Destroy 100k entities with two Components | 0.0034s   | 0.0033s | 0.0119s   | 0.0018s    | 15.5223s  |
+| Destroy 500k entities with two Components | 0.0166s   | 0.0172s | 0.0633s   | 0.0091s    | 719.3013s |
+
+### Get one component from Entity
+
+![UnpackOneComponent Plot](img/UnpackOneComponent.png)
+_(lower is better)_
+
+|                                       | EntityX   | EnTT    | Ginseng   | mustache   | OOP     |
+|:--------------------------------------|:----------|:--------|:----------|:-----------|:--------|
+| Unpack one Component in  10k entities | 0.0000s   | 0.0001s | 0.0001s   | 0.0002s    | 0.0000s |
+| Unpack one Component in 100k entities | 0.0005s   | 0.0009s | 0.0006s   | 0.0020s    | 0.0006s |
+| Unpack one Component in 500k entities | 0.0027s   | 0.0057s | 0.0040s   | 0.0104s    | 0.0051s |
+| Unpack one Component in   1M entities | 0.0053s   | 0.0109s | 0.0073s   | 0.0215s    | 0.0074s |
+
+### Get two components from Entity
+
+![UnpackTwoComponents Plot](img/UnpackTwoComponents.png)
+_(lower is better)_
+
+|                                        | EntityX   | EnTT    | Ginseng   | mustache   | OOP     |
+|:---------------------------------------|:----------|:--------|:----------|:-----------|:--------|
+| Unpack two Components in  10k entities | 0.0001s   | 0.0002s | 0.0001s   | 0.0004s    | 0.0000s |
+| Unpack two Components in 100k entities | 0.0012s   | 0.0020s | 0.0012s   | 0.0037s    | 0.0003s |
+| Unpack two Components in 500k entities | 0.0061s   | 0.0091s | 0.0062s   | 0.0190s    | 0.0040s |
+| Unpack two Components in   1M entities | 0.0119s   | 0.0209s | 0.0140s   | 0.0382s    | 0.0078s |
+
+### Get three components from Entity
+
+![UnpackThreeComponentsFromMixedEntities Plot](img/UnpackThreeComponentsFromMixedEntities.png)
+_(lower is better)_
+
+|                                          | EntityX   | EnTT    | Ginseng   | mustache   | OOP     |
+|:-----------------------------------------|:----------|:--------|:----------|:-----------|:--------|
+| Unpack three Components in  10k entities | 0.0002s   | 0.0002s | 0.0002s   | 0.0005s    | 0.0000s |
+| Unpack three Components in 100k entities | 0.0019s   | 0.0028s | 0.0019s   | 0.0061s    | 0.0003s |
+| Unpack three Components in 500k entities | 0.0083s   | 0.0155s | 0.0096s   | 0.0291s    | 0.0046s |
+| Unpack three Components in   1M entities | 0.0180s   | 0.0270s | 0.0191s   | 0.0603s    | 0.0107s |
+
+### System Updates (for-each entities)
+
+![SystemsUpdate Plot](img/SystemsUpdate.png)
+_(lower is better)_
+
+|                                     | EntityX   | EnTT    | Ginseng   | mustache   | OOP     |
+|:------------------------------------|:----------|:--------|:----------|:-----------|:--------|
+| Update  10k entities with 2 Systems | 0.0008s   | 0.0002s | 0.0002s   | 0.0007s    | 0.0005s |
+| Update 100k entities with 2 Systems | 0.0092s   | 0.0023s | 0.0026s   | 0.0070s    | 0.0057s |
+| Update 500k entities with 2 Systems | 0.0401s   | 0.0127s | 0.0140s   | 0.0334s    | 0.0198s |
+| Update   1M entities with 2 Systems | 0.0796s   | 0.0240s | 0.0243s   | 0.0631s    | 0.0557s |
+
+## More Details
+
+ * [Dependency Setup](doc/README_dependencies.md)
+ * [Building Details](doc/README_building.md)
+ * Project Template, mix of: [starter_template](https://github.com/cpp-best-practices/gui_starter_template) and [ModernCppStarter](https://github.com/TheLartians/ModernCppStarter)
diff --git a/benchmark/benchmarks/entityx-more/EntityXBenchmark.h b/benchmark/benchmarks/entityx-more/EntityXBenchmark.h
@@ -3,7 +3,7 @@
 
 #include "ECSBenchmark.h"
 
-#include "entityx/systems/ComflabSystem.h"
+#include "entityx/systems/DataSystem.h"
 #include "entityx/systems/MoreComplexSystem.h"
 #include "entityx/systems/MovementSystem.h"
 #include "entityx/entities/EntityFactory.h"

diff --git a/benchmark/benchmarks/entityx/EntityXBenchmark.h b/benchmark/benchmarks/entityx/EntityXBenchmark.h
@@ -3,7 +3,7 @@
 
 #include "ECSBenchmark.h"
 
-#include "entityx/systems/ComflabSystem.h"
+#include "entityx/systems/DataSystem.h"
 #include "entityx/systems/MoreComplexSystem.h"
 #include "entityx/systems/MovementSystem.h"
 #include "entityx/entities/EntityFactory.h"

diff --git a/benchmark/benchmarks/entt-more/EnttBenchmark.h b/benchmark/benchmarks/entt-more/EnttBenchmark.h
@@ -3,7 +3,7 @@
 
 #include "ECSBenchmark.h"
 
-#include "entt/systems/ComflabSystem.h"
+#include "entt/systems/DataSystem.h"
 #include "entt/systems/MoreComplexSystem.h"
 #include "entt/systems/MovementSystem.h"
 #include "entt/entities/EntityFactory.h"

diff --git a/benchmark/benchmarks/entt/EnttBenchmark.h b/benchmark/benchmarks/entt/EnttBenchmark.h
@@ -3,7 +3,7 @@
 
 #include "ECSBenchmark.h"
 
-#include "entt/systems/ComflabSystem.h"
+#include "entt/systems/DataSystem.h"
 #include "entt/systems/MoreComplexSystem.h"
 #include "entt/systems/MovementSystem.h"
 #include "entt/entities/EntityFactory.h"

diff --git a/benchmark/benchmarks/ginseng-more/GinsengBenchmark.h b/benchmark/benchmarks/ginseng-more/GinsengBenchmark.h
@@ -3,7 +3,7 @@
 
 #include "ECSBenchmark.h"
 
-#include "ginseng/systems/ComflabSystem.h"
+#include "ginseng/systems/DataSystem.h"
 #include "ginseng/systems/MoreComplexSystem.h"
 #include "ginseng/systems/MovementSystem.h"
 #include "ginseng/entities/EntityFactory.h"

diff --git a/benchmark/benchmarks/ginseng/GinsengBenchmark.h b/benchmark/benchmarks/ginseng/GinsengBenchmark.h
@@ -3,7 +3,7 @@
 
 #include "ECSBenchmark.h"
 
-#include "ginseng/systems/ComflabSystem.h"
+#include "ginseng/systems/DataSystem.h"
 #include "ginseng/systems/MoreComplexSystem.h"
 #include "ginseng/systems/MovementSystem.h"
 #include "ginseng/entities/EntityFactory.h"

diff --git a/benchmark/benchmarks/mustache-more/MustacheBenchmark.h b/benchmark/benchmarks/mustache-more/MustacheBenchmark.h
@@ -3,7 +3,7 @@
 
 #include "ECSBenchmark.h"
 
-#include "mustache/systems/ComflabSystem.h"
+#include "mustache/systems/DataSystem.h"
 #include "mustache/systems/MoreComplexSystem.h"
 #include "mustache/systems/MovementSystem.h"
 #include "mustache/entities/EntityFactory.h"

diff --git a/benchmark/benchmarks/mustache/MustacheBenchmark.h b/benchmark/benchmarks/mustache/MustacheBenchmark.h
@@ -3,7 +3,7 @@
 
 #include "ECSBenchmark.h"
 
-#include "mustache/systems/ComflabSystem.h"
+#include "mustache/systems/DataSystem.h"
 #include "mustache/systems/MoreComplexSystem.h"
 #include "mustache/systems/MovementSystem.h"
 #include "mustache/entities/EntityFactory.h"

diff --git a/benchmark/benchmarks/oop/OOPBenchmark.h b/benchmark/benchmarks/oop/OOPBenchmark.h
@@ -3,7 +3,7 @@
 
 #include "ECSBenchmark.h"
 
-#include "oop/systems/ComflabSystem.h"
+#include "oop/systems/DataSystem.h"
 #include "oop/systems/MoreComplexSystem.h"
 #include "oop/systems/MovementSystem.h"
 #include "oop/entities/EntityFactory.h"

diff --git a/benchmark/benchmarks/openecs-more/OpenECSBenchmark.h b/benchmark/benchmarks/openecs-more/OpenECSBenchmark.h
@@ -3,7 +3,7 @@
 
 #include "ECSBenchmark.h"
 
-#include "openecs/systems/ComflabSystem.h"
+#include "openecs/systems/DataSystem.h"
 #include "openecs/systems/MoreComplexSystem.h"
 #include "openecs/systems/MovementSystem.h"
 #include "openecs/entities/EntityFactory.h"

diff --git a/benchmark/benchmarks/openecs/OpenECSBenchmark.h b/benchmark/benchmarks/openecs/OpenECSBenchmark.h
@@ -3,7 +3,7 @@
 
 #include "ECSBenchmark.h"
 
-#include "openecs/systems/ComflabSystem.h"
+#include "openecs/systems/DataSystem.h"
 #include "openecs/systems/MoreComplexSystem.h"
 #include "openecs/systems/MovementSystem.h"
 #include "openecs/entities/EntityFactory.h"

diff --git a/doc/LICENSE b/doc/LICENSE