linear_algebra plugged.
[scilab.git] / scilab / modules / linear_algebra / sci_gateway / cpp / sci_spec.cpp
1 /*
2 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3 * Copyright (C) 2009 - DIGITEO - Bernard HUGUENEY
4 * Copyright (C) 2011 - DIGITEO - Cedric DELAMARRE
5 *
6 * This file must be used under the terms of the CeCILL.
7 * This source file is licensed as described in the file COPYING, which
8 * you should have received as part of this distribution.  The terms
9 * are also available at
10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11 *
12 */
13 /*--------------------------------------------------------------------------*/
14
15 #include "linear_algebra_gw.hxx"
16 #include "function.hxx"
17 #include "double.hxx"
18 #include "overload.hxx"
19 #include "execvisitor.hxx"
20
21 extern "C"
22 {
23 #include "localization.h"
24 #include "Scierror.h"
25 #include "sciprint.h"
26 #include "eigen.h"
27 #include "issymmetric.h"
28 #include "vfinite.h"
29 }
30
31 bool isNoZeroImag(types::Double* _pDbl);
32 /*--------------------------------------------------------------------------*/
33
34 types::Function::ReturnValue sci_spec(types::typed_list &in, int _iRetCount, types::typed_list &out)
35 {
36     types::Double* pDblA    = NULL;
37     types::Double* pDblB    = NULL;
38     double* pDataA          = NULL;
39     double* pDataB          = NULL;
40     bool symmetric          = FALSE;
41     int iRet                = 0;
42
43     if((in.size() != 1) && (in.size() != 2))
44     {
45         ScierrorW(77, _W("%ls: Wrong number of input argument(s): %d to %d expected.\n"), L"spec", 1, 2);
46         return types::Function::Error;
47     }
48
49     if(_iRetCount > 2*in.size())
50     {
51         ScierrorW(78, _W("%ls: Wrong number of output argument(s): %d to %d expected.\n"), L"spec", 1, 2*in.size());
52         return types::Function::Error;
53     }
54
55     if((in[0]->isDouble() == false))
56     {
57         std::wstring wstFuncName = L"%"  + in[0]->getShortTypeStr() + L"_spec";
58         return Overload::call(wstFuncName, in, _iRetCount, out, new ExecVisitor());
59     }
60     pDblA = in[0]->getAs<types::Double>()->clone()->getAs<types::Double>();
61
62     if(pDblA->getCols() != pDblA->getRows())
63     {
64                 ScierrorW(20, _W("%ls: Wrong type for argument %d: Square matrix expected.\n"), L"sped", 1);
65         return types::Function::Error;  
66     }
67
68     if((pDblA->getRows() == -1) || (pDblA->getCols() == -1)) // manage eye case
69     {
70         ScierrorW(271,_W("%ls: Size varying argument a*eye(), (arg %d) not allowed here.\n"), L"spec", 1);
71         return types::Function::Error;
72     }
73
74     if((pDblA->getCols() == 0) || (pDblA->getRows() == 0)) // size null
75     {
76         out.push_back(types::Double::Empty());
77         for(int i=1; i < _iRetCount; i++)
78         {
79             out.push_back(types::Double::Empty());
80         }
81         return types::Function::OK;
82     }
83
84     if(in.size() == 1)
85     {
86         types::Double* pDblEigenValues  = NULL;
87         types::Double* pDblEigenVectors = NULL;
88
89         if(pDblA->isComplex())
90         {
91             pDataA = (double*)oGetDoubleComplexFromPointer(pDblA->getReal(), pDblA->getImg(), pDblA->getSize());
92             if(!pDataA)
93             {
94                 ScierrorW(999,_W("%ls: Cannot allocate more memory.\n"),L"spec");
95                 return types::Function::Error;
96             }
97         }
98         else
99         {
100             pDataA = pDblA->getReal();
101         }
102
103         int totalSize = pDblA->getSize();
104         if((pDblA->isComplex() ? C2F(vfiniteComplex)(&totalSize, (doublecomplex*)pDataA) : C2F(vfinite)(&totalSize, pDataA)) == false)
105         {
106                     ScierrorW(264, _W("%ls: Wrong value for argument %d: Must not contain NaN or Inf.\n"), L"spec", 1);
107             return types::Function::Error;   
108         }
109
110         symmetric = isSymmetric(pDblA->getReal(), pDblA->getImg(), pDblA->isComplex(), pDblA->getRows(), pDblA->getCols()) == 1;
111         int eigenValuesCols = (_iRetCount == 1) ? 1 : pDblA->getCols();
112
113         if(symmetric)
114         {
115             pDblEigenValues = new types::Double(pDblA->getCols(), eigenValuesCols);
116             if(_iRetCount == 2)
117             {
118                 pDblEigenVectors = new types::Double(pDblA->getCols(), pDblA->getCols(), pDblA->isComplex());
119             }
120         }
121         else
122         {
123             pDblEigenValues  = new types::Double(pDblA->getCols(), eigenValuesCols, true);
124             if(_iRetCount == 2)
125             {
126                 pDblEigenVectors = new types::Double(pDblA->getCols(), pDblA->getCols(), true);
127             }
128         }
129
130         if(pDblA->isComplex())
131         {
132             if(symmetric)
133             {
134                 iRet = iEigen1ComplexSymmetricM((doublecomplex*)pDataA, pDblA->getCols(), (_iRetCount == 2), pDblEigenValues->getReal());
135
136                 if(iRet < 0)
137                 {
138                     ScierrorW(998, _W("%ls: On entry to ZGEEV parameter number  3 had an illegal value (lapack library problem).\n"), L"spec", iRet);
139                     return types::Function::Error;
140                 }
141
142                 if(iRet > 0)
143                 {
144                     ScierrorW(24, _W("%ls: Convergence problem, %d off-diagonal elements of an intermediate tridiagonal form did not converge to zero.\n"), L"spec", iRet);
145                     return types::Function::Error;
146                 }
147
148                 if(_iRetCount == 2)
149                 {
150                     vGetPointerFromDoubleComplex((doublecomplex*)pDataA, pDblA->getSize() , pDblEigenVectors->getReal(), pDblEigenVectors->getImg());
151                     expandToDiagonalOfMatrix(pDblEigenValues->getReal(), pDblA->getCols());
152                     out.push_back(pDblEigenVectors);
153                 }
154                 out.push_back(pDblEigenValues);
155             }
156             else // not symmetric
157             {
158                 doublecomplex* pEigenValues = (doublecomplex*)MALLOC(pDblA->getCols() * sizeof(doublecomplex));
159                 doublecomplex* pEigenVectors = pDblEigenVectors ? (doublecomplex*)MALLOC(sizeof(doublecomplex) * pDblA->getSize()) : NULL;
160                 iRet = iEigen1ComplexM((doublecomplex*)pDataA, pDblA->getCols(), pEigenValues,pEigenVectors);
161                 if(iRet < 0)
162                 {
163                     ScierrorW(998, _W("%ls: On entry to ZHEEV parameter number  3 had an illegal value (lapack library problem).\n"), L"spec", iRet);
164                     return types::Function::Error;
165                 }
166
167                 if(iRet > 0)
168                 {
169                     ScierrorW(24, _W("%ls: The QR algorithm failed to compute all the eigenvalues, and no eigenvectors have been computed. Elements and %d+1:N of W contain eigenvalues which have converged.\n"), L"spec", iRet);
170                     return types::Function::Error;
171                 }
172
173                 if(_iRetCount == 2)
174                 {
175                     expandZToDiagonalOfCMatrix(pEigenValues, pDblA->getCols(), pDblEigenValues->getReal(), pDblEigenValues->getImg());
176                     vGetPointerFromDoubleComplex(pEigenVectors, pDblA->getSize(), pDblEigenVectors->getReal(), pDblEigenVectors->getImg());
177
178                     FREE(pEigenVectors);
179                     out.push_back(pDblEigenVectors);
180                 }
181                 else
182                 {
183                     vGetPointerFromDoubleComplex(pEigenValues, pDblA->getCols(), pDblEigenValues->getReal(), pDblEigenValues->getImg());
184                 }
185                 out.push_back(pDblEigenValues);
186                 FREE(pEigenValues);
187             }
188         }
189         else // real
190         {
191             if(symmetric)
192             {
193                 iRet= iEigen1RealSymmetricM(pDataA, pDblA->getCols(), (_iRetCount == 2), pDblEigenValues->getReal());
194
195                 if(iRet < 0)
196                 {
197                     ScierrorW(998, _W("%ls: On entry to ZGEEV parameter number  3 had an illegal value (lapack library problem).\n"), L"spec", iRet);
198                     return types::Function::Error;
199                 }
200
201                 if(iRet > 0)
202                 {
203                     ScierrorW(24, _W("%ls: Convergence problem, %d off-diagonal elements of an intermediate tridiagonal form did not converge to zero.\n"), L"spec", iRet);
204                     return types::Function::Error;
205                 }
206
207                 if(_iRetCount == 2)
208                 {
209                     expandToDiagonalOfMatrix(pDblEigenValues->getReal(), pDblA->getCols());
210                     out.push_back(pDblA);
211                 }
212                 out.push_back(pDblEigenValues);
213             }
214             else // not symmetric
215             {
216                 iRet = iEigen1RealM(pDataA, pDblA->getCols(), pDblEigenValues->getReal(), pDblEigenValues->getImg(), pDblEigenVectors ? pDblEigenVectors->getReal() : NULL, pDblEigenVectors ? pDblEigenVectors->getImg() : NULL);
217
218                 if(iRet < 0)
219                 {
220                     ScierrorW(998, _W("%ls: On entry to ZHEEV parameter number  3 had an illegal value (lapack library problem).\n"), L"spec", iRet);
221                     return types::Function::Error;
222                 }
223
224                 if(iRet > 0)
225                 {
226                     ScierrorW(24, _W("%ls: The QR algorithm failed to compute all the eigenvalues, and no eigenvectors have been computed. Elements and %d+1:N of WR and WI contain eigenvalues which have converged.\n"), L"spec", iRet);
227                     return types::Function::Error;
228                 }
229
230                 if(_iRetCount == 2)
231                 {
232                     expandToDiagonalOfMatrix(pDblEigenValues->getReal(), pDblA->getCols());
233                     expandToDiagonalOfMatrix(pDblEigenValues->getImg(), pDblA->getCols());
234                     out.push_back(pDblEigenVectors);
235                 }
236                 out.push_back(pDblEigenValues);
237             }
238         }
239     }
240
241     if(in.size() == 2)
242     {
243         types::Double* pDblL            = NULL;
244         types::Double* pDblR            = NULL;
245         types::Double* pDblBeta         = NULL;
246         types::Double* pDblAlpha        = NULL;
247         doublecomplex* pL               = NULL;
248         doublecomplex* pR               = NULL;
249         doublecomplex* pBeta            = NULL;
250         doublecomplex* pAlpha           = NULL;
251         bool bIsComplex                 = false;
252
253         if((in[1]->isDouble() == false))
254         {
255             std::wstring wstFuncName = L"%"  + in[1]->getShortTypeStr() + L"_spec";
256             return Overload::call(wstFuncName, in, _iRetCount, out, new ExecVisitor());
257         }
258         pDblB = in[1]->getAs<types::Double>()->clone()->getAs<types::Double>();
259         if((pDblA->getRows() != pDblB->getRows()) && (pDblA->getCols() != pDblB->getCols()))
260         {
261             ScierrorW(999, _W("%ls: Arguments %d and %d must have equal dimensions.\n"), L"spec", 1, 2);
262             return types::Function::Error;
263         }
264
265         //chekc if A and B are real complex or with imamg part at 0
266         if(isNoZeroImag(pDblA) == false && isNoZeroImag(pDblB) == false)
267         {//view A and B as real matrix
268             bIsComplex = false;
269         }
270         else
271         {
272             bIsComplex = pDblA->isComplex() || pDblB->isComplex();
273         }
274
275         if(bIsComplex)
276         {
277             if(pDblA->isComplex() == false)
278             {
279                 pDblA->setComplex(true);
280             }
281
282             if(pDblB->isComplex() == false)
283             {
284                 pDblB->setComplex(true);
285             }
286
287             pDataA = (double*)oGetDoubleComplexFromPointer(pDblA->getReal(), pDblA->getImg(), pDblA->getSize());
288             pDataB = (double*)oGetDoubleComplexFromPointer(pDblB->getReal(), pDblB->getImg(), pDblB->getSize());
289
290             if(!pDblA || !pDblB)
291             {
292                 ScierrorW(999,_W("%ls: Cannot allocate more memory.\n"),L"spec");
293                 return types::Function::Error;
294             }
295         }
296         else
297         {
298             pDataA = pDblA->getReal();
299             pDataB = pDblB->getReal();
300         }
301
302         int totalSize = pDblA->getSize();
303
304         if((pDblA->isComplex() ? C2F(vfiniteComplex)(&totalSize, (doublecomplex*)pDataA) : C2F(vfinite)(&totalSize, pDataA)) == false)
305         {
306                     ScierrorW(264, _W("%ls: Wrong value for argument %d: Must not contain NaN or Inf.\n"), L"spec", 1);
307             return types::Function::Error;   
308         }
309
310         if((pDblB->isComplex() ? C2F(vfiniteComplex)(&totalSize, (doublecomplex*)pDataB) : C2F(vfinite)(&totalSize, pDataB)) == false)
311         {
312                     ScierrorW(264, _W("%ls: Wrong value for argument %d: Must not contain NaN or Inf.\n"), L"spec", 2);
313             return types::Function::Error;   
314         }
315
316         switch(_iRetCount)
317         {
318             case 4:
319             {
320                 pDblL = new types::Double(pDblA->getRows(), pDblA->getCols(), true);
321                 if(bIsComplex)
322                 {
323                     pL = (doublecomplex*)MALLOC(pDblA->getSize() * sizeof(doublecomplex));
324                 }
325             }
326             case 3:
327             {
328                 pDblR = new types::Double(pDblA->getRows(), pDblA->getCols(), true);
329                 if(bIsComplex)
330                 {
331                     pR = (doublecomplex*)MALLOC(pDblA->getSize() * sizeof(doublecomplex));
332                 }
333             }
334             case 2:
335             {
336                 if(bIsComplex)
337                 {
338                     pBeta = (doublecomplex*)MALLOC(pDblA->getCols() * sizeof(doublecomplex));
339                 }
340                 pDblBeta = new types::Double(pDblA->getCols(), 1, pBeta ? true : false);
341             }
342             default : // case 1:
343             {
344                 if(bIsComplex)
345                 {
346                     pAlpha = (doublecomplex*)MALLOC(pDblA->getCols() * sizeof(doublecomplex));
347                 }
348                 pDblAlpha = new types::Double(pDblA->getCols(), 1, true);
349             }
350         }
351
352         if(bIsComplex)
353         {
354             iRet = iEigen2ComplexM((doublecomplex*)pDataA, (doublecomplex*)pDataB, pDblA->getCols(), pAlpha, pBeta, pR, pL);
355         }
356         else
357         {
358             iRet = iEigen2RealM(    pDataA, pDataB, pDblA->getCols(), 
359                                     pDblAlpha->getReal(), pDblAlpha->getImg(), 
360                                     pDblBeta ? pDblBeta->getReal()  : NULL, 
361                                     pDblR    ? pDblR->getReal()     : NULL, 
362                                     pDblR    ? pDblR->getImg()      : NULL, 
363                                     pDblL    ? pDblL->getReal()     : NULL,
364                                     pDblL    ? pDblL->getImg()      : NULL);
365         }
366
367         if(iRet > 0)
368         {
369             sciprint(_("Warning :\n"));
370             sciprint(_("Non convergence in the QZ algorithm.\n"));
371             sciprint(_("The top %d  x %d blocks may not be in generalized Schur form.\n"), iRet);
372         }
373
374         if(iRet < 0)
375         {
376             ScierrorW(998, _W("%ls: On entry to ZHEEV parameter number  3 had an illegal value (lapack library problem).\n"), L"spec", iRet);
377             return types::Function::Error;
378         }
379
380         if(iRet > 0)
381         {
382             if(bIsComplex)
383             {
384                 if(iRet <= pDblA->getCols())
385                 {
386                     ScierrorW(24, _W("%ls: The QZ iteration failed in DGGEV.\n"), L"spec");
387                 }
388                 else
389                 {
390                     if(iRet ==  pDblA->getCols()+1) ScierrorW(999, _W("%ls: Other than QZ iteration failed in DHGEQZ.\n"), L"spec");
391                     if(iRet ==  pDblA->getCols()+2) ScierrorW(999, _W("%ls: Error return from DTGEVC.\n"), L"spec");
392                 }
393             }
394             else
395             {
396                 ScierrorW(24, _W("%ls: The QR algorithm failed to compute all the eigenvalues, and no eigenvectors have been computed. Elements and %d+1:N of W contain eigenvalues which have converged.\n"), L"spec", iRet);
397             }
398             return types::Function::Error;
399         }
400
401         if(bIsComplex)
402         {
403             switch(_iRetCount)
404             {
405                 case 4: vGetPointerFromDoubleComplex(pL, pDblA->getSize(), pDblL->getReal(), pDblL->getImg());
406                 case 3: vGetPointerFromDoubleComplex(pR, pDblA->getSize(), pDblR->getReal(), pDblR->getImg());
407                 case 2: vGetPointerFromDoubleComplex(pBeta, pDblA->getCols(), pDblBeta->getReal(), pDblBeta->getImg());
408                 default : // case 1:
409                     vGetPointerFromDoubleComplex(pAlpha, pDblA->getCols(), pDblAlpha->getReal(), pDblAlpha->getImg());
410             }
411         }
412
413         switch(_iRetCount)
414         {
415             case 1:
416             {
417                 out.push_back(pDblAlpha);
418                 break;
419             }
420             case 2:
421             {
422                 out.push_back(pDblAlpha);
423                 out.push_back(pDblBeta);
424                 break;
425             }
426             case 3:
427             {
428                 out.push_back(pDblAlpha);
429                 out.push_back(pDblBeta);
430                 out.push_back(pDblR);
431                 break;
432             }
433             case 4:
434             {
435                 out.push_back(pDblAlpha);
436                 out.push_back(pDblBeta);
437                 out.push_back(pDblL);
438                 out.push_back(pDblR);
439             }
440         }
441
442         if(pAlpha)
443                     vFreeDoubleComplexFromPointer(pAlpha);
444         if(pBeta)
445                     vFreeDoubleComplexFromPointer(pBeta);
446         if(pL)
447                     vFreeDoubleComplexFromPointer(pL);
448         if(pR)
449                     vFreeDoubleComplexFromPointer(pR);
450         if(pDblB->isComplex())
451             vFreeDoubleComplexFromPointer((doublecomplex*)pDataB);
452
453     } // if(in.size() == 2)
454
455     if(pDblA->isComplex())
456     {
457         vFreeDoubleComplexFromPointer((doublecomplex*)pDataA);
458     }
459
460     return types::Function::OK;
461 }
462 /*--------------------------------------------------------------------------*/
463 bool isNoZeroImag(types::Double* _pDbl)
464 {       
465     double* pdbl = _pDbl->getImg();
466     for(int i = 0 ; i < _pDbl->getSize() ; i++)
467         {
468                 if (pdbl[i])
469                 {
470                         return true;
471                 }
472         }
473         return false;
474 }
475 /*--------------------------------------------------------------------------*/