Added missing API docu, improved existing API docu
[libfirm] / include / libfirm / adt / gaussjordan.h
1 /**
2  * @file
3  * @brief solves a system of linear equations
4  */
5 #ifndef FIRM_ADT_GAUSSJORDAN_H
6 #define FIRM_ADT_GAUSSJORDAN_H
7
8 #include "../begin.h"
9
10 /**
11  * @ingroup algorithms
12  * @defgroup gassjordan  Gauss Jordan Elimination
13  * Solves a system of linear equations
14  * @{
15  */
16
17 /**
18  * solves a system of linear equations and returns 0 if successful
19  *
20  * @param A       the linear equations as matrix
21  * @param b       the result vector, will contain the result if successful
22  * @param nsize   the size of the equation system
23  */
24 FIRM_API int firm_gaussjordansolve(double *A, double *b, int nsize);
25
26 /** @} */
27
28 #include "../end.h"
29
30 #endif