Change parameter name and order

Author: TLCFEM

.github/workflows/coverage.yml

@@ -23,7 +23,7 @@ jobs:
           make -j"$(nproc)"
           ./vpmr -h
           echo "exp(-t^2/2)" > k
-          ./vpmr -nc 5 -n 20 -d 100 -q 400 -e 1e-9 -k k -w -s
+          ./vpmr -c 5 -n 20 -d 100 -q 400 -e 1e-9 -k k -w -s
           for SRC in `find . | egrep '\.o'`; do gcov -n $SRC > /dev/null; done
           python3 -c "import _pyvpmr;print(_pyvpmr.vpmr())"
       - name: Python

.github/workflows/release.yml

@@ -4,6 +4,8 @@ on:
     branches: [ master ]
   pull_request:
     branches: [ master ]
+env:
+  VPMR_VERSION: ""
 jobs:
   debian:
     runs-on: ubuntu-22.04

.gitignore

@@ -1,9 +1,11 @@
-*vpmr*.so
-*.egg-info
+__pycache__
 .cache
 .idea/
+.venv
 .vscode/
+*.egg-info
+*vpmr*.so
 build/
 cmake-build-*/
-wheelhouse
-__pycache__
+venv
+wheelhouse

README.md

@@ -160,10 +160,10 @@ Usage: vpmr [options]
 Options:
 
    -n <int>     number of terms (default: 10)
+   -c <int>     maximum exponent (default: 4)
    -d <int>     number of precision bits (default: 512)
    -q <int>     quadrature order (default: 500)
    -m <float>   precision multiplier (default, minimum: 1.5)
-   -nc <int>    controls the maximum exponent (default: 4)
    -e <float>   tolerance (default: 1E-8)
    -k <string>  file name of kernel function (default: exp(-t^2/4))
    -s           print singular values
@@ -188,9 +188,9 @@ The output is:
 
 ```text
 Using the following parameters:
-        nc = 4.
-         n = 30.
+     terms = 30.
      order = 500.
+  exponent = 4.
  precision = 336.
  tolerance = 1.0000e-08.
     kernel = exp(-t*t/4).

src/VPMR.cpp

@@ -284,10 +284,10 @@ int print_helper() {
     std::cout << "Usage: vpmr [options]\n\n";
     std::cout << "Options:\n\n";
     std::cout << "   -n <int>     number of terms (default: 10)\n";
+    std::cout << "   -c <int>     maximum exponent (default: 4)\n";
     std::cout << "   -d <int>     number of precision bits (default: 512)\n";
     std::cout << "   -q <int>     quadrature order (default: 500)\n";
     std::cout << "   -m <float>   precision multiplier (default: 1.5)\n";
-    std::cout << "   -nc <int>    controls the maximum exponent (default: 4)\n";
     std::cout << "   -e <float>   tolerance (default: 1E-8)\n";
     std::cout << "   -k <string>  file name of kernel function (default: exp(-t^2/4))\n";
     std::cout << "   -s           print singular values\n";
@@ -307,7 +307,7 @@ int main(const int argc, const char** argv) {
 
     bool has_digit = false;
     for(auto I = 1; I < argc; ++I) {
-        if(const auto token = std::string(argv[I]); token == "-nc")
+        if(const auto token = std::string(argv[I]); token == "-c")
             NC = std::max(1, std::stoi(argv[++I]));
         else if(token == "-n")
             N = std::max(1, std::stoi(argv[++I]));
@@ -376,12 +376,13 @@ int main(const int argc, const char** argv) {
     std::cout << std::scientific << std::setprecision(4);
 
     std::cout << "Using the following parameters:\n";
-    std::cout << "        nc = " << NC << ".\n";
-    std::cout << "         n = " << N << ".\n";
-    std::cout << "     order = " << QUAD_ORDER << ".\n";
-    std::cout << " precision = " << DIGIT << ".\n";
-    std::cout << " tolerance = " << (2 * TOL).toDouble() << ".\n";
-    std::cout << "    kernel = " << KERNEL << ".\n\n";
+    std::cout << "      terms = " << N << ".\n";
+    std::cout << "   exponent = " << NC << ".\n";
+    std::cout << "  precision = " << DIGIT << ".\n";
+    std::cout << "      order = " << QUAD_ORDER << ".\n";
+    std::cout << " multiplier = " << SCALE << ".\n";
+    std::cout << "  tolerance = " << (2 * TOL).toDouble() << ".\n";
+    std::cout << "     kernel = " << KERNEL << ".\n\n";
 
     try {
         // run VPMR algorithm
@@ -410,12 +411,12 @@ int main(const int argc, const char** argv) {
 #include <pybind11/stl.h>
 
 std::tuple<std::vector<std::complex<double>>, std::vector<std::complex<double>>> vpmr_wrapper(
-    const int n, const int d, const int q, const double m, const int nc, const double e, const std::string& k) {
+    const int n, const int d, const int q, const double m, const int c, const double e, const std::string& k) {
     N = std::max(1, n);
     DIGIT = std::max(1, d);
     QUAD_ORDER = std::max(1, q);
     SCALE = std::max(1.5, m);
-    NC = std::max(1, nc);
+    NC = std::max(1, c);
     TOL = mpreal(e);
     if(!k.empty()) KERNEL = k;
 
@@ -462,13 +463,13 @@ PYBIND11_MODULE(_pyvpmr, m) {
 
     m.def(
         "vpmr", &vpmr_wrapper, pybind11::call_guard<pybind11::gil_scoped_release>(),
-        pybind11::kw_only(), pybind11::arg("n") = 10, pybind11::arg("d") = 0, pybind11::arg("q") = 500, pybind11::arg("m") = 1.5, pybind11::arg("nc") = 4, pybind11::arg("e") = 1E-8, pybind11::arg("k") = "",
+        pybind11::kw_only(), pybind11::arg("n") = 10, pybind11::arg("d") = 0, pybind11::arg("q") = 500, pybind11::arg("m") = 1.5, pybind11::arg("c") = 4, pybind11::arg("e") = 1E-8, pybind11::arg("k") = "",
         "The VPMR Algorithm.\n\n"
         ":param n: number of terms (default: 10)\n"
+        ":param c: maximum exponent (default: 4)\n"
         ":param d: number of precision bits (default: 512)\n"
         ":param q: quadrature order (default: 500)\n"
         ":param m: precision multiplier (default: 1.5)\n"
-        ":param nc: maximum exponent (default: 4)\n"
         ":param e: tolerance (default: 1E-8)\n"
         ":param k: kernel function (default: exp(-t^2/4))\n"
         ":return: M, S\n");

test/example.py

@@ -23,6 +23,6 @@ def kernel(x):
 
 
 if __name__ == '__main__':
-    m, s = vpmr(n=60, k='exp(-t^2/4)*t^3', e=1e-12, nc=10)
+    m, s = vpmr(n=60, k="exp(-t^2/4)*t^3", e=1e-12, c=10)
     print(to_global_damping(m, s))
     plot(m, s, kernel)