single-list.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_SINGLE_LIST_H
#define OPENF4_SINGLE_LIST_H

#include "global.h"
#include <iostream>
#include <cassert>
#include "term.h"

namespace F4
{
    
    template <typename Element>
    struct NodeList
    {        
        public:
            
            /* Constructor */
            
            NodeList();
            
            NodeList(Element coefficient, int numMonomial);
            
            NodeList(Term<Element> const & term);
            
            
            /* Get / Set */
            
            Term<Element> const & getTerm() const; 
            
            int getNumMonomial() const;
            
            Element getCoefficient() const;
            
            void setCoefficient(Element element);
            
            void setCoefficientOne();
            
            void setNumMonomial(int numMonomial);
            
            /* Attributes */
        
            Term<Element> _term; 
            NodeList * _next; 
    };
    
    template <typename Element>
    class SingleList
    {        
        public:
            
            /* Constructor */
            
             SingleList();
             
             SingleList(SingleList const & toCopy);
             
             SingleList(SingleList && toCopy);
             
             
             /* Destructor */
             
             ~SingleList();
             
             void clear();
             
             void deleteAfter(NodeList<Element> * it);
             
             
             /* Miscellaneous */
             
              NodeList<Element> * getBegin() const;
             
              NodeList<Element> * getBeforeBegin();
             
              bool empty() const;
              
              int getNbTerms() const;
              
              Term<Element> const & front() const;
             
              NodeList<Element> * emplaceBegin(Element coefficient, int numMonomial);
             
              NodeList<Element> * emplaceAfter(NodeList<Element> * it, Element coefficient, int numMonomial);
              
              NodeList<Element> * emplaceOn(NodeList<Element> * it, Element coefficient, int numMonomial);
              
              NodeList<Element> * insertBegin(Term<Element> const & term);
             
              NodeList<Element> * insertAfter(NodeList<Element> * it, Term<Element> const & term);
              
              void printList(ostream & stream) const;
               
              NodeList<Element> *  popFront();
              
              
              /* Operator overload */
              
            SingleList & operator=(SingleList const & toCopy);
            
            SingleList & operator=(SingleList && toCopy);
               
             
        private:
            
            NodeList<Element> * _list; 
            NodeList<Element> * _beforeBegin; 
            int _nbTerms; 
    };
    
    template <typename Element>
    std::ostream & operator<<(std::ostream & stream, SingleList<Element> const & list);
}

#include "../src/single-list.inl"
#endif // OPENF4_SINGLE_LIST_H