tagged-polynomial.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2015 Antoine Joux, Vanessa Vitse and Titouan Coladon
 * 
 * This file is part of openf4.
 * 
 * openf4 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * openf4 is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with openf4.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef OPENF4_TAGGED_POLYNOMIAL_H
#define OPENF4_TAGGED_POLYNOMIAL_H

#include "global.h"
#include "polynomial.h"

namespace F4
{
    template <typename Element>
    class TaggedPolynomial
    {
        public:
        
            /* Static methods */
            
            static void setMonomialArray(MonomialArray * monomialArray);
            

            /* Constructor */
            
            TaggedPolynomial();
            
            TaggedPolynomial(Polynomial<Element> const & polynomial);
            
            TaggedPolynomial(TaggedPolynomial const & taggedPolynomial);
            
            TaggedPolynomial(TaggedPolynomial  && taggedPolynomial);
            
            
            /* Destructor */
            
            ~TaggedPolynomial();
            
            
            /* Get / Set */
            
            Polynomial<Element> const & getPolynomialConst() const;
            
            Polynomial<Element> & getPolynomial();
            
            void setPolynomial(Polynomial<Element> && polynomial);
            
            const Term<Element> & getLT() const; 
            
            int getLM() const;
            
            Element getLC() const;
            
            int getNbTerm() const;
            
            int getSimplyrule(int index) const;
            
            void setSimplyrule(int index, int numPol);
            
            NodeList<Element> * getPolynomialBegin();
            
            NodeList<Element> const * getPolynomialBeginConst() const;
            
            
            /* Miscellaneous */
            
            void printTaggedPolynomial (std::ostream & stream) const;
            
            int compareTaggedPolynomial (TaggedPolynomial const & taggedPolynomial) const;
            
            bool isEmpty();
            
            void resetSimplyrules();
            
            void setTaggedPolynomial(TaggedPolynomial const & taggedPolynomial, uint8_t const * varlist);
            
            
            /* Internal operators */
            
            TaggedPolynomial & operator=(TaggedPolynomial const & taggedPolynomial);
            
            TaggedPolynomial & operator=(TaggedPolynomial  && taggedPolynomial);
            
            TaggedPolynomial & operator=(Polynomial<Element> const & polynomial);
            
            TaggedPolynomial & operator=(Polynomial<Element>  && polynomial);
            
            TaggedPolynomial & operator*=(Monomial const & monomial);
            
            TaggedPolynomial & operator*=(Element element);
            
            TaggedPolynomial & operator*=(Term<Element> const & term);
            
        private:
        
            Polynomial<Element> _polynomial;           
            int * _simplyrules;       
            static MonomialArray * MONOMIAL_ARRAY; 
    };
    
    
    /* External operators */
    
    template <typename Element>
    std::ostream & operator<<(std::ostream & stream, TaggedPolynomial<Element> const & taggedPolynomial);
    
    template <typename Element>
    bool operator==(TaggedPolynomial<Element> const & taggedPolynomial1, TaggedPolynomial<Element> const & taggedPolynomial2);
    
    template <typename Element>
    bool operator>(TaggedPolynomial<Element> const & taggedPolynomial1, TaggedPolynomial<Element> const & taggedPolynomial2);
    
    template <typename Element>
    bool operator>=(TaggedPolynomial<Element> const & taggedPolynomial1, TaggedPolynomial<Element> const & taggedPolynomial2);
    
    template <typename Element>
    bool operator<(TaggedPolynomial<Element> const & taggedPolynomial1, TaggedPolynomial<Element> const & taggedPolynomial2);
    
    template <typename Element>
    bool operator<=(TaggedPolynomial<Element> const & taggedPolynomial1, TaggedPolynomial<Element> const & taggedPolynomial2);
    
    template <typename Element>
    TaggedPolynomial<Element> operator * (Monomial const & monomial, TaggedPolynomial<Element> const & taggedPolynomial);
    
    template <typename Element>
    TaggedPolynomial<Element> operator * (TaggedPolynomial<Element> const & taggedPolynomial, Monomial const & monomial);

    template <typename Element>
    TaggedPolynomial<Element> operator * (Element element, TaggedPolynomial<Element> const & taggedPolynomial);
    
    template <typename Element>
    TaggedPolynomial<Element> operator * (TaggedPolynomial<Element> const & taggedPolynomial, Element element);

    template <typename Element>
    TaggedPolynomial<Element> operator * (Term<Element> const & term, TaggedPolynomial<Element> const & taggedPolynomial);
    
    template <typename Element>
    TaggedPolynomial<Element> operator * (TaggedPolynomial<Element> const & taggedPolynomial, Term<Element> const & term);
}

#include "../src/tagged-polynomial.inl"
#endif // OPENF4_TAGGED_POLYNOMIAL_H