Commit 0dadd250 authored by Dominik Charousset's avatar Dominik Charousset

Improve documentation of inbound_path

parent d3ea583a
...@@ -80,13 +80,19 @@ public: ...@@ -80,13 +80,19 @@ public:
/// Stores statistics for measuring complexity of incoming batches. /// Stores statistics for measuring complexity of incoming batches.
struct stats_t { struct stats_t {
/// Wraps a time measurement for a single processed batch.
struct measurement { struct measurement {
/// Number of items in the batch.
long batch_size; long batch_size;
/// Elapsed time for processing all elements of the batch.
timespan calculation_time; timespan calculation_time;
}; };
/// Wraps the resulf of `stats_t::calculate()`.
struct calculation_result { struct calculation_result {
/// Number of items per credit cycle.
long max_throughput; long max_throughput;
/// Number of items per batch to reach the desired batch commplexity.
long items_per_batch; long items_per_batch;
}; };
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment