From aa3aac234b2ad58e286d06d7acd56a7e1ae2a521 Mon Sep 17 00:00:00 2001
From: ZaellixA <axilleaz@protonmail.com>
Date: Mon, 17 Feb 2025 16:56:04 +0000
Subject: [PATCH] Update CHANGELOG.md to include information about the addition
 of the diagCorr function

---
 CHANGELOG.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index b505fef..d9d5396 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -33,6 +33,9 @@
 \* Fix error in `virtMicGeo()` not returning the z coordinates of the virtual microphones in the mesh. This fix **breaks backward compatibility**.\
 \* Change name of `virtMicGeo()` to `vMicGeo()`. This **breaks** backward compatibility.
 
+**Utilities - Generic**\
+\+ Added the function `diagCorr()` to calculate the correlation coefficient of a matrix to a diagonal matrix. In practice this provides a metric to measure the "diagonality" of a matrix. 
+
 **Virtual Sensing - Remote Microphone Technique**\
 \* Parallelise the for-loops in `obsFiltEst()`. While execution may be slower for a small number of sources and receiver positions, the overall execution time will not increase significantly due to the functions' generally fast performance.\
 \* Parallelise on of the for-loops in `obsFiltTD()`. While execution may be slower for a small number of sources and receiver positions, the overall execution time will not increase significantly due to the functions' generally fast performance.\
-- 
GitLab