Coverity: ast module class hierarchy inconsistencies fixed
[scilab.git] / scilab / modules / ast / includes / types / sparse.hxx
1 /*
2  *  Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  *  Copyright (C) 2010-2010 - 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  *
14  */
15
16 #ifndef __SPARSE_HH__
17 #define __SPARSE_HH__
18
19 //#include <Eigen/Sparse>
20 #include <complex>
21 #include "double.hxx"
22 #include "bool.hxx"
23 #include "keepForSparse.hxx"
24
25 #define SPARSE_CONST
26
27 namespace Eigen
28 {
29 template<typename _Scalar, int _Flags, typename _Index>  class SparseMatrix;
30 }
31
32 namespace types
33 {
34 /* Utility function to create a new var on the heap from another type
35  */
36 template<typename Dest, typename Arg>
37 Dest* create_new(Arg const&);
38
39 struct SparseBool;
40
41 /**
42    Sparse is a wrapper over Eigen sparse matrices templates for either double or std::complex<double> values.
43  */
44 struct EXTERN_AST Sparse : GenericType
45 {
46     virtual ~Sparse();
47     /* @param src: Double matrix to copy into a new sparse matrix
48     **/
49     Sparse(Double SPARSE_CONST& src);
50     /* @param src : Double matrix to copy into a new sparse matrix
51        @param idx : Double matrix to use as indexes to get values from the src
52     **/
53     Sparse(Double SPARSE_CONST& src, Double SPARSE_CONST& idx);
54     /* @param src : Double matrix to copy into a new sparse matrix
55        @param idx : Double matrix to use as indexes to get values from the src
56        @param dims : Double matrix containing the dimensions of the new matrix
57     **/
58     Sparse(Double SPARSE_CONST& src, Double SPARSE_CONST& idx, Double SPARSE_CONST& dims);
59     /*
60       @param rows : nb of rows of the new matrix
61       @param rows : nb of columns of the new matrix
62       @param cplx : if the new matrix contains complex numbers
63     **/
64     Sparse(int rows, int cols, bool cplx = false);
65     Sparse(Sparse const& o);
66     /* cf. adj2sp()
67       @param xadj : adjacency matrix for the new matrix
68       @param adjncy : adjacency matrix (row indexes) for the new matrix
69       @param src : data for the new matrix
70       @param r : nb of rows for the new matrix
71       @param c : nb of columns for the new matrix
72     **/
73     Sparse(Double SPARSE_CONST& xadj, Double SPARSE_CONST& adjncy, Double SPARSE_CONST& src, std::size_t r, std::size_t c);
74
75     //constructor to create a sparse from value extract to another ( save / load operation typically)
76     Sparse(int rows, int cols, int nonzeros, int* inner, int* outer, double* real, double* img);
77
78     bool isSparse()
79     {
80         return true;
81     }
82     void finalize();
83
84     /*data management member function defined for compatibility with the Double API*/
85     Sparse* set(int _iRows, int _iCols, double _dblReal, bool _bFinalize = true);
86     Sparse* set(int _iIndex, double _dblReal, bool _bFinalize = true)
87     {
88         return set(_iIndex % m_iRows, _iIndex / m_iRows, _dblReal, _bFinalize);
89     }
90
91     Sparse* set(int _iRows, int _iCols, std::complex<double> v, bool _bFinalize = true);
92     Sparse* set(int _iIndex, std::complex<double> v, bool _bFinalize = true)
93     {
94         return set(_iIndex % m_iRows, _iIndex / m_iRows, v, _bFinalize);
95     }
96     /*
97       set non zero values to 1.
98     **/
99     bool one_set();
100     /* get real value at coords (r,c)
101     **/
102     double getReal(int r, int c) const;
103     double getReal(int _iIndex) const
104     {
105         return getReal(_iIndex % m_iRows, _iIndex / m_iRows);
106     }
107
108     double* get();
109     double get(int r, int c) const;
110     double get(int _iIndex) const
111     {
112         return get(_iIndex % m_iRows, _iIndex / m_iRows);
113     }
114
115     std::complex<double>* getImg();
116     std::complex<double> getImg(int r, int c) const;
117     std::complex<double> getImg(int _iIndex) const
118     {
119         return getImg(_iIndex % m_iRows, _iIndex / m_iRows);
120     }
121
122     /* return true if matrix contains complex numbers, false otherwise.
123     **/
124     bool isComplex() const;
125     // overload of GenericType methode.
126     bool isComplex()
127     {
128         // force const to call isComplex const method.
129         const Sparse* sp = this;
130         return sp->isComplex();
131     }
132
133     inline bool isScalar()
134     {
135         return (getRows() == 1 && getCols() == 1);
136     }
137     /* clear all the values of the matrix to 0. (or 0.+0.i if complex)
138     **/
139     bool zero_set();
140
141     /*
142       Config management and GenericType methods overrides
143     */
144     void whoAmI() SPARSE_CONST;
145     bool isExtract() const;
146     Sparse* clone(void);
147     bool toString(std::wostringstream& ostr);
148
149     /* post condition: dimensions are at least _iNewRows, _iNewCols
150        preserving existing data.
151        If dimensions where already >=, this is a no-op.
152
153        @param _iNewRows new minimum nb of rows
154        @param _iNewCols new minimum nb of cols
155        @return true upon succes, false otherwise.
156      */
157     Sparse* resize(int _iNewRows, int _iNewCols);
158     /* post condition: new total size must be equal to the old size.
159                        Two dimensions maximum.
160
161        @param _iNewRows new nb of rows
162        @param _iNewCols new nb of cols
163        @param _piNewDims new nb of dimension
164        @param _iNewDims new size for each dimension
165        @return true upon succes, false otherwise.
166     */
167     Sparse* reshape(int* _piNewDims, int _iNewDims);
168     Sparse* reshape(int _iNewRows, int _iNewCols);
169     /*
170       insert _iSeqCount elements from _poSource at coords given by _piSeqCoord (max in _piMaxDim).
171       coords are considered 1D if _bAsVector, 2D otherwise.
172       @param _iSeqCount nb of elts to insert
173       @param _piSeqCoord dest coords
174       @param _poSource src
175       @param  _bAsVector if _piSeqCoord contains 1D coords.
176      */
177     Sparse* insert(typed_list* _pArgs, InternalType* _pSource);
178
179     GenericType* remove(typed_list* _pArgs);
180
181     GenericType* insertNew(typed_list* _pArgs);
182
183     /* append _poSource from coords _iRows, _iCols
184        @param _iRows row to append from
185        @param _iCols col to append from
186        @param _poSource src data to append
187      */
188     Sparse* append(int r, int c, types::Sparse SPARSE_CONST* src);
189
190     /*
191       extract a submatrix
192       @param _iSeqCount nb of elts to extract
193       @param _piSeqCoord src coords
194       @param _piMaxDim max coords
195       @param _piDimSize size of the extracted matrix
196       @param  _bAsVector if _piSeqCoord contains 1D coords.
197
198      */
199     GenericType* extract(typed_list* _pArgs);
200     Sparse* extract(int _iSeqCount, int* _piSeqCoord, int* _piMaxDim, int* _piDimSize, bool _bAsVector) SPARSE_CONST;
201     virtual bool invoke(typed_list & in, optional_list & /*opt*/, int /*_iRetCount*/, typed_list & out, const ast::Exp & e);
202     virtual bool isInvokable() const;
203     virtual bool hasInvokeOption() const;
204     virtual int getInvokeNbIn();
205     virtual int getInvokeNbOut();
206
207     /*
208        change the sign (inplace).
209      */
210     void opposite();
211
212     /*
213       compares with an other value for equality (same nb of elts, with same values)
214       TODO: should it handle other types ?
215      */
216     bool operator==(const InternalType& it) SPARSE_CONST;
217     /*
218       compares with an other value for inequality (same nb of elts, with same values)
219       TODO: should it handle other types ?
220      */
221     bool operator!=(const InternalType& it) SPARSE_CONST
222     {
223         return !(*this == it);
224     }
225
226
227     /* return type as string ( double, int, cell, list, ... )*/
228     virtual std::wstring         getTypeStr() SPARSE_CONST {return std::wstring(L"sparse");}
229     /* return type as short string ( s, i, ce, l, ... ), as in overloading macros*/
230     virtual std::wstring         getShortTypeStr() SPARSE_CONST {return std::wstring(L"sp");}
231
232     /* create a new sparse matrix containing the result of an addition
233        @param o other matrix to add
234        @return ptr to the new matrix, 0 in case of failure
235      */
236     Sparse* add(Sparse const& o) const;
237
238     /* create a new sparse matrix containing the result of an addition
239        @param d scalar to add
240        @return ptr to the new matrix, 0 in case of failure
241      */
242     Double* add(double d) const;
243
244     /* create a new sparse matrix containing the result of an addition
245        @param c complex  to add
246        @return ptr to the new matrix, 0 in case of failure
247      */
248     Double* add(std::complex<double> c) const;
249
250
251
252
253     /* create a new sparse matrix containing the result of a substraction
254        @param o other matrix to substract
255        @return ptr to the new matrix, 0 in case of failure
256      */
257     Sparse* substract(Sparse const& o) const;
258
259     /* create a new sparse matrix containing the result of an subtraction
260        @param d scalar to subtract
261        @return ptr to the new matrix, 0 in case of failure
262      */
263     Double* substract(double d) const;
264
265     /* create a new sparse matrix containing the result of an subtraction
266        @param c scalar to subtract
267        @return ptr to the new matrix, 0 in case of failure
268      */
269     Double* substract(std::complex<double> c) const;
270
271
272     /* create a new sparse matrix containing the result of a multiplication
273        @param o other matrix to substract
274        @return ptr to the new matrix, 0 in case of failure
275      */
276     Sparse* multiply(Sparse const& o) const;
277
278     /* create a new sparse matrix containing the result of an multiplication
279        @param s scalar to multiply by
280        @return ptr to the new matrix, 0 in case of failure
281      */
282     Sparse* multiply(double s) const;
283
284     /* create a new sparse matrix containing the result of an multiplication
285        @param c scalar to subtract
286        @return ptr to the new matrix, 0 in case of failure
287      */
288     Sparse* multiply(std::complex<double> c) const;
289
290     /* create a new matrix containing the result of an .*
291        @param o sparse matrix to .*
292        @return ptr to the new matrix, 0 in case of failure
293      */
294     Sparse* dotMultiply(Sparse SPARSE_CONST& o) const;
295
296     /* create a new matrix containing the result of an ./
297       @param o sparse matrix to ./
298       @return ptr to the new matrix, 0 in case of failure
299     */
300     Sparse* dotDivide(Sparse SPARSE_CONST& o) const;
301
302     bool neg(InternalType *& out);
303
304     bool transpose(InternalType *& out);
305     bool adjoint(InternalType *& out);
306     int newCholLLT(Sparse** permut, Sparse** factor) const;
307
308     /** create a new sparse matrix containing the non zero values set to 1.
309        equivalent but faster than calling one_set() on a new copy of the
310        current matrix.
311        @return ptr to the new matrix, 0 in case of failure
312      */
313     Sparse* newOnes() const;
314
315     Sparse* newReal() const;
316     /** @return the nb of non zero values.
317      */
318     std::size_t nonZeros() const;
319
320     /* @param i row of the current sparse matrix
321        @return the nb of non zero values in row i
322      */
323     std::size_t nonZeros(std::size_t i) const;
324
325     int* getNbItemByRow(int* _piNbItemByRows);
326     int* getColPos(int* _piColPos);
327     int* getInnerPtr(int* count);
328     int* getOuterPtr(int* count);
329
330
331     /**
332        "in-place" cast into a sparse matrix of comlpex values
333      */
334     void toComplex();
335
336     /* coefficient wise relational operator < between *this sparse matrix and an other.
337        Matrices must have the same dimensions except if one of them is of size (1,1)
338        (i.e. a scalar) : it is then treated as a constant matrix of thre required dimensions.
339
340        @param o other sparse matrix
341
342        @return ptr to a new Sparse matrix where each element is the result of the logical operator
343         '<' between the elements of *this and those of o.
344      */
345     SparseBool* newLessThan(Sparse &o);
346
347     /* coefficient wise relational operator != between *this sparse matrix and an other.
348        Matrices must have the same dimensions except if one of them is of size (1,1)
349        (i.e. a scalar) : it is then treated as a constant matrix of thre required dimensions.
350
351        @param o other sparse matrix
352
353        @return ptr to a new Sparse matrix where each element is the result of the logical operator
354         '!=' between the elements of *this and those of o.
355      */
356     SparseBool* newNotEqualTo(Sparse const&o) const;
357
358     /* coefficient wise relational operator <= between *this sparse matrix and an other.
359        Matrices must have the same dimensions except if one of them is of size (1,1)
360        (i.e. a scalar) : it is then treated as a constant matrix of thre required dimensions.
361
362        Do not use this function is possible as the result will be dense because
363        0. <= 0. is true, hence the result matrix will hold a non default value (i.e. true)
364        for each pair of default values (0.) of the sparse arguments !
365
366        @param o other sparse matrix
367
368        @return ptr to a new Sparse matrix where each element is the result of the logical operator
369         '<=' between the elements of *this and those of o.
370      */
371     SparseBool* newLessOrEqual(Sparse &o);
372
373     /* coefficient wise relational operator == between *this sparse matrix and an other.
374        Matrices must have the same dimensions except if one of them is of size (1,1)
375        (i.e. a scalar) : it is then treated as a constant matrix of thre required dimensions.
376
377        Do not use this function is possible as the result will be dense because
378        0. == 0. is true, hence the result matrix will hold a non default value (i.e. true)
379        for each pair of default values (0.) of the sparse arguments !
380
381        @param o other sparse matrix
382
383        @return ptr to a new Sparse matrix where each element is the result of the logical operator
384         '==' between the elements of *this and those of o.
385      */
386     SparseBool* newEqualTo(Sparse &o);
387
388     /**
389        output 1-base column numbers of the non zero elements
390        @param out : ptr used as an output iterator over double values
391        @return past-the-end output iterator after ouput is done
392      */
393     double* outputCols(double* out) const;
394
395     /**
396        output real and imaginary values of the non zero elements
397        @param outReal : ptr used as an output iterator over double values for real values
398        @param outImag : ptr used as an output iterator over double values for imaginary values if any
399        @return pair of past-the-end output iterators after ouput is done
400      */
401     std::pair<double*, double*> outputValues(double* outReal, double* outImag)const;
402
403     /**
404        ouput rows and afterwards columns of the non zero elements
405        @param out : ptr used as an output iterator over double values
406        @return past-the-end output iterators after ouput is done
407      */
408     int* outputRowCol(int* out)const;
409
410     /**
411        @param dest Double to be filled with values from the current sparse matrix.
412      */
413     void fill(Double& dest, int r = 0, int c = 0) SPARSE_CONST;
414
415
416     inline ScilabType  getType(void) SPARSE_CONST
417     {
418         return ScilabSparse;
419     }
420
421     inline ScilabId    getId(void) SPARSE_CONST
422     {
423         if (isComplex())
424         {
425             return IdSparseComplex;
426         }
427         return IdSparse;
428     }
429
430
431
432     SparseBool* newLesserThan(Sparse const&o);
433
434     typedef Eigen::SparseMatrix<double, 0x1, int>                   RealSparse_t;
435     typedef Eigen::SparseMatrix<std::complex<double>, 0x1, int>     CplxSparse_t;
436     /**
437        One and only one of the args should be 0.
438        @param realSp ptr to an Eigen sparse matrix of double values
439        @param cplxSp ptr to an Eigen sparse matrix of std::complex<double> elements
440      */
441     Sparse(RealSparse_t* realSp, CplxSparse_t* cplxSp);
442
443     RealSparse_t* matrixReal;
444     CplxSparse_t* matrixCplx;
445
446 protected :
447 private :
448
449     /** utility function used by constructors
450         @param rows : nb of rows
451         @param cols : nb of columns
452         @param src : Double matrix data source
453         @param : iterator (cf MatrixIterator.hxx) with indices
454         @param n : nb of elements to copy from data source.
455      */
456     template<typename DestIter>
457     void create(int rows, int cols, Double SPARSE_CONST& src, DestIter o, std::size_t n);
458     void create2(int rows, int cols, Double SPARSE_CONST& src, Double SPARSE_CONST& idx);
459
460     /** utility function used by insert functions conceptually : sp[destTrav]= src[srcTrav]
461         @param src : data source
462         @param SrcTrav : iterator over the data source
463         @param n : nb of elements to copy
464         @param sp : sparse destination matrix
465         @param destTrav : iterator over the data sink (i.e. sp)
466      */
467     template<typename Src, typename SrcTraversal, typename Sz, typename DestTraversal>
468     static bool copyToSparse(Src SPARSE_CONST& src, SrcTraversal srcTrav, Sz n, Sparse& sp, DestTraversal destTrav);
469
470     Sparse* insert(typed_list* _pArgs, Sparse* _pSource);
471 };
472
473 template<typename T>
474 void neg(const int r, const int c, const T * const in, Eigen::SparseMatrix<bool, 1, int> * const out);
475
476
477 /*
478   Implement sparse boolean matrix
479  */
480 struct EXTERN_AST SparseBool : GenericType
481 {
482     virtual ~SparseBool();
483     /* @param src: Bool matrix to copy into a new sparse matrix
484     **/
485     SparseBool(Bool SPARSE_CONST& src);
486     /* @param src : Bool matrix to copy into a new sparse matrix
487        @param idx : Double matrix to use as indexes to get values from the src
488     **/
489     SparseBool(Bool SPARSE_CONST& src, Double SPARSE_CONST& idx);
490     /* @param src : Bool matrix to copy into a new sparse matrix
491        @param idx : Double matrix to use as indexes to get values from the src
492        @param dims : Double matrix containing the dimensions of the new matrix
493     **/
494     SparseBool(Bool SPARSE_CONST& src, Double SPARSE_CONST& idx, Double SPARSE_CONST& dims);
495     /*
496        @param rows : nb of rows of the new matrix
497        @param rows : nb of columns of the new matrix
498     */
499     SparseBool(int rows, int cols);
500
501     SparseBool(SparseBool const& o);
502
503     //constructor to create a sparse from value extract to another ( save / load operation typically)
504     SparseBool(int rows, int cols, int trues, int* inner, int* outer);
505
506     bool isSparseBool()
507     {
508         return true;
509     }
510     void finalize();
511
512     bool toString(std::wostringstream& ostr);
513
514     /* Config management and GenericType methods overrides */
515     SparseBool* clone(void);
516
517     SparseBool* resize(int _iNewRows, int _iNewCols);
518     SparseBool* reshape(int* _piNewDims, int _iNewDims);
519     SparseBool* reshape(int _iNewRows, int _iNewCols);
520     SparseBool* insert(typed_list* _pArgs, InternalType* _pSource);
521     SparseBool* append(int _iRows, int _iCols, SparseBool SPARSE_CONST* _poSource);
522
523     GenericType* remove(typed_list* _pArgs);
524     GenericType* insertNew(typed_list* _pArgs);
525     GenericType* extract(typed_list* _pArgs);
526
527     SparseBool* extract(int _iSeqCount, int* _piSeqCoord, int* _piMaxDim, int* _piDimSize, bool _bAsVector) SPARSE_CONST;
528
529     virtual bool invoke(typed_list & in, optional_list &/*opt*/, int /*_iRetCount*/, typed_list & out, const ast::Exp & e);
530     virtual bool isInvokable() const;
531     virtual bool hasInvokeOption() const;
532     virtual int getInvokeNbIn();
533     virtual int getInvokeNbOut();
534
535     bool transpose(InternalType *& out);
536
537     /** @return the nb of non zero values.
538      */
539     std::size_t nbTrue() const;
540     /* @param i row of the current sparse matrix
541        @return the nb of non zero values in row i
542      */
543     std::size_t nbTrue(std::size_t i) const;
544
545     void setTrue(bool finalize = true);
546     void setFalse(bool finalize = true);
547
548     int* getNbItemByRow(int* _piNbItemByRows);
549     int* getColPos(int* _piColPos);
550     int* getInnerPtr(int* count);
551     int* getOuterPtr(int* count);
552     /**
553        output 1-base column numbers of the non zero elements
554        @param out : ptr used as an output iterator over double values
555        @return past-the-end output iterator after ouput is done
556      */
557
558     int* outputRowCol(int* out)const;
559
560     bool operator==(const InternalType& it) SPARSE_CONST;
561     bool operator!=(const InternalType& it) SPARSE_CONST;
562
563     /* return type as string ( double, int, cell, list, ... )*/
564     virtual std::wstring getTypeStr() SPARSE_CONST {return std::wstring(L"boolean sparse");}
565     /* return type as short string ( s, i, ce, l, ... )*/
566     virtual std::wstring getShortTypeStr() SPARSE_CONST {return std::wstring(L"spb");}
567
568     inline ScilabType getType(void) SPARSE_CONST
569     {
570         return ScilabSparseBool;
571     }
572
573     inline ScilabId getId(void) SPARSE_CONST
574     {
575         return IdSparseBool;
576     }
577
578     inline bool isScalar()
579     {
580         return (getRows() == 1 && getCols() == 1);
581     }
582
583     bool isTrue()
584     {
585         if (static_cast<int>(nbTrue()) == m_iSize)
586         {
587             return true;
588         }
589         return false;
590     }
591
592     bool neg(InternalType *& out)
593     {
594         SparseBool * _out = new SparseBool(getRows(), getCols());
595         types::neg(getRows(), getCols(), matrixBool, _out->matrixBool);
596         _out->finalize();
597         out = _out;
598         return true;
599     }
600
601     void whoAmI() SPARSE_CONST;
602
603     bool* get();
604     bool get(int r, int c) SPARSE_CONST;
605     bool get(int _iIndex) SPARSE_CONST
606     {
607         return get(_iIndex % m_iRows, _iIndex / m_iRows);
608     }
609
610     SparseBool* set(int r, int c, bool b, bool _bFinalize = true) SPARSE_CONST;
611     SparseBool* set(int _iIndex, bool b, bool _bFinalize = true) SPARSE_CONST
612     {
613         return set(_iIndex % m_iRows, _iIndex / m_iRows, b, _bFinalize);
614     }
615
616     void fill(Bool& dest, int r = 0, int c = 0) SPARSE_CONST;
617
618     Sparse* newOnes() const;
619     SparseBool* newNotEqualTo(SparseBool const&o) const;
620     SparseBool* newEqualTo(SparseBool& o);
621
622     SparseBool* newLogicalOr(SparseBool const&o) const;
623     SparseBool* newLogicalAnd(SparseBool const&o) const;
624
625     typedef Eigen::SparseMatrix<bool, 0x1, int> BoolSparse_t;
626     SparseBool(BoolSparse_t* o);
627     BoolSparse_t* matrixBool;
628
629 private:
630     void create2(int rows, int cols, Bool SPARSE_CONST& src, Double SPARSE_CONST& idx);
631     SparseBool* insert(typed_list* _pArgs, SparseBool* _pSource);
632 };
633
634 template<typename T>
635 struct SparseTraits
636 {
637     typedef types::Sparse type;
638 };
639 template<>
640 struct SparseTraits<types::Bool>
641 {
642     typedef types::SparseBool type;
643 };
644 template<>
645 struct SparseTraits<types::SparseBool>
646 {
647     typedef types::SparseBool type;
648 };
649
650 }
651
652 #endif /* !__SPARSE_HH__ */