Skip to content

Commit

Permalink
docs: add motivating module docs string for cache
Browse files Browse the repository at this point in the history
  • Loading branch information
moldhouse committed Mar 17, 2024
1 parent 707a0e3 commit 646e4b6
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/cache.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
// Building the Graph from the distance matrix for each start point is computationally expensive.
// The cache stores the results of previous graph build and tries to understand if any item in the
// cache which is sufficiently similiar to the current candidate can be used to place an upper bound
// on the maximum achievable distance with this candidate.

use crate::graph::StartCandidate;
use flat_projection::FlatPoint;
use std::collections::HashSet;
Expand Down

0 comments on commit 646e4b6

Please sign in to comment.