GPL + CeCILL Header change
[scilab.git] / scilab / modules / linear_algebra / includes / qr.h
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2009 - DIGITEO - Bernard HUGUENEY
4  *
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  *
7  * This file is hereby licensed under the terms of the GNU GPL v2.0,
8  * pursuant to article 5.3.4 of the CeCILL v.2.1.
9  * This file was originally licensed under the terms of the CeCILL v2.1,
10  * and continues to be available under such terms.
11  * For more information, see the COPYING file which you should have received
12  * along with this program.
13  * === LICENSE_END ===
14  *
15  */
16
17 #ifndef QR_H
18 #define QR_H
19 #include "dynlib_linear_algebra.h"
20 /*
21   Performs memory allocations and computes QR decomposition (calling iQr)
22  * in :
23  * @param pData double* pointer to memory (either in 'd' or 'z' format) of argument matrix
24  * @param iRows int number of rows
25  * @param iCols int number of columns
26  * @param complexArg int (really bool) tells if data is in real (in 'd' format) or complex (in 'z' format)
27  * @param iRowsToCompute int nb of rows to compute, iRows , or min(iRows, icols) for "economy" mode
28  * @param dblTol double tolerance used for rank if -1, R(1,1)*%eps*max(iRows, iCols)
29  * out :
30  * @param pdblQ double* pointer to memory (either in 'd' or 'z' format) where Q result will be stored
31  * @param pdblR double* pointer to memory (either in 'd' or 'z' format) where R result will be stored
32  * @param pdblEData double* NULL if E does not need to be computed, otherwise pointer to memory
33  * (either in 'd' or 'z' format) where E result will be stored
34  * @param pdblRank double*  NULL if rank does not need to be computed, otherwise pointer to memory where rank will be stored
35  * @return if the operation successed (true) or not (false)
36  */
37 LINEAR_ALGEBRA_IMPEXP int iQrM(double* pData, int iRows, int iCols, int /*bool*/ complexArg, int iRowsToCompute, double dblTol
38                                , double* pdblQ, double* pdblR, double* pdblE, double* pdblRank);
39 #endif