From aedde95c4b98171f2c6c3330eab3385186796fed Mon Sep 17 00:00:00 2001
From: Thibault Hallouin <thibault.hallouin@inrae.fr>
Date: Wed, 15 Jun 2022 12:28:49 +0200
Subject: [PATCH] restructure files to split publicly distributed and
 implementation

It seems that good practice for C++ applications is to only include
*public* headers in "./include" folder and keep source files and
*private* headers and implementation source files in "./src".
---
 include/evalhyd/{determinist.hpp => evald.hpp} |  4 ++--
 include/evalhyd/{probabilist.hpp => evalp.hpp} |  4 ++--
 .../evalhyd => src}/determinist/evaluator.hpp  |  0
 .../evalhyd => src}/probabilist/evaluator.h    |  0
 .../probabilist/evaluator_brier.cpp            |  0
 .../probabilist/evaluator_elements.cpp         |  0
 .../probabilist/evaluator_quantiles.cpp        |  0
 .../probabilist/evaluator_utils.cpp            |  0
 {include/evalhyd => src}/utils.hpp             |  0
 tests/CMakeLists.txt                           | 18 +++++++++---------
 tests/test_determinist.cpp                     |  4 +---
 tests/test_probabilist.cpp                     |  4 +---
 12 files changed, 15 insertions(+), 19 deletions(-)
 rename include/evalhyd/{determinist.hpp => evald.hpp} (97%)
 rename include/evalhyd/{probabilist.hpp => evalp.hpp} (98%)
 rename {include/evalhyd => src}/determinist/evaluator.hpp (100%)
 rename {include/evalhyd => src}/probabilist/evaluator.h (100%)
 rename {include/evalhyd => src}/probabilist/evaluator_brier.cpp (100%)
 rename {include/evalhyd => src}/probabilist/evaluator_elements.cpp (100%)
 rename {include/evalhyd => src}/probabilist/evaluator_quantiles.cpp (100%)
 rename {include/evalhyd => src}/probabilist/evaluator_utils.cpp (100%)
 rename {include/evalhyd => src}/utils.hpp (100%)

diff --git a/include/evalhyd/determinist.hpp b/include/evalhyd/evald.hpp
similarity index 97%
rename from include/evalhyd/determinist.hpp
rename to include/evalhyd/evald.hpp
index 06ad762..6ba565d 100644
--- a/include/evalhyd/determinist.hpp
+++ b/include/evalhyd/evald.hpp
@@ -6,8 +6,8 @@
 #include <xtensor/xexpression.hpp>
 #include <xtensor/xarray.hpp>
 
-#include "utils.hpp"
-#include "determinist/evaluator.hpp"
+#include "../../src/utils.hpp"
+#include "../../src/determinist/evaluator.hpp"
 
 namespace eh = evalhyd;
 
diff --git a/include/evalhyd/probabilist.hpp b/include/evalhyd/evalp.hpp
similarity index 98%
rename from include/evalhyd/probabilist.hpp
rename to include/evalhyd/evalp.hpp
index 8c40169..f2ff100 100644
--- a/include/evalhyd/probabilist.hpp
+++ b/include/evalhyd/evalp.hpp
@@ -8,8 +8,8 @@
 #include <xtensor/xarray.hpp>
 #include <xtensor/xview.hpp>
 
-#include "utils.hpp"
-#include "probabilist/evaluator.h"
+#include "../../src/utils.hpp"
+#include "../../src/probabilist/evaluator.h"
 
 namespace eh = evalhyd;
 
diff --git a/include/evalhyd/determinist/evaluator.hpp b/src/determinist/evaluator.hpp
similarity index 100%
rename from include/evalhyd/determinist/evaluator.hpp
rename to src/determinist/evaluator.hpp
diff --git a/include/evalhyd/probabilist/evaluator.h b/src/probabilist/evaluator.h
similarity index 100%
rename from include/evalhyd/probabilist/evaluator.h
rename to src/probabilist/evaluator.h
diff --git a/include/evalhyd/probabilist/evaluator_brier.cpp b/src/probabilist/evaluator_brier.cpp
similarity index 100%
rename from include/evalhyd/probabilist/evaluator_brier.cpp
rename to src/probabilist/evaluator_brier.cpp
diff --git a/include/evalhyd/probabilist/evaluator_elements.cpp b/src/probabilist/evaluator_elements.cpp
similarity index 100%
rename from include/evalhyd/probabilist/evaluator_elements.cpp
rename to src/probabilist/evaluator_elements.cpp
diff --git a/include/evalhyd/probabilist/evaluator_quantiles.cpp b/src/probabilist/evaluator_quantiles.cpp
similarity index 100%
rename from include/evalhyd/probabilist/evaluator_quantiles.cpp
rename to src/probabilist/evaluator_quantiles.cpp
diff --git a/include/evalhyd/probabilist/evaluator_utils.cpp b/src/probabilist/evaluator_utils.cpp
similarity index 100%
rename from include/evalhyd/probabilist/evaluator_utils.cpp
rename to src/probabilist/evaluator_utils.cpp
diff --git a/include/evalhyd/utils.hpp b/src/utils.hpp
similarity index 100%
rename from include/evalhyd/utils.hpp
rename to src/utils.hpp
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
index 9b62835..d60239f 100644
--- a/tests/CMakeLists.txt
+++ b/tests/CMakeLists.txt
@@ -28,15 +28,15 @@ include_directories(data)
 add_executable(
         evalhyd_tests
         test_determinist.cpp
-        ../include/evalhyd/utils.hpp
-        ../include/evalhyd/determinist.hpp
-        ../include/evalhyd/determinist/evaluator.hpp
+        ../include/evalhyd/evald.hpp
+        ../src/determinist/evaluator.hpp
+        ../src/utils.hpp
         test_probabilist.cpp
-        ../include/evalhyd/probabilist.hpp
-        ../include/evalhyd/probabilist/evaluator.h
-        ../include/evalhyd/probabilist/evaluator_brier.cpp
-        ../include/evalhyd/probabilist/evaluator_quantiles.cpp
-        ../include/evalhyd/probabilist/evaluator_elements.cpp
-        ../include/evalhyd/probabilist/evaluator_utils.cpp
+        ../include/evalhyd/evalp.hpp
+        ../src/probabilist/evaluator.h
+        ../src/probabilist/evaluator_brier.cpp
+        ../src/probabilist/evaluator_quantiles.cpp
+        ../src/probabilist/evaluator_elements.cpp
+        ../src/probabilist/evaluator_utils.cpp
 )
 target_link_libraries(evalhyd_tests gtest gtest_main)
diff --git a/tests/test_determinist.cpp b/tests/test_determinist.cpp
index 076d207..1ad4ff6 100644
--- a/tests/test_determinist.cpp
+++ b/tests/test_determinist.cpp
@@ -1,14 +1,12 @@
-#include <istream>
 #include <fstream>
 #include <vector>
 #include <gtest/gtest.h>
 #include <xtensor/xtensor.hpp>
-#include <xtensor/xarray.hpp>
 #include <xtensor/xview.hpp>
 #include <xtensor/xmanipulation.hpp>
 #include <xtensor/xcsv.hpp>
 
-#include "evalhyd/determinist.hpp"
+#include "evalhyd/evald.hpp"
 
 TEST(DeterministTests, TestNSE) {
     // read in data
diff --git a/tests/test_probabilist.cpp b/tests/test_probabilist.cpp
index 33a4009..880993f 100644
--- a/tests/test_probabilist.cpp
+++ b/tests/test_probabilist.cpp
@@ -1,13 +1,11 @@
-#include <istream>
 #include <fstream>
 #include <vector>
 #include <gtest/gtest.h>
 #include <xtensor/xtensor.hpp>
-#include <xtensor/xarray.hpp>
 #include <xtensor/xmanipulation.hpp>
 #include <xtensor/xcsv.hpp>
 
-#include "evalhyd/probabilist.hpp"
+#include "evalhyd/evalp.hpp"
 
 TEST(ProbabilistTests, TestBrier) {
     // read in data
-- 
GitLab