3 * Functions to facilitate the conversion of a ex to a function pointer suited for
4 * fast numerical integration. */
7 * GiNaC Copyright (C) 1999-2024 Johannes Gutenberg University Mainz, Germany
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #ifndef GINAC_EXCOMPILER_H
25 #define GINAC_EXCOMPILER_H
37 * Function pointer with one function parameter.
39 typedef double (*FUNCP_1P) (double);
42 * Function pointer with two function parameters.
44 typedef double (*FUNCP_2P) (double, double);
47 * Function pointer for use with the CUBA library (http://www.feynarts.de/cuba).
49 typedef void (*FUNCP_CUBA) (const int*, const double[], const int*, double[]);
52 * Takes an expression and produces a function pointer to the compiled and linked
53 * C code equivalent in double precision. The function pointer has type FUNCP_1P.
55 * @param expr Expression to be compiled
56 * @param sym Symbol from the expression to become the function parameter
57 * @param fp Returned function pointer
58 * @param filename Name of the intermediate source code and so-file. If
59 * supplied, these intermediate files will not be deleted
61 void compile_ex(const ex& expr, const symbol& sym, FUNCP_1P& fp, const std::string filename = "");
64 * Takes an expression and produces a function pointer to the compiled and linked
65 * C code equivalent in double precision. The function pointer has type FUNCP_2P.
67 * @param expr Expression to be compiled
68 * @param sym1 Symbol from the expression to become the first function parameter
69 * @param sym2 Symbol from the expression to become the second function parameter
70 * @param fp Returned function pointer
71 * @param filename Name of the intermediate source code and so-file. If
72 * supplied, these intermediate files will not be deleted
74 void compile_ex(const ex& expr, const symbol& sym1, const symbol& sym2, FUNCP_2P& fp, const std::string filename = "");
77 * Takes an expression and produces a function pointer to the compiled and linked
78 * C code equivalent in double precision. The function pointer has type FUNCP_CUBA.
80 * @param exprs List of expression to be compiled
81 * @param syms Symbols from the expression to become the function parameters
82 * @param fp Returned function pointer
83 * @param filename Name of the intermediate source code and so-file. If
84 * supplied, these intermediate files will not be deleted
86 void compile_ex(const lst& exprs, const lst& syms, FUNCP_CUBA& fp, const std::string filename = "");
89 * Opens an existing so-file and returns a function pointer of type FUNCP_1P to
90 * the contained function. The so-file has to be generated by compile_ex in
93 * @param filename Name of the so-file to open and link
94 * @param fp Returned function pointer
96 void link_ex(const std::string filename, FUNCP_1P& fp);
99 * Opens an existing so-file and returns a function pointer of type FUNCP_2P to
100 * the contained function. The so-file has to be generated by compile_ex in
103 * @param filename Name of the so-file to open and link
104 * @param fp Returned function pointer
106 void link_ex(const std::string filename, FUNCP_2P& fp);
109 * Opens an existing so-file and returns a function pointer of type FUNCP_CUBA to
110 * the contained function. The so-file has to be generated by compile_ex in
113 * @param filename Name of the so-file to open and link
114 * @param fp Returned function pointer
116 void link_ex(const std::string filename, FUNCP_CUBA& fp);
119 * Closes all linked .so files that have the supplied filename.
121 * @param filename Name of the so-file to close
123 void unlink_ex(const std::string filename);
127 #endif // ndef GINAC_EXCOMPILER_H