Restructuring project hierarchy

lyndskg · Dec 28, 2023 · ff01d7c · ff01d7c
1 parent 55ed537
commit ff01d7c
Show file tree

Hide file tree

Showing 26 changed files with 68 additions and 17 deletions.
diff --git a/docs/BuildNotes.txt b/docs/BuildNotes.txt
diff --git a/docs/hierarchy.gql b/docs/hierarchy.gql
@@ -0,0 +1,51 @@
+black-scholes-cpp/
+├── docs/
+│   ├── hierarchy.gql	   # Project hierarchy guide
+│   ├── BuildNotes.txt	   # Build notes
+│   ├── index.md           # Project documentation index
+│   ├── installation.md    # Installation guide
+│   ├── usage.md           # Library usage guide
+│   ├── troubleshooting.md # Troubleshooting guide
+│   ├── contribution.md    # Contribution guidelines
+│   └── api_reference.md   # API reference documentation
+├── gtest/          # Google Test directory
+├── oneMKL2/        # OneMKL directory
+├── include/
+│   ├── black-scholes-cpp/
+│   │   ├── blackScholesModel.h     #
+│   │   ├── hestonModel.h           #
+│   │   ├── inputReader.h           #
+│   │   ├── optionGreeks.h          #
+│   │   ├── optionGreeksModel.h     #
+│   │   ├── outputWriter.h          #
+│   │   └── Program.h               #
+│   └── third_party/
+│       ├── libcurl/         # libcurl headers
+│       ├── websocketpp/     # WebSocket++ headers
+│       └── rapidjson/       # RapidJSON headers
+├── src/
+│   ├── blackScholesModel.cpp       #
+│   ├── hestonModel.cpp             #
+│   ├── inputReader.cpp             #
+│   ├── optionGreeks.cpp            #
+│   ├── optionGreeksModel.cpp       #
+│   ├── outputWriter.cpp            #
+│   ├── Program.cpp                 #
+│   └── CMakeLists.txt              # CMake configuration for src
+├── tests/
+│   ├── test_blackScholesModel.cpp   # Unit tests for blackScholesModel
+│   ├── test_Program.cpp             # Unit tests for Program
+│   ├── test_inputReader.cpp         # Unit tests for inputReader
+│   ├── test_outputWriter.cpp        # Unit tests for outputWriter
+│   ├── test_optionGreeks.cpp        # Unit tests for optionGreeks
+│   ├── test_optionGreeks.cpp        # Unit tests for optionGreeksModel
+│   ├── unit_test_framework.h        # Unit tests for optionGreeksModel
+│   └── CMakeLists.txt               # CMake configuration for tests
+├── .gitignore
+├── Makefile
+├── csv.h
+├── option_GS_df.csv
+├── main.cpp 		        # Main driver file
+├── CMakeLists.txt          # Top-level CMake configuration
+├── xcode_redirect.hpp
+└── README.md               # Project README file
diff --git a/src/Program.h → include/black-scholes-cpp/Program.h b/src/Program.h → include/black-scholes-cpp/Program.h
diff --git a/src/blackScholesModel.h → ...ude/black-scholes-cpp/blackScholesModel.h b/src/blackScholesModel.h → ...ude/black-scholes-cpp/blackScholesModel.h
diff --git a/src/hestonModel.h → include/black-scholes-cpp/hestonModel.h b/src/hestonModel.h → include/black-scholes-cpp/hestonModel.h
diff --git a/src/inputReader.h → include/black-scholes-cpp/inputReader.h b/src/inputReader.h → include/black-scholes-cpp/inputReader.h
diff --git a/src/optionGreeks.h → include/black-scholes-cpp/optionGreeks.h b/src/optionGreeks.h → include/black-scholes-cpp/optionGreeks.h
diff --git a/src/optionGreeksModel.h → ...ude/black-scholes-cpp/optionGreeksModel.h b/src/optionGreeksModel.h → ...ude/black-scholes-cpp/optionGreeksModel.h
diff --git a/src/outputWriter.h → include/black-scholes-cpp/outputWriter.h b/src/outputWriter.h → include/black-scholes-cpp/outputWriter.h
diff --git a/src/main.cpp → main.cpp b/src/main.cpp → main.cpp
@@ -8,11 +8,11 @@
 #include <limits>
 #include <iostream>
 
-#include "Program.h"
-#include "inputReader.h"
-#include "blackScholesModel.h"
-#include "optionGreeks.h"
-#include "optionGreeksModel.h"
+#include "include/black-scholes-cpp/Program.h"
+#include "include/black-scholes-cpp/inputReader.h"
+#include "include/black-scholes-cpp/blackScholesModel.h"
+#include "include/black-scholes-cpp/optionGreeks.h"
+#include "include/black-scholes-cpp/optionGreeksModel.h"
 
 #include "xcode_redirect.hpp"
 

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
diff --git a/src/Program.cpp b/src/Program.cpp
@@ -7,9 +7,9 @@
 #include <iostream>
 #include <getopt.h>
 
-#include "Program.h"
-#include "inputReader.h"
-#include "blackScholesModel.h"
+#include "../include/black-scholes-cpp/Program.h"
+#include "../include/black-scholes-cpp/inputReader.h"
+#include "../include/black-scholes-cpp/blackScholesModel.h"
 
 using namespace std;
 

diff --git a/src/blackScholesModel.cpp b/src/blackScholesModel.cpp
@@ -10,7 +10,7 @@
 #include <numbers>
 #include <cassert>
 
-#include "blackScholesModel.h"
+#include "../include/black-scholes-cpp/blackScholesModel.h"
 
 using namespace std;
 

diff --git a/src/hestonModel.cpp b/src/hestonModel.cpp
@@ -10,7 +10,7 @@
 #include <cmath>
 #include <random>
 
-#include "hestonModel.h"
+#include "../include/black-scholes-cpp/hestonModel.h"
 #include "unit_test_framework.h"
 
 //#include "../include/oneMKL/mkl.h"

diff --git a/src/inputReader.cpp b/src/inputReader.cpp
@@ -18,8 +18,8 @@
 #include <cstdio>
 #endif
 
-#include "blackScholesModel.h"
-#include "inputReader.h"
+#include "../include/black-scholes-cpp/blackScholesModel.h"
+#include "../include/black-scholes-cpp/inputReader.h"
 
 using namespace std;
 

diff --git a/src/optionGreeks.cpp b/src/optionGreeks.cpp
@@ -7,8 +7,8 @@
 #include <cmath>
 #include <cassert>
 
-#include "optionGreeks.h"
-#include "blackScholesModel.h"
+#include "../include/black-scholes-cpp/optionGreeks.h"
+#include "../include/black-scholes-cpp/blackScholesModel.h"
 
 
 // ----------------------------------------------------------------------------

diff --git a/src/optionGreeksModel.cpp b/src/optionGreeksModel.cpp
@@ -7,8 +7,8 @@
 #include <iostream>
 #include <cassert>
 
-#include "optionGreeksModel.h"
-#include "optionGreeks.h"
+#include "../include/black-scholes-cpp/optionGreeksModel.h"
+#include "../include/black-scholes-cpp/optionGreeks.h"
 
 using namespace std;
 

diff --git a/src/outputWriter.cpp b/src/outputWriter.cpp
@@ -7,7 +7,7 @@
 #include <iostream>
 #include <fstream>
 
-#include "outputWriter.h"
+#include "../include/black-scholes-cpp/outputWriter.h"
 
 using namespace std;
 

diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
diff --git a/test/Program_tests.cpp → test/test_Program.cpp b/test/Program_tests.cpp → test/test_Program.cpp
diff --git a/test/blackScholesModel_tests.cpp → test/test_blackScholesModel.cpp b/test/blackScholesModel_tests.cpp → test/test_blackScholesModel.cpp
diff --git a/test/hestonModel_tests.cpp → test/test_hestonModel.cpp b/test/hestonModel_tests.cpp → test/test_hestonModel.cpp
diff --git a/test/inputReader_tests.cpp → test/test_inputReader.cpp b/test/inputReader_tests.cpp → test/test_inputReader.cpp
diff --git a/test/optionGreeks_tests.cpp → test/test_optionGreeks.cpp b/test/optionGreeks_tests.cpp → test/test_optionGreeks.cpp
diff --git a/test/optionGreeksModel_tests.cpp → test/test_optionGreeksModel.cpp b/test/optionGreeksModel_tests.cpp → test/test_optionGreeksModel.cpp
diff --git a/test/outputWriter_tests.cpp → test/test_outputWriter.cpp b/test/outputWriter_tests.cpp → test/test_outputWriter.cpp