special_number.hpp

Go to the documentation of this file.

//This file is part of Bertini 2.
//
//special_number.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.
//
//special_number.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 special_number.hpp.  If not, see <http://www.gnu.org/licenses/>.
//
// Copyright(C) 2015 - 2023 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.
//
//
// special_number.hpp:  Declares the class SpecialNumber.

 
#ifndef BERTINI_FUNCTION_TREE_SPECIAL_NUMBER_HPP
#define BERTINI_FUNCTION_TREE_SPECIAL_NUMBER_HPP
 
 
#include "bertini2/function_tree/symbols/number.hpp"
 
#include <cmath>
 
 
 
namespace bertini {
namespace node{
    using ::acos;
    using ::exp;
 
    
    namespace special_number{

        class Pi : public virtual Number, public virtual NamedSymbol, public virtual EnableSharedFromThisVirtual<Pi>
        {
        public:
            BERTINI_DEFAULT_VISITABLE()
 
            virtual ~Pi() = default;
 
            template<typename... Ts> 
            static 
            std::shared_ptr<Pi> Make(Ts&& ...ts){ 
                return std::shared_ptr<Pi>( new Pi(ts...) );
            }
 
 
        private:
 
            Pi() : NamedSymbol("pi")
            {}
 
            // Return value of constant
            dbl FreshEval_d(std::shared_ptr<Variable> const& diff_variable) const override;
            
            void FreshEval_d(dbl& evaluation_value, std::shared_ptr<Variable> const& diff_variable) const override;
 
 
            mpfr_complex FreshEval_mp(std::shared_ptr<Variable> const& diff_variable) const override;
            
            void FreshEval_mp(mpfr_complex& evaluation_value, std::shared_ptr<Variable> const& diff_variable) const override;
 
 
            friend class boost::serialization::access;
 
            template <typename Archive>
            void serialize(Archive& ar, const unsigned version) {
                ar & boost::serialization::base_object<Number>(*this);
                ar & boost::serialization::base_object<NamedSymbol>(*this);
            }
        };
 
 

        class E : public virtual Number, public virtual NamedSymbol, public virtual EnableSharedFromThisVirtual<E>
        {
        public:
            BERTINI_DEFAULT_VISITABLE()
            
 
 
            virtual ~E() = default;
 
 
            template<typename... Ts> 
            static 
            std::shared_ptr<E> Make(Ts&& ...ts){ 
                return std::shared_ptr<E>( new E(ts...) );
            }
 
 
        private:
 
            E() : NamedSymbol("e")
            {}
 
            
            // Return value of constant
            dbl FreshEval_d(std::shared_ptr<Variable> const& diff_variable) const override;
            
            void FreshEval_d(dbl& evaluation_value, std::shared_ptr<Variable> const& diff_variable) const override;
 
 
            mpfr_complex FreshEval_mp(std::shared_ptr<Variable> const& diff_variable) const override;
            
            void FreshEval_mp(mpfr_complex& evaluation_value, std::shared_ptr<Variable> const& diff_variable) const override;
 
 
            friend class boost::serialization::access;
 
            template <typename Archive>
            void serialize(Archive& ar, const unsigned version) {
                ar & boost::serialization::base_object<Number>(*this);
                ar & boost::serialization::base_object<NamedSymbol>(*this);
            }
 
        };
 
    } // re: special_number namespace
 

    std::shared_ptr<Node> Pi();

    std::shared_ptr<Node> E();

    std::shared_ptr<Node> I();

    std::shared_ptr<Node> Two();

    std::shared_ptr<Node> One();

    std::shared_ptr<Node> Zero();
 
 
} // re: namespace node
} // re: namespace bertini
    
#endif