mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-06-03 17:54:19 +02:00
Merge #16986: doc: Doxygen-friendly CuckooCache comments
7aad3b68e7doc: Doxygen-friendly CuckooCache comments (Jon Layton) Pull request description: Similar theme to #16947. - `invalid`, `contains` now appear in Doxygen docs - `setup` refers to correct argument name `b` - Argument references in `code blocks ` - Lists markdown conformant, uniform line endings Tested with `make docs` ACKs for top commit: laanwj: ACK7aad3b68e7practicalswift: ACK7aad3b68e7Tree-SHA512: 70b38c10e534bad9c6ffcd88cc7a4797644afba5956d47a6c7cc655fcd5857a91f315d6da60e28ce9678d420ed4a51e22267eb8b89e26002b99cad63373dd349
This commit is contained in:
@@ -10,11 +10,11 @@
|
||||
|
||||
/** Test Suite for CuckooCache
|
||||
*
|
||||
* 1) All tests should have a deterministic result (using insecure rand
|
||||
* 1. All tests should have a deterministic result (using insecure rand
|
||||
* with deterministic seeds)
|
||||
* 2) Some test methods are templated to allow for easier testing
|
||||
* 2. Some test methods are templated to allow for easier testing
|
||||
* against new versions / comparing
|
||||
* 3) Results should be treated as a regression test, i.e., did the behavior
|
||||
* 3. Results should be treated as a regression test, i.e., did the behavior
|
||||
* change significantly from what was expected. This can be OK, depending on
|
||||
* the nature of the change, but requires updating the tests to reflect the new
|
||||
* expected behavior. For example improving the hit rate may cause some tests
|
||||
@@ -82,9 +82,9 @@ static double test_cache(size_t megabytes, double load)
|
||||
*
|
||||
* Examples:
|
||||
*
|
||||
* 1) at load 0.5, we expect a perfect hit rate, so we multiply by
|
||||
* 1. at load 0.5, we expect a perfect hit rate, so we multiply by
|
||||
* 1.0
|
||||
* 2) at load 2.0, we expect to see half the entries, so a perfect hit rate
|
||||
* 2. at load 2.0, we expect to see half the entries, so a perfect hit rate
|
||||
* would be 0.5. Therefore, if we see a hit rate of 0.4, 0.4*2.0 = 0.8 is the
|
||||
* normalized hit rate.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user