From 5ecb0ab4b4e5cc4f77dd199e987315e73739de50 Mon Sep 17 00:00:00 2001
From: Sylvester Kaczmarek
 <16242628+sylvesterkaczmarek@users.noreply.github.com>
Date: Sat, 22 Aug 2026 22:07:38 +0100
Subject: [PATCH] Document matrix in-place operations

---
 Source/MatrixFunctions/arm_mat_add_f32.c   | 5 +++++
 Source/MatrixFunctions/arm_mat_scale_f32.c | 5 +++++
 Source/MatrixFunctions/arm_mat_sub_f32.c   | 5 +++++
 3 files changed, 15 insertions(+)

diff --git a/Source/MatrixFunctions/arm_mat_add_f32.c b/Source/MatrixFunctions/arm_mat_add_f32.c
index 1a5796938..64ee27c18 100644
--- a/Source/MatrixFunctions/arm_mat_add_f32.c
+++ b/Source/MatrixFunctions/arm_mat_add_f32.c
@@ -64,6 +64,11 @@
   The functions check to make sure that
   <code>pSrcA</code>, <code>pSrcB</code>, and <code>pDst</code> have the same
   number of rows and columns.
+
+  @par In-place operation
+  The destination matrix may be the same instance as either input matrix.
+  Its data buffer may also be identical to either source data buffer. Other
+  overlapping buffer arrangements are not supported.
  */
 
 /**
diff --git a/Source/MatrixFunctions/arm_mat_scale_f32.c b/Source/MatrixFunctions/arm_mat_scale_f32.c
index 1cf524cb1..0c9e8415e 100644
--- a/Source/MatrixFunctions/arm_mat_scale_f32.c
+++ b/Source/MatrixFunctions/arm_mat_scale_f32.c
@@ -66,6 +66,11 @@
   <pre>
       scale = scaleFract * 2^shift.
   </pre>
+
+  @par In-place operation
+  The destination matrix may be the same instance as the input matrix. Its
+  data buffer may also be identical to the source data buffer. Other
+  overlapping buffer arrangements are not supported.
  */
 
 /**
diff --git a/Source/MatrixFunctions/arm_mat_sub_f32.c b/Source/MatrixFunctions/arm_mat_sub_f32.c
index 9790b5455..12766b13d 100644
--- a/Source/MatrixFunctions/arm_mat_sub_f32.c
+++ b/Source/MatrixFunctions/arm_mat_sub_f32.c
@@ -63,6 +63,11 @@
   The functions check to make sure that
   <code>pSrcA</code>, <code>pSrcB</code>, and <code>pDst</code> have the same
   number of rows and columns.
+
+  @par In-place operation
+  The destination matrix may be the same instance as either input matrix.
+  Its data buffer may also be identical to either source data buffer. Other
+  overlapping buffer arrangements are not supported.
  */
 
 /**