From d3ce2aa5f8a8fc1f3dfe034821df8531968af249 Mon Sep 17 00:00:00 2001 From: fischerth80683 Date: Mon, 3 Nov 2025 14:57:55 +0100 Subject: [PATCH] added folder docs/requirements.txt --- docs/requirements.txt | 60 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..92e2947 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,60 @@ +======================================================== +Projekt: gamematrix (C++ Library) +Rolle: Projektleiter +Datei: requirements.txt +Datum: 3.11.2025 +Team: Thomas und Co +======================================================== + +# ---------------------------- +# 1. Projektziel +# ---------------------------- +Beschreiben Sie hier kurz das Ziel des Projekts: + +Ziel: Implementierung der Matrixmulitplikation, -Rotation, -Verschiebung und anschließendes Testen + +# ---------------------------- +# 2. Funktionale Anforderungen +# ---------------------------- +Listen Sie alle Funktionen auf, die die Bibliothek bereitstellen soll. +Tragen Sie ein: Funktion, Eingabe, Ausgabe, kurze Beschreibung + +| Funktion | Eingabe | Ausgabe | Kurzbeschreibung | +|---------------|------------------------------------|-----------------------|----------------------------------------| +| matmul | 4x4 Matrix A, 4x4 Matrix B | 4x4 Matrix | Multiplikation zweier Matrizen wie in Mathe gelernt +| translate | 3D Vektor | 4x4 Matrix | Verschiebung +| rot3D | Winkel in °, Rotationsachse (x/y/z)| 4x4 Matrix | Rotation +| identity (optional)| --- | 4x4 Matrix | _____________________________________ | +| _____________ | __________________________________ | ____________________ | ______________________________ | +| _____________ | __________________________________ | ____________________ | ______________________________ | + +# ---------------------------- +# 3. Nicht-funktionale Anforderungen +# ---------------------------- +(z. B. Performance, Lesbarkeit, Wartbarkeit, Python-Kompatibilität via pybind11) + +- Lesbarkeit nach Coding Guidelines: https://elearning.ohmportal.de/pluginfile.php/395279/mod_page/content/5/Coding_Guidelines.pdf + + +# ---------------------------- +# 4. Annahmen / Einschränkungen +# ---------------------------- +(z. B. alle Matrizen sind 4x4, Winkel in Grad, nur double) + +- alle Matrizen sind 4x4 +- Winkel in Grad +- nur double + +# ---------------------------- +# 5. Abnahmekriterien +# ---------------------------- +Wie soll geprüft werden, dass die Anforderungen erfüllt sind? +(z. B. Unit-Tests, Beispielrotationen, Matrizenmultiplikation) + +- Tests von Marco müssen fehlerfrei verlaufen + +======================================================== +Hinweis: +- Diese Datei wird vom Projektleiter erstellt und gepflegt. +- Jede Phase des Projekts soll hier dokumentiert werden. +======================================================== \ No newline at end of file