Mention latency/throughput tradeoff

This commit is contained in:
2024-05-06 12:49:06 -07:00
parent 745f0a14a3
commit 411c1a1070

View File

@@ -73,11 +73,11 @@ struct VersionedMap {
/** Reclaim mutations older than `version`. Must be <= `getVersion()`. /** Reclaim mutations older than `version`. Must be <= `getVersion()`.
* Postcondition: `getOldestVersion()` == `version`. @warning performs work * Postcondition: `getOldestVersion()` == `version`. @warning performs work
* proportional to the mutation rate. Call frequently to favor * proportional to the mutation rate. Call frequently to favor latency and
* memory usage, and infrequently to favor speed. @warning Invalidates any * memory usage, and infrequently to favor throughput. @warning Invalidates
* iterator from a version less than `version`. There shouldn't be any anyway * any iterator from a version less than `version`. There shouldn't be any
* because you should have already applied all mutations through `version` to * anyway because you should have already applied all mutations through
* your unversioned data structure. */ * `version` to your unversioned data structure. */
void setOldestVersion(int64_t version); void setOldestVersion(int64_t version);
/** The version of the most recent call to `addMutations`. */ /** The version of the most recent call to `addMutations`. */