Liking cljdoc? Tell your friends :D

blocks.summary

A 'summary' represents a collection of blocks, including certain statistics about the aggregate count and sizes. These are useful for returning from certain operations to represent the set of blocks acted upon.

The following fields are present in a summary:

  • :count The total number of blocks added to the summary.
  • :size The total size of blocks added to the summary, in bytes.
  • :sizes A histogram map from bucket exponent to a count of the blocks in that bucket (see size->bucket and bucket->range).
A 'summary' represents a collection of blocks, including certain statistics
about the aggregate count and sizes. These are useful for returning from
certain operations to represent the set of blocks acted upon.

The following fields are present in a summary:

- `:count`
  The total number of blocks added to the summary.
- `:size`
  The total size of blocks added to the summary, in bytes.
- `:sizes`
  A histogram map from bucket exponent to a count of the blocks in that
  bucket (see `size->bucket` and `bucket->range`).
raw docstring

bucket->rangeclj

(bucket->range n)

Returns a vector with the boundaries which a given size bucket covers.

Returns a vector with the boundaries which a given size bucket covers.
sourceraw docstring

initclj

(init)

Construct a new, empty summary.

Construct a new, empty summary.
sourceraw docstring

mergeclj

(merge a b)

Merge two summaries together.

Merge two summaries together.
sourceraw docstring

size->bucketclj

(size->bucket size)

Assigns a block size to an exponential histogram bucket. Given a size s, returns n such that 2^n <= s < 2^(n+1).

Assigns a block size to an exponential histogram bucket. Given a size `s`,
returns `n` such that `2^n <= s < 2^(n+1)`.
sourceraw docstring

updateclj

(update summary block)

Update the summary with the stats from the given block.

Update the summary with the stats from the given block.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close