Liking cljdoc? Tell your friends :D

automaton-optimization.time-based.impl.aggregator-item

An aggregator-item enriches an aggregate with start-bucket-aggregate and end-bucket-aggregate. Many aggregator-item are contained in an aggregator.

Note that no test mechanisms are here to check values of the aggregator-item, the aggregate and aggregates are here to deal with these tests and are responsible to built some valid aggregator-item.

Aggregator-item entity diagram

An `aggregator-item` enriches an `aggregate` with `start-bucket-aggregate` and `end-bucket-aggregate`.
Many `aggregator-item` are contained in an `aggregator`.

Note that no test mechanisms are here to check values of the `aggregator-item`, the `aggregate` and `aggregates` are here to deal with these tests and are responsible to built some valid `aggregator-item`.

![Aggregator-item entity diagram](archi/time_based/aggregator-item.png)
raw docstring

bucket-aggregateclj/s

(bucket-aggregate {:automaton-optimization.time-based/keys [start-bucket
                                                            end-bucket]
                   :as aggregator}
                  bucket)

Returns the bucket-aggregate matching bucket in the aggregator.

Returns the `bucket-aggregate` matching `bucket` in the `aggregator`.
raw docstring

bucket-rangeclj/s

(bucket-range {:automaton-optimization.time-based/keys
                 [start-bucket step start-bucket-aggregate end-bucket-aggregate]
               :as _aggregator}
              bucket-aggregate)

Returns the range of bucket matching bucket-aggregate in the aggregator.

Returns the range of `bucket` matching `bucket-aggregate` in the `aggregator`.
raw docstring

bucket-to-bucket-aggregateclj/s

(bucket-to-bucket-aggregate {:automaton-optimization.time-based/keys
                               [start-bucket-aggregate step end-bucket-aggregate
                                start-bucket end-bucket]
                             :as _aggregator})

Returns an array matching the bucket to its bucket-aggregate based on aggregator definition. First element in the array is the bucket-aggregate of start-bucket, next is the bucket-aggregate of start-bucket+1, ...

Returns an array matching the `bucket` to its `bucket-aggregate` based on `aggregator` definition.
First element in the array is the `bucket-aggregate` of `start-bucket`, next is the `bucket-aggregate` of `start-bucket+1`, ...
raw docstring

buildclj/s

(build start-bucket-aggregate aggregator)

Buids and returns an aggregator, based on start-bucket-aggregate start-bucket end-bucket step.

Buids and returns an `aggregator`, based on `start-bucket-aggregate` `start-bucket` `end-bucket` `step`.
raw docstring

calculate-end-bucket-aggregateclj/s

(calculate-end-bucket-aggregate
  {:automaton-optimization.time-based/keys [end-bucket] :as aggregator})

Calculate the end-bucket-aggregate field in aggregator.

Calculate the `end-bucket-aggregate` field in `aggregator`.
raw docstring

concerns-bucket-aggregate?clj/s

(concerns-bucket-aggregate? bucket-aggregate
                            {:automaton-optimization.time-based/keys
                               [start-bucket-aggregate end-bucket-aggregate]
                             :as _aggregator})

Returns true if the bucket-aggregate is in the range of the bucket-aggregate definition. So it is between fields:

  • the start-bucket-aggregate field is mandatory in the definition
  • the end-bucket-aggregate field is optional as the aggregate could end at infinite
Returns `true` if the `bucket-aggregate` is in the range of the `bucket-aggregate` definition. So it is between fields:

* the `start-bucket-aggregate` field is mandatory in the definition
* the `end-bucket-aggregate` field is optional as the aggregate could end at infinite
raw docstring

concerns-bucket?clj/s

(concerns-bucket? bucket
                  {:automaton-optimization.time-based/keys [start-bucket
                                                            end-bucket]
                   :as _aggregator})

Returns true if the bucket is between start-bucket and end-bucket. Note that the start-bucket field is mandatory in the definition, but the end-bucket field is optional.

If end-bucket is nil, it is interpretated as infinite.

Returns `true` if the `bucket` is between `start-bucket` and `end-bucket`.
Note that the `start-bucket` field is mandatory in the definition, but the `end-bucket` field is optional.

If `end-bucket` is `nil`, it is interpretated as infinite.
raw docstring

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

× close