Class Accumulator
Accumulator base class.

All Subcl's AverageAccumulator
Defined in <seqan/misc/accumulators.h>
Signature template <typename TValue, typename TSpec> struct Accumulator;

Template Parameters

TSpec The specialization tag.
TValue The type of the values to accumulate.

Interface Function Overview

Interface Metafunction Overview

Detailed Description

Accumulators are for computing statistics on streams of values.

Currently, this is only meant for accumulating integers.

Interface Functions Detail

void clear(acc);

Clear the current accumulator state.

Parameters

acc The Accumulator to clear.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

void push(acc, x);

Include value into sequence of values to accumulate.

Parameters

acc The Accumulator to push the value to.
x The value to include in the accumulation (IntegerConcept).

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

Interface Metafunctions Detail

Result<TAccumulator>::Type;

Return the type for accumulation results.

Template Parameters

TAccumulator The Accumulator type to query.

Returns

Type The result type.

Value<TAccumulator>::Type;

Return the type of the values to accumulate.

Template Parameters

TAccumulator The Accumulator type to query.

Returns

Type The value type.