Add example commands on how to run Daalder

Author: hwalinga

source/CMakeLists.txt

@@ -80,6 +80,8 @@ add_library(Source STATIC
         running_modes/predict_mode.cpp
         running_modes/regex_mode.h
         running_modes/regex_mode.cpp
+        running_modes/load_sqldb_mode.h
+        running_modes/load_sqldb_mode.cpp
         running_modes/running_mode_base.h
         running_modes/running_mode_base.cpp
         running_modes/search_mode.h

source/active_learning/readme.md

@@ -36,4 +36,22 @@ seems not guaranteed anymore.
 
 - To run valgrind on the Python interface, download the valgrind-python.supp file from the [cpython-github](https://github.com/python/cpython/blob/main/Misc/valgrind-python.supp), and the run it using the flag
 
-    --suppressions=\[some path\]/valgrind-python.supp
+    --suppressions=\[some path\]/valgrind-python.supp
+
+# Daalder (or Ldot)
+
+You can run Daalder (formerly Ldot) with these commands:
+
+```sh
+# First load the strings a database.
+./flexfringe --ini ini/edsm.ini --mode load_sqldb --postgresql-tblname test_daalder20 test.dat --logpath test_daalder.log  
+# Then you can learn the state machine from the stored traces using ldot.
+./flexfringe --ini ini/edsm.ini --mode active_learning --active_learning_algorithm ldot --al_oracle sqldb_sul_random_oracle --al_system_under_learning sqldb_sul --postgresql-tblname test_daalder20 '' --runs 1000001 --predicttype 1 --printblue 1 --printwhite 1 --logpath test_daalder.log --outputfile test_daalder
+```
+
+For more configuration for connecting to PostGreSQL check documentation of PostGreSQL on connection string and set it with `--postgresql-connstring`.
+
+For more details read: 
+
+* https://arxiv.org/abs/2406.07208
+* https://repository.tudelft.nl/record/uuid:40a1cb17-a46e-421e-a916-396ebaf3d7b1

source/running_mode_factory.cpp

@@ -20,6 +20,7 @@
 #include "interactive_mode.h"
 #include "predict_mode.h"
 #include "regex_mode.h"
+#include "load_sqldb_mode.h"
 #include "search_mode.h"
 #include "stream_mode.h"
 #include "subgraphextraction_mode.h"

source/running_modes/load_sqldb_mode.cpp

@@ -0,0 +1,36 @@
+/**
+ * @file regex_mode.cpp
+ * @author Hielke Walinga
+ * @brief 
+ * @version 0.1
+ * @date 2024-12-19
+ * 
+ * @copyright Copyright (c) 2024
+ * 
+ */
+
+#include "load_sqldb_mode.h"
+#include "inputdatalocator.h" 
+
+#include <iostream>
+#include <ranges>
+#include "misc/sqldb.h"
+
+void load_sqldb_mode::initialize(){
+    // do nothing
+}
+
+int load_sqldb_mode::run(){
+    std::ifstream input_stream = get_inputstream();
+    std::cout << "Selected to use the SQL database. Creating new inputdata object and loading traces.";
+    abbadingo_inputdata id;
+    inputdata_locator::provide(&id);
+    auto my_sqldb = make_unique<psql::db>(POSTGRESQL_TBLNAME, POSTGRESQL_CONNSTRING);
+    my_sqldb->load_traces(id, input_stream);
+
+    return EXIT_SUCCESS;
+}
+
+void load_sqldb_mode::generate_output(){
+    // do nothing
+}

source/running_modes/load_sqldb_mode.h

@@ -0,0 +1,27 @@
+/**
+ * @file regex_mode.h
+ * @author Hielke Walinga
+ * @brief 
+ * @version 0.1
+ * @date 2024-12-19
+ * 
+ * @copyright Copyright (c) 2024
+ * 
+ */
+
+#ifndef _LOAD_SQLDB_MODE_H_
+#define _LOAD_SQLDB_MODE_H_
+
+#include "running_mode_base.h"
+
+#include "misc/sqldb.h"
+#include "misc/utils.h"
+
+class load_sqldb_mode : public running_mode_base {
+  public:
+    void initialize() override;
+    int run() override;
+    void generate_output() override;
+};
+
+#endif // _LOAD_SQLDB_MODE_H_

source/running_modes/running_mode_base.cpp

@@ -22,9 +22,9 @@
 using namespace std;
 
 /**
- * @brief Reads the entire input file all at once and stores it in input data.
+ * @brief get the inputstream
  */
-void running_mode_base::read_input_file() {
+ifstream running_mode_base::get_inputstream() const {
     ifstream input_stream(INPUT_FILE);
 
     if(!input_stream) {
@@ -34,6 +34,14 @@ void running_mode_base::read_input_file() {
     } else {
         cout << "Using input file: " << INPUT_FILE << endl;
     }
+    return input_stream;
+}
+
+/**
+ * @brief Reads the entire input file all at once and stores it in input data.
+ */
+void running_mode_base::read_input_file() {
+    ifstream input_stream = get_inputstream();
 
     bool read_csv = false;
     if(INPUT_FILE.ends_with(".csv")){
@@ -78,4 +86,4 @@ void running_mode_base::initialize(){
 void running_mode_base::generate_output(){
     cout << "Printing output to " << output_manager::get_outfile_path() << ".final" << endl;
     output_manager::output_manager::print_final_automaton(merger, ".final");
-}
+}

source/running_modes/running_mode_base.h

@@ -33,6 +33,7 @@ class running_mode_base {
     state_merger* merger = nullptr; // must be set from within constructor
 
     void read_input_file();
+    std::ifstream get_inputstream() const;
 
   public:
     ~running_mode_base(){
@@ -56,4 +57,4 @@ class running_mode_base {
     virtual void generate_output();
 };
 
-#endif
+#endif