enrich docs

src/algorithm/Multimodal/Heuristics/MultimodalModularHeuristic.h

@@ -24,15 +24,33 @@
 
 class MultimodalModularHeuristic {
 private:
-    //Exterior members
+    //Exterior members that the algorithm references or acts upon
     const Graph* _graph{nullptr};
     const std::vector<Request>* _requestsVect{nullptr};
     SAEVRoute* _route{nullptr}; //_route is a pointer here to decorrelate the route from the algorithm and facilitate using multiple modules on the same route
 
+    /**
+     * Vector holding every entry sub request created to prevent refs staleness
+     * while letting the requests vector hold only the base requests \n
+     * \n
+     * Initialized with empty requests to match the number of base requests in the constructor
+     */
     std::vector<Request> _entrySubRequests;
+    /**
+     * Vector holding every exit sub request created to prevent refs staleness
+     * while letting the requests vector hold only the base requests\n
+     * \n
+     * Initialized with empty requests to match the number of base requests in the constructor
+     */
     std::vector<Request> _exitSubRequests;
 
+    /**
+     * Marks unfulfilled entry requests due to not finding a single viable candidate
+     */
     std::vector<bool> _unfulfilledTransitEntry;
+    /**
+     * Marks unfulfilled exit requests due to not finding a single viable candidate
+     */
     std::vector<bool> _unfulfilledTransitExit;
 
     //Add friend test classes to test inner workings without making the whole API public
@@ -177,8 +195,6 @@ protected:
 
     void updateSubRequest(size_t requestId, const Request &request, bool isEntry);
 
-    [[nodiscard]] size_t getSubrequestIndex(size_t requestId, bool isEntry) const;
-
     const Request &getSubrequest(size_t requestId, bool isEntry);
 
     [[nodiscard]] double getTransitExitScore(size_t transitExitNodeIndex, size_t requestDestinationNodeIndex,