automaton-simulation-de.impl.stopping.criteria

Liking cljdoc? Tell your friends :D

All platforms.

api-data-to-entity
evaluates
model-end
out-of-model
schema
validate

Declares a stopping-criteria to instantiate stopping-definitions, it precises the params necessary for stopping-evaluation. The data are:

model-end? is set to true if the stopping-criteria is one possible end of the model. Note that more than one is possible for the same model. Note that these model stopping-criteria are not supposed to be linked with anything else than the business model itself (not the rendering, not the control/computation, ...)
params is a map of parameters, which content is defined by the stopping-definition.
stopping-definition is the stopping-definition as found in the stopping-registry.

![entities][archi/simulation_engine/stopping_stopping-criteria.png]

Declares a `stopping-criteria` to instantiate `stopping-definition`s, it precises the `params` necessary for `stopping-evaluation`.
The data are:

* `model-end?` is set to `true` if the stopping-criteria is one possible end of the model. Note that more than one is possible for the same model. Note that these model `stopping-criteria` are not supposed to be linked with anything else than the business model itself (not the rendering, not the control/computation, ...)
* `params` is a map of parameters, which content is defined by the `stopping-definition`.
* `stopping-definition` is the `stopping-definition` as found in the `stopping-registry`.

![entities][archi/simulation_engine/stopping_stopping-criteria.png]

raw docstring

api-data-to-entity^clj/s

(api-data-to-entity stopping-registry stopping-criteria)

Turns the api version of a stopping-criteria to one matching the entity schema.

Two forms are offered:

keyword for stopping-criteria that need no params.
[stopping-definition-id params] where stopping-definition-id is a keyword and params is a map.

All other forms are discarded.

Turns the `api` version of a `stopping-criteria` to one matching the entity `schema`.

Two forms are offered:

* `keyword` for stopping-criteria that need no params.
* `[stopping-definition-id params]` where `stopping-definition-id` is a keyword and `params` is a map.

All other forms are discarded.

raw docstring

evaluates^clj/s

(evaluates {:keys [params stopping-definition] :as stopping-criteria} snapshot)

Evaluates the stopping-criteria on snapshot.

Returns nil if stopping-evaluation is not defined. Returns a map with stop? and context.

Evaluates the `stopping-criteria` on `snapshot`.

Returns `nil` if `stopping-evaluation` is not defined.
Returns a map with `stop?` and `context`.

raw docstring

model-end^clj/s

(model-end stopping-criteria)

Set the stopping-criteria as one ending the model.

Set the `stopping-criteria` as one ending the model.

raw docstring

out-of-model^clj/s

(out-of-model stopping-criteria)

Set the stopping-criteria as one not ending the model.

Set the `stopping-criteria` as one not ending the model.

raw docstring

schema^clj/s

validate^clj/s

(validate stp-crt)

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close