/shared/development/google_code/rssoft/library/lib/GF2_Polynomial.h

Go to the documentation of this file.

/*
     Copyright 2013 Edouard Griffiths <f4exb at free dot fr>

     This file is part of RSSoft. A Reed-Solomon Soft Decoding library

     This program 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 2 of the License, or
     (at your option) any later version.

     This program 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 this program; if not, write to the Free Software
     Foundation, Inc., 51 Franklin Street, Boston, MA  02110-1301  USA

         Original from Arash Partow (see original copytight notice).
         Modified and included in RSSoft in gf sub-namespace.

         Univariate polynomials with coefficients in GF(2) class hence
         members of GF(2)[X]

*/

#ifndef __GF2_POLYNOMIAL_H__
#define __GF2_POLYNOMIAL_H__

#include "GF2_Element.h"
#include <iostream>
#include <vector>
#include <utility>
#include <assert.h>

namespace rssoft
{
namespace gf
{

class GF2_Polynomial
{
public:
        GF2_Polynomial();

        GF2_Polynomial(unsigned int size, GF2_Element* gfe);

        GF2_Polynomial(const GF2_Polynomial& polynomial);

        GF2_Polynomial(const GF2_Element& gfe);

        GF2_Polynomial(unsigned int n);

        ~GF2_Polynomial()
        {};

        bool valid() const;

        bool null() const;

        unsigned int deg() const;

        const std::vector<GF2_Element>& get_poly() const;

        std::vector<GF2_Element>& get_poly_for_update();

        void set_degree(unsigned int x);

        GF2_Polynomial& operator =(const GF2_Polynomial& polynomial);
        GF2_Polynomial& operator =(const GF2_Element& gfe);
        GF2_Polynomial& operator+=(const GF2_Polynomial& polynomial);
        GF2_Polynomial& operator+=(const GF2_Element& gfe);
        GF2_Polynomial& operator-=(const GF2_Polynomial& polynomial);
        GF2_Polynomial& operator-=(const GF2_Element& gfe);
        GF2_Polynomial& operator*=(const GF2_Polynomial& polynomial);
        GF2_Polynomial& operator*=(const GF2_Element& gfe);
        GF2_Polynomial& operator/=(const GF2_Polynomial& divisor);
        GF2_Polynomial& operator/=(const GF2_Element& gfe);
        GF2_Polynomial& operator%=(const GF2_Polynomial& divisor);
        GF2_Polynomial& operator%=(const unsigned int& power);
        GF2_Polynomial& operator^=(const int& n);
        GF2_Polynomial& operator<<=(const unsigned int& n);
        GF2_Polynomial& operator>>=(const unsigned int& n);

        GF2_Element& operator[](unsigned int term);
        GF2_Element operator()(GF2_Element value);

        const GF2_Element& operator[](unsigned int term) const;
        const GF2_Element operator()(GF2_Element value) const;

        bool operator==(const GF2_Polynomial& polynomial) const;
        bool operator!=(const GF2_Polynomial& polynomial) const;

        friend std::ostream& operator <<(std::ostream& os, const GF2_Polynomial& polynomial);

private:
        std::vector<GF2_Element> poly; 
};

void simplify(GF2_Polynomial& polynomial);
GF2_Polynomial operator +(const GF2_Polynomial& a, const GF2_Polynomial& b);
GF2_Polynomial operator +(const GF2_Polynomial& a, const GF2_Element& b);
GF2_Polynomial operator +(const GF2_Element& a, const GF2_Polynomial& b);
GF2_Polynomial operator -(const GF2_Polynomial& a, const GF2_Polynomial& b);
GF2_Polynomial operator -(const GF2_Polynomial& a, const GF2_Element& b);
GF2_Polynomial operator -(const GF2_Element& a, const GF2_Polynomial& b);
GF2_Polynomial operator *(const GF2_Polynomial& a, const GF2_Polynomial& b);
GF2_Polynomial operator *(const GF2_Element& a, const GF2_Polynomial& b);
GF2_Polynomial operator *(const GF2_Polynomial& a, const GF2_Element& b);
GF2_Polynomial operator /(const GF2_Polynomial& a, const GF2_Polynomial& b);
GF2_Polynomial operator /(const GF2_Polynomial& a, const GF2_Element& b);
GF2_Polynomial operator %(const GF2_Polynomial& a, const GF2_Polynomial& b);
GF2_Polynomial operator %(const GF2_Polynomial& a, const unsigned int& power);
GF2_Polynomial operator ^(const GF2_Polynomial& a, const int& n);

GF2_Polynomial operator <<(const GF2_Polynomial& a, const unsigned int& n);

GF2_Polynomial operator >>(const GF2_Polynomial& a, const unsigned int& n);

GF2_Polynomial gcd(const GF2_Polynomial& a, const GF2_Polynomial& b);

std::pair<GF2_Polynomial, GF2_Polynomial> div(const GF2_Polynomial& a,
                const GF2_Polynomial& b);

bool irreducible(const GF2_Polynomial& a);

unsigned int coeff_parity(const GF2_Polynomial& a);

bool primitive(const GF2_Polynomial& a, unsigned int m);


} // namespace gf
} // namespace rssoft

#endif // __GF2_POLYNOMIAL_H__