Statistics

:idprefix: stats_

Open-addressing and concurrent containers can be configured to keep running statistics of some internal operations affected by the quality of the supplied hash function.

Synopsis

__stats-summary-type__

Provides the average value, variance and standard deviation of a sequence of numerical values.

__insertion-stats-type__

Provides the number of insertion operations performed by a container and statistics on the associated __probe length__ (number of xref:structures.adoc#structures_open_addressing_containers[bucket groups] accessed per operation).

__lookup-stats-type__

For successful (element found) or unsuccessful (not found) lookup, provides the number of operations performed by a container and statistics on the associated __probe length__ (number of xref:structures.adoc#structures_open_addressing_containers[bucket groups] accessed) and number of element comparisons per operation.

__stats-type__

Provides statistics on insertion, successful and unsuccessful lookups performed by a container. If the supplied hash function has good quality, then:

Average probe lenghts should be close to 1.0.

For successful lookups, the average number of element comparisons should be close to 1.0.

For unsuccessful lookups, the average number of element comparisons should be close to 0.0.

These statistics can be used to determine if a given hash function can be marked as link:../../../../../container_hash/doc/html/hash.html#ref_hash_is_avalanchinghash[__avalanching__].

---