refactoring polynom.
[scilab.git] / scilab / modules / ast / includes / types / polynom.hxx
1 /*
2 *  Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3 *  Copyright (C) 2008-2008 - DIGITEO - Antoine ELIAS
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 // This code is separated in matrixpoly.hxx
14 // but will be inlined in arrayof.hxx
15 //
16 // If you need additionnal headers, please add it in arrayof.hxx
17
18 //#ifndef __ARRAYOF_HXX__
19 //    #error This file must only be include by arrayof.hxx
20 //#endif
21
22 #ifndef __POLYNOM_HXX__
23 #define __POLYNOM_HXX__
24
25 #include "arrayof.hxx"
26 #include "singlepoly.hxx"
27 #include "double.hxx"
28
29 //disable warnings about exports STL items
30 #ifdef _MSC_VER
31 #pragma warning (disable : 4251)
32 #endif
33
34 namespace types
35 {
36 class EXTERN_AST Polynom : public ArrayOf<SinglePoly*>
37 {
38 public :
39     Polynom();
40     Polynom(std::wstring _szVarName, int _iRows, int _iCols);
41     Polynom(std::wstring _szVarName, int _iRows, int _iCols, const int *_piRank);
42     Polynom(std::wstring _szVarName, int _iDims, int* _piDims);
43     Polynom(std::wstring _szVarName, int _iDims, int* _piDims, const int *_piRank);
44
45     virtual                 ~Polynom();
46
47     // FIXME : Should not return NULL
48     InternalType*           clone();
49
50     bool                    setCoef(int _iRows, int _iCols, Double *_pdblCoef);
51     bool                    setCoef(int _iIdx, Double *_pdblCoef);
52
53     virtual void            setComplex(bool _bComplex);
54
55     inline ScilabType       getType(void)
56     {
57         return ScilabPolynom;
58     }
59
60     inline ScilabId         getId(void)
61     {
62         return isScalar() ? isComplex() ? IdScalarPolynomComplex
63                : IdScalarPolynom
64        : isComplex() ? IdPolynomComplex
65                : IdPolynom;
66     }
67
68     bool isComplex(void);
69
70     inline bool             isPoly()
71     {
72         return true;
73     }
74
75     void                    whoAmI(void);
76     std::wstring            getVariableName();
77     void                    setVariableName(std::wstring);
78     bool                    getRank(int *_piRank);
79     int                     getMaxRank(void);
80     Double*                 evaluate(Double* _pdblValue);
81     void                    updateRank(void);
82     Double*                 getCoef(void);
83     void                    setCoef(Double *_pCoef);
84     Double*                 extractCoef(int _iRank);
85     bool                    insertCoef(int _iRank, Double* _pCoef);
86     void                    setZeros();
87
88     bool                    set(int _iPos, SinglePoly* _pS);
89     bool                    set(int _iRows, int _iCols, SinglePoly* _pS);
90     bool                    set(SinglePoly** _pS);
91
92     std::wstring            getRowString(int* _piDims, int _iDims, bool _bComplex);
93     std::wstring            getColString(int* _piDims, int _iDims, bool _bComplex);
94     std::wstring            getMatrixString(int* _piDims, int _iDims, bool _bComplex);
95
96
97     bool                    operator==(const InternalType& it);
98     bool                    operator!=(const InternalType& it);
99
100     /* return type as string ( double, int, cell, list, ... )*/
101     virtual std::wstring    getTypeStr()
102     {
103         return L"polynomial";
104     }
105     /* return type as short string ( s, i, ce, l, ... )*/
106     virtual std::wstring    getShortTypeStr()
107     {
108         return L"p";
109     }
110
111     bool isTrue()
112     {
113         return false;
114     }
115
116     bool transpose(InternalType *& out);
117     bool adjoint(InternalType *& out);
118
119 protected :
120     std::wstring            m_szVarName;
121     void                    createPoly(std::wstring _szVarName, int _iDims, int* _piDims, const int *_piRank);
122
123 private :
124     virtual bool            subMatrixToString(std::wostringstream& ostr, int* _piDims, int _iDims);
125
126     virtual SinglePoly*     getNullValue();
127     virtual Polynom*        createEmpty(int _iDims, int* _piDims, bool _bComplex = false);
128     virtual SinglePoly*     copyValue(SinglePoly* _pData);
129     virtual void            deleteAll();
130     virtual void            deleteImg();
131     virtual SinglePoly**    allocData(int _iSize);
132
133 };
134 }
135
136 #ifdef _MSC_VER
137 template class types::ArrayOf<types::SinglePoly*>; //Polynom
138 #endif
139 #endif /* !__POLYNOM_HXX__ */