mirror of
https://github.com/intel/isa-l.git
synced 2024-12-13 09:52:56 +01:00
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 <greg.b.tucker@intel.com>
This commit is contained in:
parent
2b8cc393af
commit
ad49e580dc
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user