468e0c94daa906b26c82d2d408f602805acd17ce
[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  * 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 *
15 */
16 /*--------------------------------------------------------------------------*/
17
18 #include "linear_algebra_gw.hxx"
19 #include "function.hxx"
20 #include "double.hxx"
21 #include "overload.hxx"
22
23 extern "C"
24 {
25 #include "localization.h"
26 #include "Scierror.h"
27 #include "sciprint.h"
28 #include "eigen.h"
29 #include "issymmetric.h"
30 #include "vfinite.h"
31 }
32
33 bool isNoZeroImag(types::Double* _pDbl);
34 /*--------------------------------------------------------------------------*/
35
36 types::Function::ReturnValue sci_spec(types::typed_list &in, int _iRetCount, types::typed_list &out)
37 {
38     double* pDataA          = NULL;
39     double* pDataB          = NULL;
40     bool symmetric          = FALSE;
41     int iRet                = 0;
42
43     _iRetCount = std::max(1, _iRetCount);
44
45     if (in.size() != 1 && in.size() != 2)
46     {
47         Scierror(77, _("%s: Wrong number of input argument(s): %d to %d expected.\n"), "spec", 1, 2);
48         return types::Function::Error;
49     }
50
51     if (_iRetCount > 2 * in.size())
52     {
53         Scierror(78, _("%s: Wrong number of output argument(s): %d to %d expected.\n"), "spec", 1, 2 * in.size());
54         return types::Function::Error;
55     }
56
57     if (in[0]->isDouble() == false)
58     {
59         std::wstring wstFuncName = L"%" + in[0]->getShortTypeStr() + L"_spec";
60         return Overload::call(wstFuncName, in, _iRetCount, out);
61     }
62
63     types::Double* in0 = in[0]->getAs<types::Double>();
64
65     if (in0->getCols() != in0->getRows())
66     {
67         Scierror(20, _("%s: Wrong type for input argument #%d: Square matrix expected.\n"), "spec", 1);
68         return types::Function::Error;
69     }
70
71     if (in0->getRows() == -1 || in0->getCols() == -1) // manage eye case
72     {
73         Scierror(271, _("%s: Size varying argument a*eye(), (arg %d) not allowed here.\n"), "spec", 1);
74         return types::Function::Error;
75     }
76
77     if (in0->getCols() == 0 || in0->getRows() == 0) // size null
78     {
79         out.push_back(types::Double::Empty());
80         for (int i = 1; i < _iRetCount; i++)
81         {
82             out.push_back(types::Double::Empty());
83         }
84         return types::Function::OK;
85     }
86
87     types::Double* pDblA = in0->clone()->getAs<types::Double>();
88
89     if (in.size() == 1)
90     {
91         types::Double* pDblEigenValues  = NULL;
92         types::Double* pDblEigenVectors = NULL;
93
94         if (pDblA->isComplex())
95         {
96             pDataA = (double*)oGetDoubleComplexFromPointer(pDblA->getReal(), pDblA->getImg(), pDblA->getSize());
97             if (!pDataA)
98             {
99                 pDblA->killMe();
100                 Scierror(999, _("%s: Cannot allocate more memory.\n"), "spec");
101                 return types::Function::Error;
102             }
103         }
104         else
105         {
106             pDataA = pDblA->getReal();
107         }
108
109         int totalSize = pDblA->getSize();
110         if ((pDblA->isComplex() ? C2F(vfiniteComplex)(&totalSize, (doublecomplex*)pDataA) : C2F(vfinite)(&totalSize, pDataA)) == false)
111         {
112             if (pDblA->isComplex())
113             {
114                 vFreeDoubleComplexFromPointer((doublecomplex*)pDataA);
115             }
116             pDblA->killMe();
117             Scierror(264, _("%s: Wrong value for input argument %d: Must not contain NaN or Inf.\n"), "spec", 1);
118             return types::Function::Error;
119         }
120
121         symmetric = isSymmetric(pDblA->getReal(), pDblA->getImg(), pDblA->isComplex(), pDblA->getRows(), pDblA->getCols()) == 1;
122         int eigenValuesCols = (_iRetCount <= 1) ? 1 : pDblA->getCols();
123
124         if (symmetric)
125         {
126             pDblEigenValues = new types::Double(pDblA->getCols(), eigenValuesCols);
127             if (_iRetCount == 2)
128             {
129                 pDblEigenVectors = new types::Double(pDblA->getCols(), pDblA->getCols(), pDblA->isComplex());
130             }
131         }
132         else
133         {
134             pDblEigenValues  = new types::Double(pDblA->getCols(), eigenValuesCols, true);
135             if (_iRetCount == 2)
136             {
137                 pDblEigenVectors = new types::Double(pDblA->getCols(), pDblA->getCols(), true);
138             }
139         }
140
141         if (pDblA->isComplex())
142         {
143             if (symmetric)
144             {
145                 iRet = iEigen1ComplexSymmetricM((doublecomplex*)pDataA, pDblA->getCols(), (_iRetCount == 2), pDblEigenValues->getReal());
146
147                 if (iRet < 0)
148                 {
149                     vFreeDoubleComplexFromPointer((doublecomplex*)pDataA);
150                     pDblA->killMe();
151                     Scierror(998, _("%s: On entry to ZGEEV parameter number  3 had an illegal value (lapack library problem).\n"), "spec");
152                     return types::Function::Error;
153                 }
154
155                 if (iRet > 0)
156                 {
157                     vFreeDoubleComplexFromPointer((doublecomplex*)pDataA);
158                     pDblA->killMe();
159                     Scierror(24, _("%s: Convergence problem, %d off-diagonal elements of an intermediate tridiagonal form did not converge to zero.\n"), "spec", iRet);
160                     return types::Function::Error;
161                 }
162
163                 if (_iRetCount == 2)
164                 {
165                     vGetPointerFromDoubleComplex((doublecomplex*)pDataA, pDblA->getSize(), pDblEigenVectors->getReal(), pDblEigenVectors->getImg());
166                     vFreeDoubleComplexFromPointer((doublecomplex*)pDataA);
167                     expandToDiagonalOfMatrix(pDblEigenValues->getReal(), pDblA->getCols());
168                     out.push_back(pDblEigenVectors);
169                 }
170                 out.push_back(pDblEigenValues);
171                 pDblA->killMe();
172             }
173             else // not symmetric
174             {
175                 doublecomplex* pEigenValues = (doublecomplex*)MALLOC(pDblA->getCols() * sizeof(doublecomplex));
176                 doublecomplex* pEigenVectors = pDblEigenVectors ? (doublecomplex*)MALLOC(sizeof(doublecomplex) * pDblA->getSize()) : NULL;
177                 iRet = iEigen1ComplexM((doublecomplex*)pDataA, pDblA->getCols(), pEigenValues, pEigenVectors);
178                 vFreeDoubleComplexFromPointer((doublecomplex*)pDataA);
179                 if (iRet < 0)
180                 {
181                     pDblA->killMe();
182                     Scierror(998, _("%s: On entry to ZHEEV parameter number  3 had an illegal value (lapack library problem).\n"), "spec");
183                     return types::Function::Error;
184                 }
185
186                 if (iRet > 0)
187                 {
188                     pDblA->killMe();
189                     Scierror(24, _("%s: 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"), "spec", iRet);
190                     return types::Function::Error;
191                 }
192
193                 if (_iRetCount == 2)
194                 {
195                     expandZToDiagonalOfCMatrix(pEigenValues, pDblA->getCols(), pDblEigenValues->getReal(), pDblEigenValues->getImg());
196                     vGetPointerFromDoubleComplex(pEigenVectors, pDblA->getSize(), pDblEigenVectors->getReal(), pDblEigenVectors->getImg());
197
198                     FREE(pEigenVectors);
199                     out.push_back(pDblEigenVectors);
200                 }
201                 else
202                 {
203                     vGetPointerFromDoubleComplex(pEigenValues, pDblA->getCols(), pDblEigenValues->getReal(), pDblEigenValues->getImg());
204                 }
205                 out.push_back(pDblEigenValues);
206                 FREE(pEigenValues);
207                 pDblA->killMe();
208             }
209         }
210         else // real
211         {
212             if (symmetric)
213             {
214                 iRet = iEigen1RealSymmetricM(pDataA, pDblA->getCols(), (_iRetCount == 2), pDblEigenValues->getReal());
215                 if (iRet < 0)
216                 {
217                     pDblA->killMe();
218                     Scierror(998, _("%s: On entry to ZGEEV parameter number  3 had an illegal value (lapack library problem).\n"), "spec");
219                     return types::Function::Error;
220                 }
221
222                 if (iRet > 0)
223                 {
224                     pDblA->killMe();
225                     Scierror(24, _("%s: Convergence problem, %d off-diagonal elements of an intermediate tridiagonal form did not converge to zero.\n"), "spec", iRet);
226                     return types::Function::Error;
227                 }
228
229                 if (_iRetCount == 2)
230                 {
231                     expandToDiagonalOfMatrix(pDblEigenValues->getReal(), pDblA->getCols());
232                     out.push_back(pDblA);
233                 }
234                 else
235                 {
236                     pDblA->killMe();
237                 }
238
239                 out.push_back(pDblEigenValues);
240             }
241             else // not symmetric
242             {
243                 iRet = iEigen1RealM(pDataA, pDblA->getCols(), pDblEigenValues->getReal(), pDblEigenValues->getImg(), pDblEigenVectors ? pDblEigenVectors->getReal() : NULL, pDblEigenVectors ? pDblEigenVectors->getImg() : NULL);
244
245                 if (iRet < 0)
246                 {
247                     pDblA->killMe();
248                     Scierror(998, _("%s: On entry to ZHEEV parameter number  3 had an illegal value (lapack library problem).\n"), "spec");
249                     return types::Function::Error;
250                 }
251
252                 if (iRet > 0)
253                 {
254                     pDblA->killMe();
255                     Scierror(24, _("%s: 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"), "spec", iRet);
256                     return types::Function::Error;
257                 }
258
259                 if (_iRetCount == 2)
260                 {
261                     expandToDiagonalOfMatrix(pDblEigenValues->getReal(), pDblA->getCols());
262                     expandToDiagonalOfMatrix(pDblEigenValues->getImg(), pDblA->getCols());
263                     out.push_back(pDblEigenVectors);
264                 }
265
266                 out.push_back(pDblEigenValues);
267                 pDblA->killMe();
268             }
269         }
270
271         return types::Function::OK;
272     }
273
274     if (in.size() == 2)
275     {
276         types::Double* pDblL            = NULL;
277         types::Double* pDblR            = NULL;
278         types::Double* pDblBeta         = NULL;
279         types::Double* pDblAlpha        = NULL;
280         doublecomplex* pL               = NULL;
281         doublecomplex* pR               = NULL;
282         doublecomplex* pBeta            = NULL;
283         doublecomplex* pAlpha           = NULL;
284         bool bIsComplex                 = false;
285
286         if (in[1]->isDouble() == false)
287         {
288             std::wstring wstFuncName = L"%" + in[1]->getShortTypeStr() + L"_spec";
289             return Overload::call(wstFuncName, in, _iRetCount, out);
290         }
291
292         types::Double* in1 = in[1]->getAs<types::Double>();
293
294         if (in1->getCols() != in1->getRows())
295         {
296             Scierror(20, _("%s: Wrong type for input argument #%d: Square matrix expected.\n"), "spec", 2);
297             return types::Function::Error;
298         }
299
300         if (pDblA->getRows() != in1->getRows() && pDblA->getCols() != in1->getCols())
301         {
302             pDblA->killMe();
303             Scierror(999, _("%s: Arguments %d and %d must have equal dimensions.\n"), "spec", 1, 2);
304             return types::Function::Error;
305         }
306
307         //chekc if A and B are real complex or with imag part at 0
308         if (isNoZeroImag(pDblA) == false && isNoZeroImag(in1) == false)
309         {
310             //view A and B as real matrix
311             bIsComplex = false;
312         }
313         else
314         {
315             bIsComplex = pDblA->isComplex() || in1->isComplex();
316         }
317
318         types::Double* pDblB = in1->clone()->getAs<types::Double>();
319         if (bIsComplex)
320         {
321             if (pDblA->isComplex() == false)
322             {
323                 pDblA->setComplex(true);
324             }
325
326             if (pDblB->isComplex() == false)
327             {
328                 pDblB->setComplex(true);
329             }
330
331             pDataA = (double*)oGetDoubleComplexFromPointer(pDblA->getReal(), pDblA->getImg(), pDblA->getSize());
332             pDataB = (double*)oGetDoubleComplexFromPointer(pDblB->getReal(), pDblB->getImg(), pDblB->getSize());
333
334             if (!pDataA && !pDataB)
335             {
336                 Scierror(999, _("%s: Cannot allocate more memory.\n"), "spec");
337                 return types::Function::Error;
338             }
339
340             if (!pDataA)
341             {
342                 vFreeDoubleComplexFromPointer((doublecomplex*)pDataB);
343                 Scierror(999, _("%s: Cannot allocate more memory.\n"), "spec");
344                 return types::Function::Error;
345             }
346
347             if (!pDataB)
348             {
349                 vFreeDoubleComplexFromPointer((doublecomplex*)pDataA);
350                 Scierror(999, _("%s: Cannot allocate more memory.\n"), "spec");
351                 return types::Function::Error;
352             }
353         }
354         else
355         {
356             pDataA = pDblA->getReal();
357             pDataB = pDblB->getReal();
358         }
359
360         int totalSize = pDblA->getSize();
361
362         if ((pDblA->isComplex() ? C2F(vfiniteComplex)(&totalSize, (doublecomplex*)pDataA) : C2F(vfinite)(&totalSize, pDataA)) == false)
363         {
364             pDblA->killMe();
365             pDblB->killMe();
366             Scierror(264, _("%s: Wrong value for input argument %d: Must not contain NaN or Inf.\n"), "spec", 1);
367             return types::Function::Error;
368         }
369
370         if ((pDblB->isComplex() ? C2F(vfiniteComplex)(&totalSize, (doublecomplex*)pDataB) : C2F(vfinite)(&totalSize, pDataB)) == false)
371         {
372             pDblA->killMe();
373             pDblB->killMe();
374             Scierror(264, _("%s: Wrong value for input argument %d: Must not contain NaN or Inf.\n"), "spec", 2);
375             return types::Function::Error;
376         }
377
378         switch (_iRetCount)
379         {
380             case 4:
381             {
382                 pDblL = new types::Double(pDblA->getRows(), pDblA->getCols(), true);
383                 if (bIsComplex)
384                 {
385                     pL = (doublecomplex*)MALLOC(pDblA->getSize() * sizeof(doublecomplex));
386                 }
387             }
388             case 3:
389             {
390                 pDblR = new types::Double(pDblA->getRows(), pDblA->getCols(), true);
391                 if (bIsComplex)
392                 {
393                     pR = (doublecomplex*)MALLOC(pDblA->getSize() * sizeof(doublecomplex));
394                 }
395             }
396             case 2:
397             {
398                 if (bIsComplex)
399                 {
400                     pBeta = (doublecomplex*)MALLOC(pDblA->getCols() * sizeof(doublecomplex));
401                 }
402                 pDblBeta = new types::Double(pDblA->getCols(), 1, pBeta ? true : false);
403             }
404             default : // case 1:
405             {
406                 if (bIsComplex)
407                 {
408                     pAlpha = (doublecomplex*)MALLOC(pDblA->getCols() * sizeof(doublecomplex));
409                 }
410                 pDblAlpha = new types::Double(pDblA->getCols(), 1, true);
411             }
412         }
413
414         if (bIsComplex)
415         {
416             iRet = iEigen2ComplexM((doublecomplex*)pDataA, (doublecomplex*)pDataB, pDblA->getCols(), pAlpha, pBeta, pR, pL);
417         }
418         else
419         {
420             iRet = iEigen2RealM(    pDataA, pDataB, pDblA->getCols(),
421                                     pDblAlpha->getReal(), pDblAlpha->getImg(),
422                                     pDblBeta ? pDblBeta->getReal()  : NULL,
423                                     pDblR    ? pDblR->getReal()     : NULL,
424                                     pDblR    ? pDblR->getImg()      : NULL,
425                                     pDblL    ? pDblL->getReal()     : NULL,
426                                     pDblL    ? pDblL->getImg()      : NULL);
427         }
428
429         if (iRet > 0)
430         {
431             sciprint(_("Warning :\n"));
432             sciprint(_("Non convergence in the QZ algorithm.\n"));
433             sciprint(_("The top %d  x %d blocks may not be in generalized Schur form.\n"), iRet);
434         }
435
436         if (iRet < 0)
437         {
438             pDblA->killMe();
439             pDblB->killMe();
440             Scierror(998, _("%s: On entry to ZHEEV parameter number  3 had an illegal value (lapack library problem).\n"), "spec");
441             return types::Function::Error;
442         }
443
444         if (iRet > 0)
445         {
446             if (bIsComplex)
447             {
448                 if (iRet <= pDblA->getCols())
449                 {
450                     Scierror(24, _("%s: The QZ iteration failed in DGGEV.\n"), "spec");
451                 }
452                 else
453                 {
454                     if (iRet == pDblA->getCols() + 1)
455                     {
456                         Scierror(999, _("%s: Other than QZ iteration failed in DHGEQZ.\n"), "spec");
457                     }
458                     if (iRet == pDblA->getCols() + 2)
459                     {
460                         Scierror(999, _("%s: Error return from DTGEVC.\n"), "spec");
461                     }
462                 }
463             }
464             else
465             {
466                 Scierror(24, _("%s: 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"), "spec", iRet);
467             }
468
469             pDblA->killMe();
470             pDblB->killMe();
471             if (pDataA)
472             {
473                 vFreeDoubleComplexFromPointer((doublecomplex*)pDataA);
474             }
475
476             if (pDataB)
477             {
478                 vFreeDoubleComplexFromPointer((doublecomplex*)pDataB);
479             }
480             return types::Function::Error;
481         }
482
483         if (bIsComplex)
484         {
485             switch (_iRetCount)
486             {
487                 case 4:
488                     vGetPointerFromDoubleComplex(pL, pDblA->getSize(), pDblL->getReal(), pDblL->getImg());
489                 case 3:
490                     vGetPointerFromDoubleComplex(pR, pDblA->getSize(), pDblR->getReal(), pDblR->getImg());
491                 case 2:
492                     vGetPointerFromDoubleComplex(pBeta, pDblA->getCols(), pDblBeta->getReal(), pDblBeta->getImg());
493                 default : // case 1:
494                     vGetPointerFromDoubleComplex(pAlpha, pDblA->getCols(), pDblAlpha->getReal(), pDblAlpha->getImg());
495             }
496         }
497
498         switch (_iRetCount)
499         {
500             case 1:
501             {
502                 out.push_back(pDblAlpha);
503                 break;
504             }
505             case 2:
506             {
507                 out.push_back(pDblAlpha);
508                 out.push_back(pDblBeta);
509                 break;
510             }
511             case 3:
512             {
513                 out.push_back(pDblAlpha);
514                 out.push_back(pDblBeta);
515                 out.push_back(pDblR);
516                 break;
517             }
518             case 4:
519             {
520                 out.push_back(pDblAlpha);
521                 out.push_back(pDblBeta);
522                 out.push_back(pDblL);
523                 out.push_back(pDblR);
524             }
525         }
526
527         if (pAlpha)
528         {
529             vFreeDoubleComplexFromPointer(pAlpha);
530         }
531         if (pBeta)
532         {
533             vFreeDoubleComplexFromPointer(pBeta);
534         }
535         if (pL)
536         {
537             vFreeDoubleComplexFromPointer(pL);
538         }
539         if (pR)
540         {
541             vFreeDoubleComplexFromPointer(pR);
542         }
543         if (bIsComplex && pDblB->isComplex())
544         {
545             vFreeDoubleComplexFromPointer((doublecomplex*)pDataB);
546         }
547         pDblB->killMe();
548
549     } // if(in.size() == 2)
550
551     if (pDblA->isComplex())
552     {
553         vFreeDoubleComplexFromPointer((doublecomplex*)pDataA);
554     }
555
556     return types::Function::OK;
557 }
558 /*--------------------------------------------------------------------------*/
559 bool isNoZeroImag(types::Double* _pDbl)
560 {
561     double* pdbl = _pDbl->getImg();
562     if (pdbl)
563     {
564         for (int i = 0 ; i < _pDbl->getSize() ; i++)
565         {
566             if (pdbl[i])
567             {
568                 return true;
569             }
570         }
571     }
572     return false;
573 }
574 /*--------------------------------------------------------------------------*/