add doxygen commetns

Author: soheilshahrouz

vpr/src/base/blk_loc_registry.h

@@ -1,5 +1,5 @@
-#ifndef VTR_BLK_LOC_REGISTRY_H
-#define VTR_BLK_LOC_REGISTRY_H
+
+#pragma once
 
 #include "clustered_netlist_fwd.h"
 #include "vtr_vector_map.h"
@@ -44,7 +44,8 @@ class BlkLocRegistry {
      */
     PlaceMacros place_macros_;
 
-    ///@brief Stores ClusterBlockId of all movable clustered blocks (blocks that are not locked down to a single location)
+    /// @brief Stores ClusterBlockId of all movable clustered blocks
+    /// (blocks that are not locked down to a single location)
     std::vector<ClusterBlockId> movable_blocks_;
 
     ///@brief Stores ClusterBlockId of all movable clustered of each block type
@@ -72,10 +73,18 @@ class BlkLocRegistry {
     ///@brief Returns a mutable reference to placement macros.
     PlaceMacros& mutable_place_macros();
 
+    /// @brief Returns a constant reference to the vector of ClusterBlockIds of all movable clustered blocks.
     const std::vector<ClusterBlockId>& movable_blocks() const { return movable_blocks_; }
+
+    /// @brief Returns a mutable reference to the vector of ClusterBlockIds of all movable clustered blocks.
     std::vector<ClusterBlockId>& mutable_movable_blocks() { return movable_blocks_; }
 
+    /// @brief Returns a constant reference to a vector of vectors, where each inner vector contains ClusterBlockIds
+    ///        of movable clustered blocks for a specific block type
     const std::vector<std::vector<ClusterBlockId>>& movable_blocks_per_type() const { return movable_blocks_per_type_; }
+
+    /// @brief Returns a mutable reference to a vector of vectors, where each inner vector contains ClusterBlockIds
+    ///        of movable clustered blocks for a specific block type.
     std::vector<std::vector<ClusterBlockId>>& mutable_movable_blocks_per_type() { return movable_blocks_per_type_; }
 
     /**
@@ -161,5 +170,3 @@ class BlkLocRegistry {
 
     e_expected_transaction expected_transaction_;
 };
-
-#endif //VTR_BLK_LOC_REGISTRY_H

vpr/src/place/move_generators/move_generator.h

@@ -1,5 +1,5 @@
-#ifndef VPR_MOVE_GENERATOR_H
-#define VPR_MOVE_GENERATOR_H
+
+#pragma once
 
 #include "vpr_types.h"
 #include "move_utils.h"
@@ -35,7 +35,11 @@ struct MoveTypeStat {
     vtr::NdMatrix<int, 2> rejected_moves;
 
     /**
-     * @brief Prints placement perturbation distribution by block and move type.
+     * @brief Prints statistics on the distribution of placement perturbations,
+     *        categorized by block type and move type.
+     * @param movable_blocks_per_type A vector of vectors, where each inner vector contains ClusterBlockIds of
+     *                                all movable blocks belonging to a specific logical type. The outer vector
+     *                                is indexed by the logical type index.
      */
     void print_placement_move_types_stats(const std::vector<std::vector<ClusterBlockId>>& movable_blocks_per_type) const;
 

vpr/src/place/move_generators/simpleRL_move_generator.h

@@ -106,8 +106,10 @@ class KArmedBanditAgent {
   private:
     /**
      * @brief Iterates over all logical block types and check whether they exist in the
-     * netlist. Then, returns the logical block type indices found in the netlist.
-     *
+     *        netlist. Then, returns the logical block type indices found in the netlist.
+     * @param movable_blocks_per_type A vector of vectors, where each inner vector contains ClusterBlockIds of
+     *                                all movable blocks belonging to a specific logical type. The outer vector
+     *                                is indexed by the logical type index.
      * @return A vector containing all logical block type indices that exist in the netlist.
      */
     static std::vector<int> get_available_logical_blk_types_(const std::vector<int>& num_movable_blocks_per_type);
@@ -179,11 +181,17 @@ class SoftmaxAgent : public KArmedBanditAgent {
   private:
     /**
      * @brief Initialize agent's Q-table and internal variable to zero (RL-agent learns everything throughout the placement run and has no prior knowledge)
+     * @param movable_blocks_per_type A vector of vectors, where each inner vector contains ClusterBlockIds of
+     *                                all movable blocks belonging to a specific logical type. The outer vector
+     *                                is indexed by the logical type index.
      */
     void init_q_scores_(const std::vector<int>& num_movable_blocks_per_type);
 
     /**
      * @brief Calculate the fraction of total netlist blocks for each agent block type and will be used by the "set_action_prob" function.
+     * @param movable_blocks_per_type A vector of vectors, where each inner vector contains ClusterBlockIds of
+     *                                all movable blocks belonging to a specific logical type. The outer vector
+     *                                is indexed by the logical type index.
      */
     void set_block_ratio_(const std::vector<int>& num_movable_blocks_per_type);
 

vpr/src/place/move_utils.h

@@ -184,6 +184,7 @@ ClusterBlockId propose_block_to_move(const t_placer_opts& placer_opts,
  * @param logical_blk_type_index The logical type of the moving block. If a negative value is passed,
  * the block is selected randomly from all movable blocks and not from a specific type.
  * @param rng A random number generator used to select a random block.
+ * @param blk_loc_registry Contains movable blocks and movable blocks per type.
  * 
  * @return BlockId of the selected block, ClusterBlockId::INVALID() if no block with specified block type found
  */

vpr/src/place/placement_log_printer.h

@@ -61,7 +61,7 @@ class PlacementLogPrinter {
     void print_initial_placement_stats() const;
     /// Prints final placement metrics and generates timing reports.
     void print_post_placement_stats() const;
-    ///
+    /// Returns a bool to indicate whether the instance is in quiet mode.
     bool quiet() const { return quiet_; }
 
   private: