docs(router/astar): Make some small improvements to docs

This commit is contained in:
Mikolaj Wielgus 2025-05-20 15:13:31 +02:00 committed by mikolaj
parent e79078e971
commit 464e8abb89
2 changed files with 8 additions and 7 deletions

View File

@ -37,8 +37,8 @@ impl<'a, CW: 'a, Cel: 'a, R: 'a> MakeRef<'a, Drawing<CW, Cel, R>> for Head {
} }
/// The head is bare when the routed band is not pulled out (i.e. is of zero /// The head is bare when the routed band is not pulled out (i.e. is of zero
/// length). This happens on the first routing step and when the routed band was /// length). This happens on the first routing step and when the routed band
/// completely contracted due to the routing algorithm backtracking. In these /// was completely retracted due to the routing algorithm backtracking. In these
/// situations a cane head cannot be used because there is obviously no cane /// situations a cane head cannot be used because there is obviously no cane
/// behind the face, and the face itself is fixed instead of loose. /// behind the face, and the face itself is fixed instead of loose.
#[derive(Debug, Clone, Copy)] #[derive(Debug, Clone, Copy)]

View File

@ -126,7 +126,9 @@ where
{ {
pub graph: G, pub graph: G,
pub visit_next: BinaryHeap<MinScored<K, G::NodeId>>, pub visit_next: BinaryHeap<MinScored<K, G::NodeId>>,
/// Also known as the g-scores, or just g.
pub scores: BTreeMap<G::NodeId, K>, pub scores: BTreeMap<G::NodeId, K>,
/// Also known as the f-scores, or just f.
pub estimate_scores: BTreeMap<G::NodeId, K>, pub estimate_scores: BTreeMap<G::NodeId, K>,
pub path_tracker: PathTracker<G>, pub path_tracker: PathTracker<G>,
pub maybe_curr_node: Option<G::NodeId>, pub maybe_curr_node: Option<G::NodeId>,
@ -170,11 +172,10 @@ pub enum AstarContinueStatus {
/// A* has now visited a new node. /// A* has now visited a new node.
/// ///
/// Quick recap if you have been trying to remember what is the difference /// Quick recap if you have been trying to remember what is the difference
/// between visiting and probing: when a node is visited, it is placed at /// between probing and visiting: probing is done as part of a scan of
/// the head of the current path, whereas probing is done as part of a scan /// neighboring nodes around the currently visited node to add them to the
/// that happens *around* the currently visited node. Suitable newly scanned /// priority queue, whereas when a node is visited it actually *becomes* the
/// nodes are added to a priority queue, from which A* only later takes out /// currently visited node.
/// elements to actually visit.
Visited, Visited,
} }