critical-pair.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_CRITICAL_PAIR_H
#define OPENF4_CRITICAL_PAIR_H

#include "global.h"
#include "tagged-polynomial.h"

namespace F4
{
    template <typename Element>
    class CriticalPair
    {
        public:
            
            /* Static methods */
            
            static void setTaggedPolynomialArray(vector<TaggedPolynomial<Element>> * taggedPolynomialArray);
            
            static TaggedPolynomial<Element> const &  getTaggedPolynomialArray(int numTaggedPolynomial);
            
            static int getSizeTaggedPolynomialArray();
            
            static void setMonomialArray(MonomialArray * monomialArray);
          
            
            
            /* Constructor */
            
            CriticalPair();
            
            CriticalPair(int p1, int p2);
            
            CriticalPair(CriticalPair const & cp);
            
            
            /* Destructor */
            
            ~CriticalPair();
            
            
            /* Get / Set */
            
            int getP1() const;
            
            int getP2() const;
            
            Monomial const & getLcm() const;
            
            Monomial const & getU1() const;
            
            Monomial const & getU2() const;
            
            int getDegree() const;
            
            bool setCriticalPair(int p1, int p2);
            
            
            /* Miscellaneous */
            
            void printCriticalPair (std::ostream & stream = std::cout) const;
            
            int compareCriticalPair (CriticalPair const & criticalPair) const;
            
            
            /* Internal operator */
            
            CriticalPair & operator=(CriticalPair const & criticalPair);
        
        private:
            Monomial _lcm;          
            Monomial _u1;           
            int _p1;                
            Monomial _u2;           
            int _p2;                
            static std::vector<TaggedPolynomial<Element>> * TAGGEG_POLYNOMIAL_ARRAY; 
            static MonomialArray * MONOMIAL_ARRAY; 
    };
    
    
    /* External operator */
    template <typename Element>
    std::ostream & operator<<(std::ostream & stream, CriticalPair<Element> const & criticalPair);
    
    template <typename Element>
    bool operator==(CriticalPair<Element> const & criticalPair1, CriticalPair<Element> const & criticalPair2);
    
    template <typename Element>
    bool operator>(CriticalPair<Element> const & criticalPair1, CriticalPair<Element> const & criticalPair2);
    
    template <typename Element>
    bool operator>=(CriticalPair<Element> const & criticalPair1, CriticalPair<Element> const & criticalPair2);
    
    template <typename Element>
    bool operator<(CriticalPair<Element> const & criticalPair1, CriticalPair<Element> const & criticalPair2);
    
    template <typename Element>
    bool operator<=(CriticalPair<Element> const & criticalPair1, CriticalPair<Element> const & criticalPair2);
}

#include "../src/critical-pair.inl"
#endif // OPENF4_CRITICAL_PAIR_H