add note for explaining data structure std::map<std::size_t, std::set<std::size_t>> in TelegramOptions::get_map_of_sets

w0lek · w0lek · commit c63477551d32 · 2024-06-07T15:47:13.000+03:00
diff --git a/vpr/src/server/telegramoptions.h b/vpr/src/server/telegramoptions.h
@@ -62,6 +62,8 @@ class TelegramOptions {
      *
      * This function retrieves a map of sets associated with the specified key.
      *
+     * @note The map of sets is used to store the critical path index (map key) and the associated set of selected sub-path element indexes (map value).
+     *
      * @param key The key of the map of sets to retrieve.
      * @return The map of sets associated with the specified key.
      */

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,8 @@ class TelegramOptions {`
`62`	`62`	`*`
`63`	`63`	`* This function retrieves a map of sets associated with the specified key.`
`64`	`64`	`*`
	`65`	`+ * @note The map of sets is used to store the critical path index (map key) and the associated set of selected sub-path element indexes (map value).`
	`66`	`+ *`
`65`	`67`	`* @param key The key of the map of sets to retrieve.`
`66`	`68`	`* @return The map of sets associated with the specified key.`
`67`	`69`	`*/`