fix incorrect copyright attribution from INRIA to DIGITEO
[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  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at
9  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10  *
11  */
12
13 #ifndef QR_H
14 #define QR_H
15
16 /*
17   Performs memory allocations and computes QR decomposition (calling iQr)
18  * in :
19  * @param pData double* pointer to memory (either in 'd' or 'z' format) of argument matrix
20  * @param iRows int number of rows 
21  * @param iCols int number of columns 
22  * @param complexArg int (really bool) tells if data is in real (in 'd' format) or complex (in 'z' format)
23  * @param iRowsToCompute int nb of rows to compute, iRows , or min(iRows, icols) for "economy" mode
24  * @param dblTol double tolerance used for rank if -1, R(1,1)*%eps*max(iRows, iCols)
25  * out :
26  * @param pdblQ double* pointer to memory (either in 'd' or 'z' format) where Q result will be stored
27  * @param pdblR double* pointer to memory (either in 'd' or 'z' format) where R result will be stored
28  * @param pdblEData double* NULL if E does not need to be computed, otherwise pointer to memory
29  * (either in 'd' or 'z' format) where E result will be stored
30  * @param pdblRank double*  NULL if rank does not need to be computed, otherwise pointer to memory where rank will be stored
31  * @return if the operation successed (true) or not (false)
32  */  
33 int iQrM(double* pData, int iRows, int iCols, int /*bool*/ complexArg, int iRowsToCompute, double dblTol
34          , double* pdblQ, double* pdblR, double* pdblE, double* pdblRank);
35 #endif