quantumNumber.h

Go to the documentation of this file.

// This file is part of MARTY.
// 
// MARTY 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.
// 
// MARTY 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 MARTY. If not, see <https://www.gnu.org/licenses/>.

#ifndef QUANTUM_NUMBER_H_INCLUDED
#define QUANTUM_NUMBER_H_INCLUDED

#include <map>
#include <string>
#include <vector>


namespace mty {

class QuantumField;

class QuantumNumber {

    public:

    using ID    = unsigned short;
    using Value = int;

    private:

    static inline ID current_id = 0;

    bool   conserved;

    ID     id;

    private:

    static inline std::map<ID, std::string>& name() {
        static std::map<ID, std::string> m;
        return m;
    }

    public:

    explicit
    QuantumNumber(std::string const& t_name,
                  bool               t_conserved = true);

    QuantumNumber(QuantumNumber const&) = default;
    QuantumNumber& operator=(QuantumNumber const&) = default;

    ~QuantumNumber();

    bool isConserved() const;

    std::string getName() const;

    void setConservedProperty(bool t_conserved);

    void setName(std::string const& t_name);

    bool appearsIn(std::vector<mty::QuantumField> const& fields) const;

    int computeQuantumNumber(std::vector<mty::QuantumField> const& field) const;

    inline ID getID() const {
        return id;
    }

    inline bool operator==(QuantumNumber const& other) const {
        return id == other.id;
    }

    inline bool operator!=(QuantumNumber const& other) const {
        return id != other.id;
    }
};

}

#endif