GPL + CeCILL Header change
[scilab.git] / scilab / modules / linear_algebra / includes / rcond.h
1
2 /*
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ????-2009 - INRIA
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  * === LICENSE_END ===
15  *
16  */
17
18 #ifndef __RCOND_H__
19 #define __RCOND_H__
20 #include "dynlib_linear_algebra.h"
21 /*
22  * inverse condition number of a real or complex matrix. see http://www.scilab.org/product/man/rcond.html
23  *
24  * in:
25  *
26  * @param pData double[complex]* in/scratch real or complex (in 'z' format) argument matrix data
27  * @param iCols int in nb of rows and cols of the argument matrix
28  * @param complexArg int (bool semantics) in is argument matrix complex ?
29  *
30  * out:
31  *
32  * @param pRcond double* out inverse condition number
33  *
34  * @return error code 0: success, -1: MALLOC failure, >0 Lapack error, -> rcond= 0.
35  *
36  */
37
38 LINEAR_ALGEBRA_IMPEXP int iRcondM(double* pData, int iCols, int complexArg, double* pRcond);
39 #endif /* !__RCOND_H__ */