operator.hpp

Go to the documentation of this file.

//This file is part of Bertini 2.
//
//operator.hpp 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.
//
//operator.hpp 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 operator.hpp.  If not, see <http://www.gnu.org/licenses/>.
//
// Copyright(C) Bertini2 Development Team
//
// See <http://www.gnu.org/licenses/> for a copy of the license,
// as well as COPYING.  Bertini2 is provided with permitted
// additional terms in the b2/licenses/ directory.
 
// operator.hpp:  Declares the class Operator.

 
#ifndef BERTINI_OPERATOR_HPP
#define BERTINI_OPERATOR_HPP
 
#include "bertini2/function_tree/node.hpp"
 
#include <vector>
 
 
namespace bertini {
namespace node{

    class Operator : public Node
    {
 
    public:
 
        virtual ~Operator() = default;
 
    private:
 
        friend class boost::serialization::access;
 
        template <typename Archive>
        void serialize(Archive& ar, const unsigned /*version*/) {
            ar & boost::serialization::base_object<Node>(*this);
        }
    };
 
 

    class UnaryOperator : public Operator
    {
    public:

        UnaryOperator(const std::shared_ptr<Node> & n) : operand_(n)
        {}
 
 
 
        virtual ~UnaryOperator() = default;
 
        // Structural hash/equality for every unary op (typeid distinguishes Sin/Cos/Exp/...);
        // IntegerPowerOperator overrides to fold in its exponent.
        std::size_t HashImpl() const override;
        bool IsSame(Node const& other) const override;
 
 

        void SetOperand(std::shared_ptr<Node> n);
 
 

        std::shared_ptr<Node> Operand() const;
 
 

        int Degree(std::shared_ptr<Variable> const& v = nullptr) const override;

        int Degree(VariableGroup const& vars) const override;
 

        std::vector<int> MultiDegreeImpl(VariableGroup const& vars) const override;
 
        bool IsHomogeneous(std::shared_ptr<Variable> const& v = nullptr) const override;
 

        bool IsHomogeneous(VariableGroup const& vars) const override;
 
 
 
 
 
 
    protected:
        //Stores the single child of the unary operator
        std::shared_ptr<Node> operand_;  
        UnaryOperator(){}
    private:
        friend class boost::serialization::access;
 
        template <typename Archive>
        void serialize(Archive& ar, const unsigned /*version*/) {
            ar & boost::serialization::base_object<Operator>(*this);
            ar & operand_;
        }
    };
 
 
 

    class NaryOperator : public Operator
    {
    public:
 
        virtual ~NaryOperator() = default;
 
 

        virtual void AddOperand(std::shared_ptr<Node> n);
 

        size_t NumOperands() const;

        inline auto const& Operands() const{
            return operands_;
        }
 

        std::shared_ptr<Node> FirstOperand() const;

 
 
 
    protected:
 
        //Stores all children for this operator node.
        //This is an NaryOperator and can have any number of children.
        std::vector< std::shared_ptr<Node> > operands_;
 
        // constructor is protected to help prevent instantiating empty operators
        NaryOperator(){}
 
    private:
 
        virtual void PrecisionChangeSpecific(unsigned prec) const;
 
 
        friend class boost::serialization::access;
 
        template <typename Archive>
        void serialize(Archive& ar, const unsigned /*version*/) {
            ar & boost::serialization::base_object<Operator>(*this);
            ar & operands_;
        }
 
    };
 
 
} // re: namespace node
} // re: namespace bertini
 
 
#endif