refactor: small structural changes to the library (#70)

Author: AngryMaciek

.github/workflows/publish.yml

@@ -32,7 +32,7 @@ jobs:
 
       - name: Compile Docs Test Program
         working-directory: ${{env.test-directory}}
-        run: g++ --std=c++17 test.cpp -o test -lmpfr -lgmp
+        run: g++ -DUSEMPFR=1 --std=c++17 test.cpp -o test -lmpfr -lgmp
 
       - name: Execute Test Program
         working-directory: ${{env.test-directory}}

.github/workflows/unit.yml

@@ -59,7 +59,7 @@ jobs:
 
       - name: Compile Test Program
         working-directory: ${{env.working-directory}}
-        run: g++ -O0 -fprofile-arcs -ftest-coverage -fno-elide-constructors -Wall --std=c++17 --coverage -o test test.cpp -lmpfr -lgmp
+        run: g++ -DUSEMPFR=1 -O0 -fprofile-arcs -ftest-coverage -fno-elide-constructors -Wall --std=c++17 --coverage -o test test.cpp -lmpfr -lgmp
 
       - name: Execute Test Program
         working-directory: ${{env.working-directory}}
@@ -107,7 +107,7 @@ jobs:
 
       - name: Compile Test Program
         working-directory: ${{env.working-directory}}
-        run: g++ -O0 -Wall --std=c++17 -o test test.cpp -lmpfr -lgmp
+        run: g++ -DUSEMPFR=1 -O0 -Wall --std=c++17 -o test test.cpp -lmpfr -lgmp
 
       - name: Analyze Test Program Exec
         working-directory: ${{env.working-directory}}

.github/workflows/user.yml

@@ -18,16 +18,6 @@ jobs:
       - name: Display Compiler Version
         run: g++ --version
 
-      - name: Install MPFR
-        run: |
-          if [ "$RUNNER_OS" == "Linux" ]; then
-            sudo apt-get update -y
-            sudo apt-get install -y libmpfr-dev
-          elif [ "$RUNNER_OS" == "macOS" ]; then
-            brew update
-            brew install mpfr
-          fi
-
       - name: Checkout Repository
         uses: actions/checkout@v3
 
@@ -37,7 +27,7 @@ jobs:
 
       - name: Compile Test Program
         working-directory: ${{env.working-directory}}
-        run: g++ --std=c++17 test.cpp -o test -lmpfr -lgmp
+        run: g++ --std=c++17 test.cpp -o test
 
       - name: Execute Test Program
         working-directory: ${{env.working-directory}}
@@ -57,16 +47,6 @@ jobs:
       - name: Display Compiler Version
         run: g++ --version
 
-      - name: Install MPFR
-        run: |
-          if [ "$RUNNER_OS" == "Linux" ]; then
-            sudo apt-get update -y
-            sudo apt-get install -y libmpfr-dev
-          elif [ "$RUNNER_OS" == "macOS" ]; then
-            brew update
-            brew install mpfr
-          fi
-
       - name: Checkout Repository
         uses: actions/checkout@v3
 
@@ -75,7 +55,7 @@ jobs:
 
       - name: Compile Test Program
         working-directory: ${{env.test-directory}}
-        run: g++ --std=c++17 test.cpp -o test -lmpfr -lgmp
+        run: g++ --std=c++17 test.cpp -o test
 
       - name: Execute Test Program
         working-directory: ${{env.test-directory}}
@@ -123,7 +103,7 @@ jobs:
 
       - name: Compile Test Program
         shell: bash -l {0}
-        run: g++ --std=c++17 -I$CONDA_PREFIX/include -L$CONDA_PREFIX/lib .test/install/test.cpp -o test -lmpfr -lgmp
+        run: g++ --std=c++17 -I$CONDA_PREFIX/include .test/install/test.cpp -o test
 
       - name: Execute Test Program
         shell: bash -l {0}

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v2.0.14] - 2023-08-05
+### :memo: Documentation Changes
+- [`e8433b8`](https://github.com/AngryMaciek/hypercomplex/commit/e8433b8ac00ebf71a6406bb8836a3c44e9010652) - docs: clean changelog/dev/docs *(PR [#69](https://github.com/AngryMaciek/hypercomplex/pull/69) by [@AngryMaciek](https://github.com/AngryMaciek))*
+
+
 ## [v2.0.13] - 2023-08-03
 ### :bug: Bug Fixes
 - [`b3ee0dd`](https://github.com/AngryMaciek/hypercomplex/commit/b3ee0dd58feef4e7793afc452e1e5e6f3ebe13e9) - adjust conda pkg options *(PR [#68](https://github.com/AngryMaciek/hypercomplex/pull/68) by [@AngryMaciek](https://github.com/AngryMaciek))*
@@ -23,3 +28,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [v2.0.11]: https://github.com/AngryMaciek/hypercomplex/compare/v2.0.10...v2.0.11
 [v2.0.12]: https://github.com/AngryMaciek/hypercomplex/compare/v2.0.11...v2.0.12
 [v2.0.13]: https://github.com/AngryMaciek/hypercomplex/compare/v2.0.12...v2.0.13
+[v2.0.14]: https://github.com/AngryMaciek/hypercomplex/compare/v2.0.13...v2.0.14

Doxyfile

@@ -909,6 +909,7 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = hypercomplex/Hypercomplex.hpp \
+                         hypercomplex/Hypercomplex_MPFR.hpp \
                          hypercomplex/Polynomial.hpp \
                          docs/mainpage.dox
 

Makefile

@@ -10,7 +10,8 @@
 ###############################################################################
 
 SRC1 = Hypercomplex.hpp
-SRC2 = Polynomial.hpp
+SRC2 = Hypercomplex_MPFR.hpp
+SRC3 = Polynomial.hpp
 
 UNAME_S := $(shell uname -s)
 ifeq ($(UNAME_S),Linux)
@@ -42,7 +43,7 @@ help:
 # Install
 # =============================================================================
 
-install: $(INCLUDE_PREFIX)/Hypercomplex/$(SRC1) $(INCLUDE_PREFIX)/Hypercomplex/$(SRC2)
+install: $(INCLUDE_PREFIX)/Hypercomplex/$(SRC1) $(INCLUDE_PREFIX)/Hypercomplex/$(SRC2) $(INCLUDE_PREFIX)/Hypercomplex/$(SRC3)
 
 # Create a separate directory for the header-only library
 $(INCLUDE_PREFIX)/Hypercomplex:
@@ -52,10 +53,14 @@ $(INCLUDE_PREFIX)/Hypercomplex:
 $(INCLUDE_PREFIX)/Hypercomplex/$(SRC1): hypercomplex/$(SRC1) $(INCLUDE_PREFIX)/Hypercomplex
 	@cp $< $@
 
-# Copy the helper library file into the right directory
+# Copy the class specialisation file into the right directory
 $(INCLUDE_PREFIX)/Hypercomplex/$(SRC2): hypercomplex/$(SRC2) $(INCLUDE_PREFIX)/Hypercomplex
 	@cp $< $@
 
+# Copy the helper library file into the right directory
+$(INCLUDE_PREFIX)/Hypercomplex/$(SRC3): hypercomplex/$(SRC3) $(INCLUDE_PREFIX)/Hypercomplex
+	@cp $< $@
+
 # =============================================================================
 # Uninstall
 # =============================================================================
@@ -72,8 +77,9 @@ uninstall:
 test:
 	@mkdir .test/unit/hypercomplex
 	@cp hypercomplex/Hypercomplex.hpp .test/unit/hypercomplex/Hypercomplex.hpp
+	@cp hypercomplex/Hypercomplex_MPFR.hpp .test/unit/hypercomplex/Hypercomplex_MPFR.hpp
 	@cp hypercomplex/Polynomial.hpp .test/unit/hypercomplex/Polynomial.hpp
-	@g++ -O0 -Wall --std=c++17 -o test .test/unit/test.cpp -lmpfr -lgmp
+	@g++ -DUSEMPFR=1 -O0 -Wall --std=c++17 -o test .test/unit/test.cpp -lmpfr -lgmp
 	@./test [unit] -d yes -w NoAssertions --use-colour yes --benchmark-samples 100 --benchmark-resamples 100000
 	@rm -rf .test/unit/hypercomplex test
 
@@ -84,6 +90,7 @@ test:
 # Run static code analysis
 lint:
 	@cpplint hypercomplex/Hypercomplex.hpp
+	@cpplint hypercomplex/Hypercomplex_MPFR.hpp
 	@cpplint hypercomplex/Polynomial.hpp
 
 # =============================================================================

README.md

@@ -8,7 +8,7 @@
 [![CodeFactor](https://www.codefactor.io/repository/github/angrymaciek/hypercomplex/badge)](https://www.codefactor.io/repository/github/angrymaciek/hypercomplex)
 [![publish](https://github.com/AngryMaciek/hypercomplex/workflows/publish/badge.svg)](https://github.com/AngryMaciek/hypercomplex/actions?query=workflow%3Apublish)
 [![conda](https://anaconda.org/angrymaciek/hypercomplex/badges/version.svg)](https://anaconda.org/AngryMaciek/hypercomplex)
-[![DockerHub](https://badgen.net/badge/icon/2.0.14/docker?icon=docker&label=DockerHub&color=blue)](https://hub.docker.com/r/angrymaciek/hypercomplex)
+[![DockerHub](https://badgen.net/badge/icon/2.0.15/docker?icon=docker&label=DockerHub&color=blue)](https://hub.docker.com/r/angrymaciek/hypercomplex)
 [![DOI](https://joss.theoj.org/papers/10.21105/joss.05272/status.svg)](https://doi.org/10.21105/joss.05272)
 
 <img src="img/logo.png" alt="drawing" height="30"/>

docs/DoxygenLayout.xml

@@ -5,6 +5,7 @@
     <tab type="mainpage" visible="yes" title=""/>
     <tab type="usergroup" title="File Reference">
       <tab type="user" url="_hypercomplex_8hpp.html" title="Hypercomplex"/>
+      <tab type="user" url="_hypercomplex___m_p_f_r_8hpp.html" title="Hypercomplex_MPFR"/>
       <tab type="user" url="_polynomial_8hpp.html" title="Polynomial"/>
     </tab>
   </navindex>

docs/mainpage.dox

@@ -16,7 +16,21 @@
  *
  * \section install_sec Installation
  *
- * As a prerequisite it is essential to install the
+ * The following is a _header-only_ library, meaning that the easiest way to use it
+ * is to copy the core _hpp_ files alongside your main program and include it into the code
+ * with the directive:
+ * \code{.cpp}
+ * #include "Hypercomplex.hpp"
+ * \endcode
+ *
+ * Remember to specify a proper langauge standard and optimisation level
+ * for the compiler, as in the command below:
+ * \code
+ * g++ -O2 --std=c++17 main.cpp -o main
+ * \endcode
+ *
+ * For computations based on high precision arithmetics
+ * it is essential to install the
  * <a href="https://www.mpfr.org/">MPFR library</a> first.
  * This should be rather straightforward with the following commands:
  * \code
@@ -29,20 +43,13 @@
  * brew install mpfr
  * \endcode
  *
- * The following is a _header-only_ library, meaning that the easiest way to use it
- * is to copy the core _hpp_ file alongside the main program and include it into the code
- * with the directive:
- * \code{.cpp}
- * #include "Hypercomplex.hpp"
- * \endcode
- *
- * Remember to specify a proper langauge standard for the compiler as well as
- * linking with _GNU MP_ and _GNU MPFR_ libraries, as in the command below:
+ * It is then essential to provide a preprocessor macro specifying the
+ * use of this library at the compile time as well as
+ * linking with _GNU MP_ and _GNU MPFR_ as in the command below:
  * \code
- * g++ -O2 --std=c++17 test.cpp -o test -lmpfr -lgmp
+ * g++ -O2 -DUSEMPFR=1 --std=c++17 main.cpp -o main -lmpfr -lgmp
  * \endcode
  *
- *
  * Alternatively, if you work with conda environments this library is installable with:
  * \code
  * conda install -c angrymaciek hypercomplex
@@ -53,7 +60,7 @@
  *
  * The command above would be adjusted to:
  * \code
- * g++ -O2 --std=c++17 -I$CONDA_PREFIX/include -L$CONDA_PREFIX/lib test.cpp -o test -lmpfr -lgmp
+ * g++ -O2 -DUSEMPFR=1 --std=c++17 -I$CONDA_PREFIX/include -L$CONDA_PREFIX/lib main.cpp -o main -lmpfr -lgmp
  * \endcode
  *
  *