Merge zero_finder

Author: lorenzotomada

.gitignore

@@ -193,3 +193,6 @@ skbuild/*
 
 # temporary files for vim users
 *.swp
+
+# helper files
+*TMP.py

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.12)
 
 project(QR_binding VERSION 1.0
-  DESCRIPTION "QR method"
+	DESCRIPTION "Python bindings of some helper functions written in C++."
   LANGUAGES CXX)
 
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/src/pyclassify)
@@ -35,8 +35,8 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 
 add_compile_options(-O3 -Wall -Werror -Wpedantic)
 
-pybind11_add_module(QR_cpp ${CMAKE_SOURCE_DIR}/src/pyclassify/QR_bindings.cpp)
-set_target_properties(QR_cpp PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
+pybind11_add_module(cxx_utils ${CMAKE_SOURCE_DIR}/src/pyclassify/cxx_utils.cpp)
+set_target_properties(cxx_utils PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
 
-target_compile_features(QR_cpp PUBLIC cxx_std_17)
-install(TARGETS QR_cpp LIBRARY DESTINATION ${CMAKE_SOURCE_DIR}/src/pyclassify)
+target_compile_features(cxx_utils PUBLIC cxx_std_17)
+install(TARGETS cxx_utils LIBRARY DESTINATION ${CMAKE_SOURCE_DIR}/src/pyclassify)

docs/pyclassify.rst

@@ -22,7 +22,7 @@ Submodule: utils
 Submodule: helpers_secular
 ================
 
-.. automodule:: pyclassify.helpers_secular
+.. automodule:: pyclassify.zero_finder
    :members:
    :undoc-members:
    :show-inheritance:

setup.py

@@ -20,15 +20,15 @@ def build_extension(self, ext):
         # Run CMake build
         os.makedirs(build_temp, exist_ok=True)
         self.spawn(["cmake", ext.sourcedir, "-B", build_temp])
-        self.spawn(["cmake", "--build", build_temp, "--target", "QR_cpp"])
+        self.spawn(["cmake", "--build", build_temp, "--target", "cxx_utils"])
 
         # Dynamically find the compiled shared library
         matches = glob.glob(
-            os.path.join(ext.sourcedir, "src", "pyclassify", "QR_cpp*.so")
+            os.path.join(ext.sourcedir, "src", "pyclassify", "cxx_utils*.so")
         )
         if not matches:
             raise RuntimeError(
-                "Could not find compiled QR_cpp shared library in expected location."
+                "Could not find compiled cxx_utils shared library in expected location."
             )
 
         src_lib = os.path.abspath(matches[0])
@@ -41,14 +41,14 @@ def build_extension(self, ext):
 setup(
     name="pyclassify",
     version="0.0.1",
-    author="Lorenzo Tomada, Gaspare Li Causi",
+    author="Gaspare Li Causi, Lorenzo Tomada",
     author_email="ltomada@sissa.it, glicausi@sissa.it",
     description="Final project",
     long_description="Eigenvalue computation",
-    ext_modules=[CMakeExtension("pyclassify.QR_cpp")],
+    ext_modules=[CMakeExtension("pyclassify.cxx_utils")],
     packages=find_packages(where="src/"),
     package_dir={"": "src/"},
-    package_data={"pyclassify": ["QR_cpp*.so"]},
+    package_data={"pyclassify": ["cxx_utils*.so"]},
     include_package_data=True,
     cmdclass={"build_ext": CMakeBuild},
     zip_safe=False,