From 9f1579d7b18829e1148a60a44b075e7c01936d7f Mon Sep 17 00:00:00 2001 From: Achilles Kappis <axilleaz@protonmail.com> Date: Tue, 26 Mar 2024 14:13:08 +0000 Subject: [PATCH] Update README.md --- Utilities/README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/Utilities/README.md b/Utilities/README.md index 4f6aafe..7bcf15a 100644 --- a/Utilities/README.md +++ b/Utilities/README.md @@ -1,6 +1,23 @@ # Utilities -This section holds generic, utility functions that do not fall under any other category and can be used in various cases. There has been no distinct separation of the functions to sub-categories. +This section holds generic, utility functions that do not fall under any other category and can be used in various cases. There are currently two sub-categories, the "Generic" and the "Geometries". The first contains generic functions that can be used in various cases. The latter contains code to generate microphone and source geometries. Although it has been created to be used in the *Active Noise Control* problem to generate arrangements of sources and receivers it can be used for any other purpose. + +## Dependencies + +There are depenencies between the different sub-categories of the utility functions. The known dependencies are summarised below and more information can be found in the respective [Wiki](https://gitlab.com/in-nova/in-nova/-/wikis/home) pages of each function or in the [Documentation](https://gitlab.com/in-nova/in-nova/-/tree/main/Documentation/latex?ref_type=heads). + +- MATLAB + - Generic + - `isOdd()` + - `isEven()` + - Geometries + - `rcvGeo()` + - `rotMat3dDeg()` + - `srcGeo()` + - `rotMat3dDeg()` + - `ptsOnSphere()` + - `virtMicGeo()` + - `rotMat3dDeg()` #### Acknowledgments -- GitLab