From ad49e580dc5a63b7575239131985854c53312639 Mon Sep 17 00:00:00 2001 From: Greg Tucker Date: Fri, 13 Dec 2019 16:24:05 -0700 Subject: [PATCH] doc: Fix missing description of gf_matrix_inverse Doc missed issue of input matrix destruction. Fixes #116 Change-Id: Ic840b27532d90518dd21ec2701c278a1c3b61a8b Signed-off-by: Greg Tucker --- include/erasure_code.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/include/erasure_code.h b/include/erasure_code.h index f3d3267..2f9a257 100644 --- a/include/erasure_code.h +++ b/include/erasure_code.h @@ -926,7 +926,10 @@ void gf_gen_cauchy1_matrix(unsigned char *a, int m, int k); /** * @brief Invert a matrix in GF(2^8) * - * @param in input matrix + * Attempts to construct an n x n inverse of the input matrix. Returns non-zero + * if singular. Will always destroy input matrix in process. + * + * @param in input matrix, destroyed by invert process * @param out output matrix such that [in] x [out] = [I] - identity matrix * @param n size of matrix [nxn] * @returns 0 successful, other fail on singular input matrix