/shared/development/google_code/rssoft/library/lib/GFq_BivariateMonomial.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

 Bivariate monomials with coefficient in GF(2^m) class

 */
#ifndef __GFQ_BIVARIATE_MONOMIAL_H__
#define __GFQ_BIVARIATE_MONOMIAL_H__

#include <GFq_Element.h>
#include <utility>

namespace rssoft
{
namespace gf
{

class GFq_BivariateMonomialExponents : public std::pair<unsigned int, unsigned int>
{
public:
        GFq_BivariateMonomialExponents(unsigned int eX, unsigned int eY);
        GFq_BivariateMonomialExponents(const std::pair<unsigned int, unsigned int>& _exponents);

        unsigned int x() const
        {
                return first;
        }

        unsigned int y() const
        {
                return second;
        }

        unsigned int wdeg(unsigned int wX, unsigned int wY) const
        {
                return wX*first + wY*second;
        }

        unsigned int wdeg(const std::pair<unsigned int, unsigned int>& weights) const
        {
                return weights.first*first + weights.second*second;
        }

        bool are_zero() const
        {
                return (first == 0) && (second == 0);
        }
};

typedef std::pair<GFq_BivariateMonomialExponents, GFq_Element> GFq_BivariateMonomialKeyValueRepresentation;

class GFq_BivariateMonomial : public std::pair<GFq_BivariateMonomialExponents, GFq_Element>
{
public:
        GFq_BivariateMonomial(const GFq_Element& coeff, unsigned int eX, unsigned int eY);
        GFq_BivariateMonomial(const GFq_Element& coeff, const GFq_BivariateMonomialExponents& exponents);
        GFq_BivariateMonomial(const GFq_BivariateMonomialKeyValueRepresentation& monomial_rep);

        const GFq_Element& coeff() const
        {
                return second;
        }

        unsigned int eX() const
        {
                return first.first;
        }

        unsigned int eY() const
        {
                return first.second;
        }

        const GFq_BivariateMonomialExponents& get_exponents() const
        {
                return first;
        }

        unsigned int wdeg(unsigned int wX, unsigned int wY) const
        {
                return first.wdeg(wX, wY);
        }

        unsigned int wdeg(const std::pair<unsigned int, unsigned int>& weights) const
        {
                return first.wdeg(weights);
        }

        GFq_BivariateMonomial& operator =(const GFq_BivariateMonomial& monomial);
        GFq_BivariateMonomial& operator+=(const GFq_BivariateMonomial& monomial);
        GFq_BivariateMonomial& operator+=(const GFq_Element& gfe);
        GFq_BivariateMonomial& operator-=(const GFq_BivariateMonomial& monomial);
        GFq_BivariateMonomial& operator-=(const GFq_Element& gfe);
        GFq_BivariateMonomial& operator*=(const GFq_BivariateMonomial& monomial);
        GFq_BivariateMonomial& operator*=(const GFq_Element& gfe);
        GFq_BivariateMonomial& operator/=(const GFq_BivariateMonomial& monomial);
        GFq_BivariateMonomial& operator/=(const GFq_Element& gfe);
};

GFq_BivariateMonomial operator +(const GFq_BivariateMonomial& a, const GFq_BivariateMonomial& b);
GFq_BivariateMonomial operator +(const GFq_BivariateMonomial& a, const GFq_Element& b);
GFq_BivariateMonomial operator +(const GFq_Element& a, const GFq_BivariateMonomial& b);
GFq_BivariateMonomial operator -(const GFq_BivariateMonomial& a, const GFq_BivariateMonomial& b);
GFq_BivariateMonomial operator -(const GFq_BivariateMonomial& a, const GFq_Element& b);
GFq_BivariateMonomial operator -(const GFq_Element& a, const GFq_BivariateMonomial& b);
GFq_BivariateMonomial operator *(const GFq_BivariateMonomial& a, const GFq_BivariateMonomial& b);
GFq_BivariateMonomial operator *(const GFq_Element& a, const GFq_BivariateMonomial& b);
GFq_BivariateMonomial operator *(const GFq_BivariateMonomial& a, const GFq_Element& b);
GFq_BivariateMonomial operator /(const GFq_BivariateMonomial& a, const GFq_BivariateMonomial& b);
GFq_BivariateMonomial operator /(const GFq_BivariateMonomial& a, const GFq_Element& b);

std::ostream& operator <<(std::ostream& os, const GFq_BivariateMonomialKeyValueRepresentation& monomial);

GFq_BivariateMonomialKeyValueRepresentation make_bivariate_monomial(GFq_Element coeff, unsigned int exp_x, unsigned int exp_y);

class GFq_WeightedRevLex_BivariateMonomial
{
public:
        GFq_WeightedRevLex_BivariateMonomial(unsigned int w_x, unsigned int w_y);

        GFq_WeightedRevLex_BivariateMonomial(const std::pair<unsigned int, unsigned int>& weights);

        bool operator()(const GFq_BivariateMonomialExponents& e1, const GFq_BivariateMonomialExponents& e2) const;

        ~GFq_WeightedRevLex_BivariateMonomial();

protected:
        std::pair<unsigned int, unsigned int> weights;
};

} // namespace gf
} // namespace rssoft

#endif // __GFQ_BIVARIATE_MONOMIAL_H__