Skip to content

Commit a78c83e

Browse files
Document the SMALL_NET caveat on bb_num_on_edges and drop a stale sentinel claim
1 parent 1dbc124 commit a78c83e

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

vpr/src/place/net_cost_handler.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,8 @@ class NetCostHandler {
208208
/// Number of blocks on each edge of the bounding box.
209209
/// Only maintained for nets with at least SMALL_NET sinks.
210210
t_bb num_on_edges;
211-
/// Wirelength (bounding box) cost of the net. Negative means not computed yet.
211+
/// Wirelength (bounding box) cost of the net.
212+
/// Negative until comp_bb_cong_cost() computes it for the first time.
212213
double cost = -1.;
213214
};
214215

@@ -495,6 +496,8 @@ class NetCostHandler {
495496

496497
// Bounding-box getters
497498
public:
499+
/// @brief Returns the number of blocks on each edge of the net's bounding box.
500+
/// Only maintained for nets with at least SMALL_NET sinks, and undefined for smaller ones.
498501
inline const t_bb& bb_num_on_edges(ClusterNetId net_id) const { return net_bb_[net_id].num_on_edges; }
499502

500503
inline const t_bb& bb_coords(ClusterNetId net_id) const { return net_bb_[net_id].coords; }

0 commit comments

Comments
 (0)