term.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_TERM_H
#define OPENF4_TERM_H

#include "global.h"
#include "monomial-array.h"
#include "element-prime.h"
#include "element-gf2.h"
#include "element-gf2-extension.h"
#ifdef HAVE_GIVARO
#include "element-givaro.h"
#endif // HAVE_GIVARO

namespace F4
{
    template <typename Element>
    class Term
    {
        public:
            
            /* Static methods */
            
            static void setMonomialArray(MonomialArray * monomialArray);
            
        
            /* Constructor */
            
            Term();
            
            Term(Element coeff, Monomial const & mon);
            
            Term(Element coeff, int numMon);
            
            Term(std::string const s);
            
            Term(Term const & toCopy);
            
            
            /* Get / Set */
            
            Element getCoefficient() const;
            
            void setCoefficient(Element coeff);
            
            void setCoefficientOne();
            
            int getNumMonomial() const;
            
            void setNumMonomial(int numMon);
            
            void setTerm(std::string const s);
            
            
            /* Miscellaneous */
            
            void readCoefficient(std::string const s);
            
            void printTerm (std::ostream & stream) const;
            
            void multNumMon(int numMon);
            
            int compareTerm(Term<Element> const & term) const;
            
            
            /* Internal operators */
            
            Term & operator=(Term const & term);
            
            Term & operator*=(Monomial const & monomial);
            
            Term & operator*=(Element element);
            
            Term & operator*=(Term const & term);
        
        private:
            Element _coefficient; 
            int _numMonomial; 
            static MonomialArray * MONOMIAL_ARRAY; 
    };
    
    
    /* External operators */
    
    template <typename Element>
    std::ostream & operator<<(std::ostream & stream, Term<Element> const & term);
    
    template <typename Element>
    Term<Element> operator * (Monomial const & mon, Term<Element> const & term);
    
    template <typename Element>
    Term<Element> operator * (Term<Element> const & term, Monomial const & mon);
    
    template <typename Element>
    Term<Element> operator * (Term<Element> const & term1, Term<Element> const & term2);
    
    template <typename Element>
    bool operator>(Term<Element> const & term1, Term<Element> const & term2);
    
    template <typename Element>
    bool operator<(Term<Element> const & term1, Term<Element> const & term2);
}

#include "../src/term.inl"
#endif // OPENF4_TERM_H