monomial.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_MONOMIAL_H
#define OPENF4_MONOMIAL_H

#include "global.h"
#include <iostream>
#include <string>
#include <vector>
#include <cassert>
namespace F4
{
    class Monomial
    {
        public:
            
            /* Static methods */
             
             static void setNbVariable(int nbVariable);
             
             static int getNbVariable();
             
             static void setVariable(std::string const  * vars);
             
             static std::string const  * getVariable();
             
             static void setWeight(int  * weight);
             
             static int * getWeight();
             
             static short getMaxDegree();
             
             static void setNbMonomial(short maxDegree);
             
             static void increaseNbMonomial(int numMonomial);
             
             static int getNbMonomial();
             
             static int getNbMonomial(int row, int column);
             
             static void freeNbMonomial();
             
             static int compareNumMonomial(int numMon1, int numMon2);
             
             static int varlistToInt(uint8_t const * varlist);
             
             static int varlistToInt(uint8_t const * varlist, short deg);
             
             static int varlistToInt(uint8_t const * varlist1, uint8_t const * varlist2);
             
             static void initMonomial(int nbVariable, short degree=1);
             
             static void freeMonomial();
            
            /* Constructor */
            
            Monomial();
            
            Monomial(Monomial const & toCopy);
            
            
            /* Get / Set */
            
            short getDegree() const;
            
            uint8_t const * getVarlist() const;
            
            uint8_t getVarlist(int index) const;
            
            void setVarlist(uint8_t * varlist);
            
            
            /* Miscellaneous */
            
            void allocate();
            
            void erase();
            
            void setMonomial(uint8_t const * varlist);
            
            void setMonomial(std::string const s);
            
            void setMonomial(int numMon);
            
            void setMonomial(Monomial const & mon);
            
            void setMonomialMultiply(Monomial const & mon1, Monomial const & mon2);
            
            void setMonomialDivide(Monomial const & mon1, Monomial const & mon2);
            
            void intToMonomial(int numMon);
            
            int monomialToInt() const;
            
            void printMonomial (std::ostream & stream) const;
            
            int compareMonomial(Monomial const & mon) const;
            
            bool isDivisible(Monomial const & mon) const;
            
            void reset();
            
            
            /* Internal operators */
            
            Monomial & operator=(Monomial const & mon);
            
            Monomial & operator=(Monomial && mon);
            
            Monomial & operator*=(Monomial const & mon); 
            
            friend int multiplyMonomial(Monomial const & mon1, Monomial const & mon2);
            
            Monomial & operator/=(Monomial const & mon); 
        
        private:
            short _deg;                
            uint8_t *_varlist;           
            static int NB_VARIABLE;   
            static std::string const * VARS; 
            static int * WEIGHT; 
            static std::vector<int *> NB_MONOMIAL;
            static short MAX_DEGREE; 
    };
    
    /* External operators */
    
    std::ostream & operator<<(std::ostream & stream, Monomial const & mon);
    
    bool operator==(Monomial const & mon1, Monomial const & mon2);
    
    bool operator>(Monomial const & mon1, Monomial const & mon2);
    
    bool operator>=(Monomial const & mon1, Monomial const & mon2);
    
    bool operator<(Monomial const & mon1, Monomial const & mon2);
    
    bool operator<=(Monomial const & mon1, Monomial const & mon2);
}

#include "../src/monomial.inl"
#endif // OPENF4_MONOMIAL_H