Skip to content

Commit

Permalink
fixed PR suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
ZohairZaidi committed Sep 3, 2024
1 parent 0664ad9 commit c19e95f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 19 deletions.
17 changes: 8 additions & 9 deletions vpr/src/base/atom_netlist.h
Original file line number Diff line number Diff line change
Expand Up @@ -165,9 +165,9 @@ class AtomNetlist : public Netlist<AtomBlockId, AtomPortId, AtomPinId, AtomNetId
*/

/**
* @brief Create a new block in the netlist or returns an existing block.
If a block with the specified name already exists, the existing block's ID is returned
and no new block is created.
* @brief Create a new block in the netlist.
*
* @note If a block with the specified name already exists, the function will crash.
*
* @param name The unique name of the block
* @param model The primitive type of the block
Expand All @@ -178,18 +178,17 @@ class AtomNetlist : public Netlist<AtomBlockId, AtomPortId, AtomPinId, AtomNetId
AtomBlockId create_block(const std::string& name, const t_model* model, const TruthTable& truth_table = TruthTable());

/**
* @brief Create a new port in the netlist or return an existing port.
* If a port with the specified name already exists for the given block,
* the existing port's ID is returned, and no new port is created.
* @brief Create a new port in the netlist.
*
* @note If a port with the specified name already exists for the given block, the function will crash.
*
* @param blk_id The block the port is associated with
* @param model_port The model port the port is associated with
*/
AtomPortId create_port(const AtomBlockId blk_id, const t_model_ports* model_port);

/**
* @brief Create a new pin in the netlist or return an existing pin.
* If a pin with the specified ID already exists, it is returned, and no new pin is created.
* @brief Create a new pin in the netlist.
*
* @param port_id The port this pin is associated with
* @param port_bit The bit index of the pin in the port
Expand All @@ -200,7 +199,7 @@ class AtomNetlist : public Netlist<AtomBlockId, AtomPortId, AtomPinId, AtomNetId
AtomPinId create_pin(const AtomPortId port_id, BitIndex port_bit, const AtomNetId net_id, const PinType pin_type, bool is_const = false);

/**
* @brief Create an empty, or return an existing net in the netlist
* @brief Create a net in the netlist
*
* @param name The unique name of the net
*/
Expand Down
15 changes: 5 additions & 10 deletions vpr/src/base/clustered_netlist.h
Original file line number Diff line number Diff line change
Expand Up @@ -175,9 +175,7 @@ class ClusteredNetlist : public Netlist<ClusterBlockId, ClusterPortId, ClusterPi

public: //Public Mutators
/**
* @brief Create a new block in the netlist or return an existing block.
* If a block with the specified name already exists, the existing block's ID is returned,
* and no new block is created.
* @brief Create a new block in the netlist.
*
* @param name The unique name of the block
* @param pb The physical representation of the block
Expand All @@ -186,9 +184,7 @@ class ClusteredNetlist : public Netlist<ClusterBlockId, ClusterPortId, ClusterPi
ClusterBlockId create_block(const char* name, t_pb* pb, t_logical_block_type_ptr type);

/**
* @brief Create a new port in the netlist or return an existing port.
* If a port with the specified name already exists for the given block,
* the existing port's ID is returned, and no new port is created.
* @brief Create a new port in the netlist.
*
* @param blk_id The block the port is associated with
* @param name The name of the port (must match the name of a port in the block's model)
Expand All @@ -197,9 +193,8 @@ class ClusteredNetlist : public Netlist<ClusterBlockId, ClusterPortId, ClusterPi
*/
ClusterPortId create_port(const ClusterBlockId blk_id, const std::string& name, BitIndex width, PortType type);
/**
* @brief Create a new pin in the netlist or return an existing pin.
* If a pin with the specified ID already exists, the existing pin's ID is returned,
* and no new pin is created.
* @brief Create a new pin in the netlist.
* @note If a pin with the specified ID already exists, the function will crash.
*
* @param port_id The port this pin is associated with
* @param port_bit The bit index of the pin in the port
Expand All @@ -211,7 +206,7 @@ class ClusteredNetlist : public Netlist<ClusterBlockId, ClusterPortId, ClusterPi
ClusterPinId create_pin(const ClusterPortId port_id, BitIndex port_bit, const ClusterNetId net_id, const PinType pin_type, int pin_index, bool is_const = false);

/**
* @brief Create an empty, or return an existing net in the netlist
* @brief Create a net in the netlist
*
* @param name The unique name of the net
*/
Expand Down

0 comments on commit c19e95f

Please sign in to comment.