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) 2015 - 2021 by 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.
 
// individual authors of this file include:
//  James Collins
//  West Texas A&M University
//  Spring, Summer 2015
//
// silviana amethyst, university of wisconsin-eau claire
//
//  Created by Collins, James B. on 4/30/15.
//
//
// 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 virtual 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 virtual Operator
    {
    public:
        
        UnaryOperator(const std::shared_ptr<Node> & n) : operand_(n)
        {}
        
        
        
        virtual ~UnaryOperator() = default;
        
        
        void Reset() const override;
        
        
        void SetOperand(std::shared_ptr<Node> n);
        
        
        
        //Return the only child for the unary operator
        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> MultiDegree(VariableGroup const& vars) const override;
 
 
        void Homogenize(VariableGroup const& vars, std::shared_ptr<Variable> const& homvar) override;
 
        
        bool IsHomogeneous(std::shared_ptr<Variable> const& v = nullptr) const override;
        
        
        bool IsHomogeneous(VariableGroup const& vars) const override;
        
 

        void precision(unsigned int prec) 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 virtual Operator
    {
    public:
        
        virtual ~NaryOperator() = default;
        
        
        void Reset() const override;
        
        // Add an operand onto the container for this operator
        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;
        
        void precision(unsigned int prec) const override;
 
        
        
    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