ginac_functions.h

Go to the documentation of this file.

 
/*
 *  JEMRIS Copyright (C) 
 *                        2006-2025  Tony Stoecker
 *                        2007-2018  Kaveh Vahedipour
 *                        2009-2019  Daniel Pflugfelder
 *                                  
 *
 *  This program 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef GINAC_FUNCTIONS_H_
#define GINAC_FUNCTIONS_H_
 
#include <ginac/ginac.h>
#include <ginac/power.h>
#include <vector>
#ifndef __MINGW32__
#include <dlfcn.h>
#endif
#include <fstream>
#include <ios>
#include <sstream>
#include <stdexcept>
#include <string>
#include <stdlib.h>
#include "config.h"
 
#if defined(_MSC_VER)
#define MKTEMP(path,n) _mktemp_s(path, n)
#elif defined(__MINGW32__)
#include <io.h>
#define MKTEMP(path,n) _mktemp(path)
#else
#ifdef HAVE_MKSTEMPS
extern "C" int mkstemps (char *path, int len);
#define MKTEMP(path,n) mkstemps(path,n)
#endif
#endif
 
using namespace std;
 
using namespace GiNaC ;
 
 
 
const symbol & get_symbol(const string & sym_name)
{
    static map<string, realsymbol> symbol_list;
    map<string, realsymbol>::iterator it = symbol_list.find(sym_name);
    if (it != symbol_list.end())
        return it->second;
    else
        return symbol_list.insert(pair<string, realsymbol>(sym_name, realsymbol(sym_name))).first->second;
}
 
 
/*
static ex sqrt(const ex &x){ return pow(x,0.5); }
static ex sqrt_evalf(const ex & x){ return (ex_to<numeric>(pow(x,0.5))).to_double(); }
static ex sqrt_deriv(const ex & x, unsigned diff_param) { return 0.5*pow(x,-0.5); }
static ex sqrt_real_part(const ex & x) { return real_part(pow(x,0.5)); }
static ex sqrt_imag_part(const ex & x) { return imag_part(pow(x,0.5)); }
static ex sqrt_conjugate(const ex & x) { return pow(x.conjugate(),0.5); }
DECLARE_FUNCTION_1P(sqrt)
REGISTER_FUNCTION(sqrt, eval_func      (sqrt_evalf    ).
                        evalf_func     (sqrt_evalf    ).
                        derivative_func(sqrt_deriv    ).
                        real_part_func (sqrt_real_part).
                        imag_part_func (sqrt_imag_part).
                        conjugate_func (sqrt_conjugate))
*/
 
static ex sinc_eval(const ex &x){
        if ( x.is_zero() )
                return 1;
        else
                return (sin(x)/x);
}
 
static ex sinc_evalf(const ex & x){
     //if (is_exactly_a<numeric>(x)) {
         double d = (ex_to<numeric>(x)).to_double();
         return ( d==0.0 ? 1 : sin(d)/d );
     //}
     //else
     //    return (sin(x)/x);
 }
 
static ex sinc_deriv(const ex & x, unsigned diff_param) {
        if ( x.is_zero() )
                return 0;
        else
        return cos(x)/x - sin(x)/(x*x);
}
 
//real(sinc(a+I*b)) = (a*cosh(b)*sin(a) + b*cos(a)*sinh(b))/(a^2 + b^2)
static ex sinc_real_part(const ex & x)
{
        if ( x.is_zero() )
                return 1;
        else
        return ( ( ( real_part(x)*cosh(imag_part(x))*sin(real_part(x)) ) +
                           ( imag_part(x)*sinh(imag_part(x))*cos(real_part(x)) ) ) /
                           ( pow(real_part(x),2) + pow(imag_part(x),2) ) );
}
 
//imag(sinc(a+I*b)) = (a*cos(a)*sinh(b) - b*cosh(b)*sin(a))/(a^2 + b^2)
static ex sinc_imag_part(const ex & x)
{
        if ( x.is_zero() )
                return 0;
        else
        return ( ( ( real_part(x)*sinh(imag_part(x))*cos(real_part(x)) ) -
                           ( imag_part(x)*cosh(imag_part(x))*sin(real_part(x)) ) ) /
                           ( pow(real_part(x),2) + pow(imag_part(x),2) ) );
}
 
static ex sinc_conjugate(const ex & x) {
        if ( x.is_zero() )
                return 1;
        else
        return sin(x.conjugate())/x.conjugate();
}
 
DECLARE_FUNCTION_1P(sinc)
REGISTER_FUNCTION(sinc, eval_func      (sinc_eval     ).
                        evalf_func     (sinc_evalf    ).
                        derivative_func(sinc_deriv    ).
                        real_part_func (sinc_real_part).
                        imag_part_func (sinc_imag_part).
                        conjugate_func (sinc_conjugate))
 
 
static ex floor_evalf(const ex &x){
        if (!is_a<numeric>(x) ) return x;
        ex xn = ex_to<numeric>(x);
        return ((int) ex_to<numeric>(xn).to_double()  );
}
DECLARE_FUNCTION_1P(floor)
REGISTER_FUNCTION(floor, evalf_func(floor_evalf))
 
 
static ex mod_evalf(const ex &x, const ex &y){
        if (!is_a<numeric>(x) || !is_a<numeric>(y)) return 0;
        ex xn = ex_to<numeric>(x);
        ex yn = ex_to<numeric>(y);
        return (xn - floor_evalf(xn/yn)*yn);
}
DECLARE_FUNCTION_2P(mod)
REGISTER_FUNCTION(mod, evalf_func(mod_evalf))
 
 
static ex equal_evalf(const ex &x, const ex &y){
        if (!is_a<numeric>(x) || !is_a<numeric>(y)) return 0;
        ex xn = ex_to<numeric>(x);
        ex yn = ex_to<numeric>(y);
        int b = ((int) (        ex_to<numeric>(xn).to_double()
                        ==      ex_to<numeric>(yn).to_double() ) );
        return b;
}
DECLARE_FUNCTION_2P(equal)
REGISTER_FUNCTION(equal, evalf_func(equal_evalf))
 
 
static ex gt_evalf(const ex &x, const ex &y){
        if (!is_a<numeric>(x) || !is_a<numeric>(y)) return 0;
        ex xn = ex_to<numeric>(x);
        ex yn = ex_to<numeric>(y);
        int b = ((int) (        ex_to<numeric>(xn).to_double()
                        >       ex_to<numeric>(yn).to_double() ) );
        return b;
}
DECLARE_FUNCTION_2P(gt)
REGISTER_FUNCTION(gt, evalf_func(gt_evalf))
 
 
static ex lt_evalf(const ex &x, const ex &y){
        if (!is_a<numeric>(x) || !is_a<numeric>(y)) return 0;
        ex xn = ex_to<numeric>(x);
        ex yn = ex_to<numeric>(y);
        int b = ((int) (        ex_to<numeric>(xn).to_double()
                        <       ex_to<numeric>(yn).to_double() ) );
        return b;
}
DECLARE_FUNCTION_2P(lt)
REGISTER_FUNCTION(lt, evalf_func(lt_evalf))
 
 
static ex ite_evalf(const ex &a, const ex &b, const ex &x, const ex &y){
        if (!is_a<numeric>(x) || !is_a<numeric>(y)) return 0;
        ex xn = ex_to<numeric>(x);
        ex yn = ex_to<numeric>(y);
        if ( equal_evalf(a,b)==1 ) return xn;
        else                       return yn;
}
DECLARE_FUNCTION_4P(ite)
REGISTER_FUNCTION(ite, evalf_func(ite_evalf))
 
 
 
static vector<double>* m_static_vector;
static ex Vector_evalf(const ex &i){
        if (!is_a<numeric>(i) ) return 0;
        unsigned int in = ((int) ex_to<numeric>(i).to_double() );
        if ( (*m_static_vector).size() > in )
                return (*m_static_vector).at(in);
        else
                return 0.0;
}
DECLARE_FUNCTION_1P(Vector)
REGISTER_FUNCTION(Vector, evalf_func(Vector_evalf))
 
 
 
/* copy-paste of the GiNaC excompiler helper class (Removed all comments; see GiNaC sources for more info) */
class excompiler
{
        struct filedesc
        {
                void* module;
                std::string name;
                bool clean_up;
        };
        std::vector<filedesc> filelist;
public:
        ~excompiler()
        {
                for (std::vector<filedesc>::const_iterator it = filelist.begin(); it != filelist.end(); ++it) {
                        clean_up(it);
                }
        }
        void add_opened_module(void* module, const std::string& name, bool clean_up)
        {
                filedesc fd;
                fd.module = module;
                fd.name = name;
                fd.clean_up = clean_up;
                filelist.push_back(fd);
        }
        void clean_up(const std::vector<filedesc>::const_iterator it)
        {
#ifndef __MINGW32__
                dlclose(it->module);
#endif
                if (it->clean_up) {
                        remove(it->name.c_str());
                }
        }
        void create_src_file(std::string& filename, std::ofstream& ofs)
        {
#ifndef __MINGW32__
                if (filename.empty()) {
                        const char* filename_pattern = "./GiNaCXXXXXX";
                        char* new_filename = new char[strlen(filename_pattern)+1];
                        strcpy(new_filename, filename_pattern);
                        #ifndef HAVE_MKSTEMPS
                        if (!mkstemp(new_filename)) {
                                delete[] new_filename;
                                throw std::runtime_error("mktemp failed");
                        }
                        #else
                        if (!MKTEMP(new_filename, 0)) {
                                delete[] new_filename;
                                throw std::runtime_error("mktemps failed");
                        }
                        #endif
                        filename = std::string(new_filename);
                        ofs.open(new_filename, std::ios::out);
                        delete[] new_filename;
                } else {
                        ofs.open(filename.c_str(), std::ios::out);
                }
 
                if (!ofs) {
                        throw std::runtime_error("could not create source code file for compilation");
                }
 
                ofs << "#include <stddef.h> " << std::endl;
                ofs << "#include <stdlib.h> " << std::endl;
                ofs << "#include <math.h> " << std::endl;
                ofs << std::endl;
#endif
        }
        void compile_src_file(const std::string filename, bool clean_up)
        {
                std::string strcompile = "ginac-excompiler " + filename;
                if (system(strcompile.c_str())) {
                        throw std::runtime_error("excompiler::compile_src_file: error compiling source file!");
                }
                if (clean_up) {
                        remove(filename.c_str());
                }
        }
        void* link_so_file(const std::string filename, bool clean_up)
        {
                void* module = NULL;
#ifndef __MINGW32__
                module = dlopen(filename.c_str(), RTLD_NOW);
#endif
                if (module == NULL)     {
                        throw std::runtime_error("excompiler::link_so_file: could not open compiled module!");
                }
 
                add_opened_module(module, filename, clean_up);
 
#ifndef __MINGW32__
                return dlsym(module, "compiled_ex");
#endif
        }
        void unlink(const std::string filename)
        {
                for (std::vector<filedesc>::iterator it = filelist.begin(); it != filelist.end();) {
                        if (it->name == filename) {
                                clean_up(it);
                                it = filelist.erase(it);
                        } else {
                                ++it;
                        }
                }
        }
};
 
typedef double (*FUNCP_4P) (double, double, double, double);
static excompiler global_excompiler;
void compile_ex(const ex& expr, const symbol& sym1, const symbol& sym2, const symbol& sym3, const symbol& sym4,
                        FUNCP_4P& fp, const std::string filename = "") {
 
        symbol x("x"), y("y"), z("z"), g("g");
  std::initializer_list<ex> vec = {sym1==x, sym2==y, sym3==z, sym4==g};
        ex expr_with_xyzg = expr.subs(lst(vec));
 
        std::ofstream ofs;
        std::string unique_filename = filename;
        global_excompiler.create_src_file(unique_filename, ofs);
 
        ofs << "double compiled_ex(double x, double y, double z, double g)" << std::endl;
        ofs << "{" << std::endl;
        ofs << "double res = ";
        expr_with_xyzg.print(GiNaC::print_csrc_double(ofs));
        ofs << ";" << std::endl;
        ofs << "return(res); " << std::endl;
        ofs << "}" << std::endl;
 
        ofs.close();
 
        global_excompiler.compile_src_file(unique_filename, filename.empty());
        fp = (FUNCP_4P) global_excompiler.link_so_file(unique_filename+".so", filename.empty());
}
 
 
#endif