commutation.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 COMMUTATION_H_INCLUDED
#define COMMUTATION_H_INCLUDED

#include "scalarFunc.h"

namespace csl {

Expr Commutation(const Expr& A, const Expr& B, int sign=-1);

Expr Commutation(Expr_info A, Expr_info B, int sign=-1);

Expr WeakCommutation(const Expr& A, const Expr& B, int sign=-1);

Expr WeakCommutation(Expr_info A, Expr_info B, int sign=-1);

class Commutator: public AbstractDuoFunc{

    protected:

    int sign;

    public:

    Commutator();

    Commutator(const Expr& A, const Expr& B, int t_sign=-1);

    ~Commutator(){};

    csl::Type getType() const override; 

    int getSign() const override;
                                                                              
    void print(int mode=0,
               std::ostream& out=std::cout,
               bool lib = false) const override;
                                                                              
    std::string printLaTeX(int mode=0) const override;
                                                                              
    long double evaluateScalar() const override;
                                                                              
    std::optional<Expr> evaluate(
            csl::eval::mode user_mode = csl::eval::base
            ) const override;

    unique_Expr copy_unique() const override;

    Expr deepCopy() const override;

    Expr refresh() const override;

    Expr deepRefresh() const override;
                                                                              
    std::optional<Expr> derive(Expr_info expr) const override;
                                                                              
    int getParity(Expr_info t_variable) const override;
    
    bool operator==(Expr_info expr) const override;

    bool operator<(const Abstract* expr) const override;
};

Expr commutator_(const Expr& A, const Expr& B, int t_sign=-1);
} // End of namespace csl

#endif