MelementaryPermutation.h

Go to the documentation of this file.

/*
Copyright 2017 Laurent Claessens
contact : laurent@claessens-donadello.eu

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 3 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, see <http://www.gnu.org/licenses/>.
*/

#ifndef __MELEMENTARYPERMUTATION_H_095019_
#define __MELEMENTARYPERMUTATION_H_095019_

#include "../Utilities.h"
#include "MgenericPermutation.h"

template <unsigned int tp_size>
class Mpermutation;

template <unsigned int tp_size>
class MelementaryPermutation : public MgenericPermutation<tp_size>
{
    template <unsigned int s>
    friend std::ostream& operator<<(std::ostream&, MelementaryPermutation<s>);

    private:
        const unsigned int data_elA; 
        const unsigned int data_elB;

    public :
        MelementaryPermutation(const unsigned int A,const unsigned int B); 

        unsigned int getA() const;
        unsigned int getB() const;

        unsigned int image(const unsigned int k) const override;

};

// GETTER/SETTER METHODS ---------------------------------

template <unsigned int tp_size>
unsigned int MelementaryPermutation<tp_size>::getA() const
{
    return data_elA;
}

template <unsigned int tp_size>
unsigned int MelementaryPermutation<tp_size>::getB() const
{
    return data_elB;
}

// OPERATORS ---------------------------------

template <unsigned int s>
std::ostream& operator<<(std::ostream& stream, MelementaryPermutation<s> perm)
{
    stream<<perm.getA()<<" <--> "<<perm.getB();
    return stream;
}

// ACTION ON THE INTEGERS ---------------------------------

template <unsigned int tp_size>
MelementaryPermutation<tp_size>::MelementaryPermutation(const unsigned int A,const unsigned int B) :
    data_elA(A),
    data_elB(B)
{
    if (getA() > tp_size or getB() > tp_size)
    {
        throw OutOfRangeConstructionElementaryPermutationException(A,B,tp_size);
    }
}
    
template <unsigned int tp_size>
unsigned int MelementaryPermutation<tp_size>::image(const unsigned int k) const
{
    if (k>tp_size)
    {
        throw PermutationIdexoutOfRangeException(k,tp_size);
    }
    if (k==getA())
    {
        return getB();
    }
    if (k==getB())
    {
        return getA();
    }
    return k;
}

#endif