[fix] 给代码添加注释

Author: rakanyjc

lab3/Design.cpp

@@ -45,7 +45,7 @@ void Design::addNet(Net &net) {     // 给design添加net
     nets.push_back(&net);
 }
 
-bool Design::verifyRouting() {      // 检查是否布线成功
+bool Design::verifyRouting() {
     // Check that each net can route successfully
     for(auto net : nets) {
         bool success = net->verifyRouting();

lab3/Design.h

@@ -16,14 +16,14 @@ class Design {
     virtual ~Design();
 
 private:
-    vector<Net *> nets;
+    vector<Net *> nets; // 用于存放net的数组
 
 public:
-    void addNet(Net &net);
-    int getNumNets() { return nets.size(); }
-    Net &getNet(int idx) { return *(nets[idx]); }
-    vector<Net*> &getNets() { return nets; }
-    bool verifyRouting();
+    void addNet(Net &net);  // 添加net
+    int getNumNets() { return nets.size(); }    // 获得net的数量
+    Net &getNet(int idx) { return *(nets[idx]); }   // 获得指定序号的net
+    vector<Net*> &getNets() { return nets; }    // 获得net数组
+    bool verifyRouting();   // 检查是否布线成功
 };
 
 #endif

lab3/FPGA.h

@@ -14,18 +14,18 @@ class FPGA{
     virtual ~FPGA();
 
 private:
-    int N;
-    int W;
-    map<int, map<int, FpgaTile *>> tileMap;
-    vector<FpgaTile *> tiles;
+    int N;  // FPGA的大小
+    int W;  // 布线通道宽度
+    map<int, map<int, FpgaTile *>> tileMap; // FPGA块的映射
+    vector<FpgaTile *> tiles;   // FPGA块数组
 
 public:
-    FpgaTile &getTile(int x, int y) { return *(tileMap[x][y]); }
-    vector<FpgaTile *> &getTiles() { return tiles; }
+    FpgaTile &getTile(int x, int y) { return *(tileMap[x][y]); }    // 获得坐标为(x,y)的FPGA块
+    vector<FpgaTile *> &getTiles() { return tiles; }    // 获得FPGA块数组
 
-    int getN() { return N; }
-    int getW() { return W; }
-    int getNumSegmentsUsed();
+    int getN() { return N; }    // 获得FPGA的大小
+    int getW() { return W; }    // 获得布线通道宽度
+    int getNumSegmentsUsed();   // 获得布线后Routing Segment的数量
 };
 
 #endif

lab3/FpgaTile.h

@@ -20,49 +20,50 @@ class FpgaTile{
     int y;
     int W;
 
+    // 指向相邻的FPGA块的指针
     FpgaTile *left;
     FpgaTile *right;
     FpgaTile *up;
     FpgaTile *down;
 
-    map<int, RRNode *> logicPin;
-    vector<RRNode *> vWires;
-    vector<RRNode *> hWires;
+    map<int, RRNode *> logicPin;    // 逻辑块引脚
+    vector<RRNode *> vWires;    // 垂直导线
+    vector<RRNode *> hWires;    // 水平导线
 
-    vector<RRNode *> rrNodes;
+    vector<RRNode *> rrNodes;   // 该FPGA块拥有的布线资源节点（导线或引脚）
 
 public:
-    int getX() { return x; }
-    int getY() { return y; }
+    int getX() { return x; }    // 获得FPGA块的x坐标
+    int getY() { return y; }    // 获得FPGA块的y坐标
 
-    vector<RRNode *> &getRRNodes() { return rrNodes; }
+    vector<RRNode *> &getRRNodes() { return rrNodes; }  // 获得该FPGA块拥有的布线资源节点
 
-    FpgaTile *getDown() const { return down; }
-    void setDown(FpgaTile *down) { this->down = down; }
+    FpgaTile *getDown() const { return down; }  // 获得该FPGA块下方的FPGA块
+    void setDown(FpgaTile *down) { this->down = down; } // 设置该FPGA块的下方FPGA块
 
-    FpgaTile *getUp() const { return up; }
-    void setUp(FpgaTile *up) { this->up = up; }
+    FpgaTile *getUp() const { return up; }  // 获得该FPGA块上方的FPGA块
+    void setUp(FpgaTile *up) { this->up = up; } // 设置该FPGA块的上方FPGA块
 
-    FpgaTile *getLeft() const { return left; }
-    void setLeft(FpgaTile *left) { this->left = left; }
+    FpgaTile *getLeft() const { return left; }  // 获得该FPGA块左边的FPGA块
+    void setLeft(FpgaTile *left) { this->left = left; } // 设置该FPGA块的左边FPGA块
 
-    FpgaTile *getRight() const { return right; }
-    void setRight(FpgaTile *right) { this->right = right; }
+    FpgaTile *getRight() const { return right; }    // 获得该FPGA块右边的FPGA块
+    void setRight(FpgaTile *right) { this->right = right; } // 设置该FPGA块的右边FPGA块
 
     void generateContents();
     void populateSwitchbox();
 
-    RRNode &getLogicPin(int idx) {
+    RRNode &getLogicPin(int idx) {  // 获得逻辑块的idx引脚
         assert(logicPin.find(idx) != logicPin.end());
         return *(logicPin[idx]);
     }
 
-    RRNode &getVWire(int idx) {
+    RRNode &getVWire(int idx) {     // 获得FPGA块的垂直导线
         assert((size_t) idx < vWires.size());
         return *(vWires[idx]);
     }
 
-    RRNode &getHWire(int idx) {
+    RRNode &getHWire(int idx) {     // 获得FPGA块的水平导线
         assert((size_t) idx < hWires.size());
         return *(hWires[idx]);
     }

lab3/Net.h

@@ -13,22 +13,22 @@ class Net{
     virtual ~Net();
 
 private:
-    RRNode &source;
-    int idx;
-    set<RRNode *> sinks;
-    set<RRNode *> usedRRs;
+    RRNode &source; // net的起始引脚
+    int idx;    // net编号
+    set<RRNode *> sinks;    // net的目标引脚数组
+    set<RRNode *> usedRRs;  // 布线的路径
 
 public:
-    void addSink(RRNode &dest);
-    RRNode &getSource() { return source; }
-    std::set<RRNode *> &getSinks() { return sinks; }
-    void finalizeRouting();
-
-    void clearPath() { usedRRs.clear(); }
-    void addRRToPath(RRNode &node) { usedRRs.insert(&node); }
-    std::set<RRNode *> &getPath() { return usedRRs; }
-    int getIdx() { return idx; }
-    bool verifyRouting();
+    void addSink(RRNode &dest); // 添加目标引脚
+    RRNode &getSource() { return source; }  // 获得起始引脚
+    std::set<RRNode *> &getSinks() { return sinks; }    // 获得目标引脚数组
+    void finalizeRouting(); // 根据布线的路径设置布线资源节点所属的net
+
+    void clearPath() { usedRRs.clear(); }   // 清空路径
+    void addRRToPath(RRNode &node) { usedRRs.insert(&node); }   // 给布线路径添加node
+    std::set<RRNode *> &getPath() { return usedRRs; }   // 获得布线路径
+    int getIdx() { return idx; }    // 获得net的编号
+    bool verifyRouting();   // 检查布线是否成功
 };
 
 #endif

lab3/RRNode.h

@@ -12,31 +12,31 @@ class Net;
 class RRNode{
 public:
     enum rrType { H_WIRE, V_WIRE, CB_WIRE };
-    const char *rrTypeStr[3] = {"H_WIRE", "V_WIRE", "CB_WIRE"};
+    const char *rrTypeStr[3] = {"H_WIRE", "V_WIRE", "CB_WIRE"}; // 分别对应水平导线，垂直导线，逻辑块引脚
 
     RRNode(rrType type, int x, int y, int idx);
     virtual ~RRNode();
 
 private:
-    vector<RRNode *> connections;
-    rrType type;
-    int x;
-    int y;
-    int idx;
-    Net *net;
+    vector<RRNode *> connections;   // 该布线资源节点与其他布线资源节点的连接关系
+    rrType type;    // 布线资源节点类型
+    int x;      // 布线资源节点所属的FPGA块的x坐标
+    int y;      // 布线资源节点所属的FPGA块的y坐标
+    int idx;    // 布线资源节点编号
+    Net *net;   // 布线资源节点所属的net
 
 public:
-    void connect(RRNode &node);
-    bool isConnected(RRNode &node);
-    rrType getType() { return type; }
-    int getX() { return x; }
-    int getY() { return y; }
-    int getIdx() { return idx; }
-
-    bool isUsed() { return net != nullptr; }
-    void setNet(Net &net);
-    Net *getNet() { return net; }
-    std::vector<RRNode *> &getConnections() { return connections; }
+    void connect(RRNode &node);         // 将该布线资源节点与node连接
+    bool isConnected(RRNode &node);     // 检查该布线资源节点是否与node连接
+    rrType getType() { return type; }   // 获得布线资源节点类型
+    int getX() { return x; }            // 获得布线资源节点的x坐标
+    int getY() { return y; }            // 获得布线资源节点的y坐标
+    int getIdx() { return idx; }        // 获得布线资源节点的编号
+
+    bool isUsed() { return net != nullptr; }    // 检查布线资源节点是否已使用
+    void setNet(Net &net);              // 设置该布线资源节点所属的net
+    Net *getNet() { return net; }       // 获得该布线资源节点所属的net
+    std::vector<RRNode *> &getConnections() { return connections; } // 获得该布线资源节点与其他布线资源节点的连接关系
 
     friend std::ostream &operator<<(std::ostream &out, RRNode const &node) {
         out << "RRNode (" << node.x << ", " << node.y << ")."