Finalize 1.7.6 release.

[ginac.git] / ginac / excompiler.h

diff --git a/ginac/excompiler.h b/ginac/excompiler.h
index 56c870e14b813b4190ecbce2ba897926a12d1b4b..0baf9ffd47ea8eb2d3465c68ca759408d581690b 100644 (file)
--- a/ginac/excompiler.h
+++ b/ginac/excompiler.h
@@ -1,10 +1,10 @@
 /** @file excompiler.h
  *
- *  Class to facilitate the conversion of a ex to a function pointer suited for
+ *  Functions to facilitate the conversion of a ex to a function pointer suited for
  *  fast numerical integration. */
 
 /*
- *  GiNaC Copyright (C) 1999-2006 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2019 Johannes Gutenberg University Mainz, Germany
  *
  *  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
@@ -21,24 +21,106 @@
  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#ifndef __GINAC_EXCOMPILER_H__
-#define __GINAC_EXCOMPILER_H__
+#ifndef GINAC_EXCOMPILER_H
+#define GINAC_EXCOMPILER_H
 
-#include "basic.h"
-#include "ex.h"
+#include "lst.h"
+
+#include <string>
 
 namespace GiNaC {
 
+class ex;
+class symbol;
+
+/**
+ * Function pointer with one function parameter.
+ */
+typedef double (*FUNCP_1P) (double);
+
+/**
+ * Function pointer with two function parameters.
+ */
+typedef double (*FUNCP_2P) (double, double);
 
-typedef double (*FP_dim1) (double);
+/**
+ * Function pointer for use with the CUBA library (http://www.feynarts.de/cuba).
+ */
+typedef void (*FUNCP_CUBA) (const int*, const double[], const int*, double[]);
 
-FP_dim1 compile(const ex& expr, const symbol& sym);
+/**
+ * Takes an expression and produces a function pointer to the compiled and linked
+ * C code equivalent in double precision. The function pointer has type FUNCP_1P.
+ *
+ * @param expr Expression to be compiled
+ * @param sym Symbol from the expression to become the function parameter
+ * @param fp Returned function pointer
+ * @param filename Name of the intermediate source code and so-file. If
+ * supplied, these intermediate files will not be deleted
+ */
+void compile_ex(const ex& expr, const symbol& sym, FUNCP_1P& fp, const std::string filename = "");
 
-typedef void (*FP_cuba) (const int*, const double[], const int*, double[]);
+/**
+ * Takes an expression and produces a function pointer to the compiled and linked
+ * C code equivalent in double precision. The function pointer has type FUNCP_2P.
+ *
+ * @param expr Expression to be compiled
+ * @param sym Symbol from the expression to become the function parameter
+ * @param fp Returned function pointer
+ * @param filename Name of the intermediate source code and so-file. If
+ * supplied, these intermediate files will not be deleted
+ */
+void compile_ex(const ex& expr, const symbol& sym1, const symbol& sym2, FUNCP_2P& fp, const std::string filename = "");
 
-FP_cuba compile(const lst& exprs, const lst& syms);
+/**
+ * Takes an expression and produces a function pointer to the compiled and linked
+ * C code equivalent in double precision. The function pointer has type FUNCP_CUBA.
+ *
+ * @param expr Expression to be compiled
+ * @param sym Symbol from the expression to become the function parameter
+ * @param fp Returned function pointer
+ * @param filename Name of the intermediate source code and so-file. If
+ * supplied, these intermediate files will not be deleted
+ */
+void compile_ex(const lst& exprs, const lst& syms, FUNCP_CUBA& fp, const std::string filename = "");
 
+/** 
+ * Opens an existing so-file and returns a function pointer of type FUNCP_1P to
+ * the contained function. The so-file has to be generated by compile_ex in
+ * advance.
+ *
+ * @param filename Name of the so-file to open and link
+ * @param fp Returned function pointer
+ */
+void link_ex(const std::string filename, FUNCP_1P& fp);
+
+/** 
+ * Opens an existing so-file and returns a function pointer of type FUNCP_2P to
+ * the contained function. The so-file has to be generated by compile_ex in
+ * advance.
+ *
+ * @param filename Name of the so-file to open and link
+ * @param fp Returned function pointer
+ */
+void link_ex(const std::string filename, FUNCP_2P& fp);
+
+/** 
+ * Opens an existing so-file and returns a function pointer of type FUNCP_CUBA to
+ * the contained function. The so-file has to be generated by compile_ex in
+ * advance.
+ *
+ * @param filename Name of the so-file to open and link
+ * @param fp Returned function pointer
+ */
+void link_ex(const std::string filename, FUNCP_CUBA& fp);
+
+/**
+ * Closes all linked .so files that have the supplied filename.
+ *
+ * @param filename Name of the so-file to close
+ */
+void unlink_ex(const std::string filename);
 
 } // namespace GiNaC
 
-#endif // ndef __GINAC_EXCOMPILER_H__
+#endif // ndef GINAC_EXCOMPILER_H