element-prime.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_ELEMENT_PRIME_H
#define OPENF4_ELEMENT_PRIME_H

#include "global.h"
#include <iostream>
#include <string.h>
#include <cassert>
#include <cmath>
namespace F4
{
    template <typename baseType>
    class ElementPrime
    {
        public:
            
            /* static methods */
            
            static void setModulo(baseType modulo);
            
            static baseType getModulo();
            
            static baseType getMax();
            
            
            /* No constructor because POD */
            
            /* No Destructor because POD */
            
            
            /* Miscellaneous */
            
            baseType modulo ();
            
            baseType getElement ();
            
            ElementPrime<baseType> & addMult(ElementPrime<baseType> const & element, ElementPrime<baseType> const & mult);
            
            ElementPrime<baseType> & inverse();
            
            void printElementPrime (std::ostream & stream) const;
            
            bool isZero() const;
            
            bool isOne() const;
            
            void setZero();
            
            void setOne();
            
            
            /* Internal operators */
            
            ElementPrime & operator=(baseType element);
            
            ElementPrime & operator*=(ElementPrime const & mult); 
            
            
            /* Public attribute because POD */
            
            baseType _element; 
            static baseType MODULO; 
            static baseType MAX; 
    };
    
    
    /* External operators */
    
    template <typename baseType>
    std::ostream & operator<<(std::ostream & stream, ElementPrime<baseType> const & element);
    
    template <typename baseType>
    ElementPrime<baseType> operator * (ElementPrime<baseType> const & element1, ElementPrime<baseType> const & element2);
    
    template <typename baseType>
    ElementPrime<baseType> operator - (ElementPrime<baseType> const & element);
}

#include "../src/element-prime.inl"
#endif // OPENF4_ELEMENT_PRIME_H