ikr.simlib.statistics.conditional

Class ConditionalStatisticBase<K,S extends ResultTaggable>

java.lang.Object

ikr.simlib.statistics.conditional.ConditionalStatisticBase<K,S>

Type Parameters:

K - type of the key, a.k.a conditioner

S - type of the statistic

Direct Known Subclasses:

ConditionalUnweightedStatisticBase, ConditionalWeightedStatisticBase

public abstract class ConditionalStatisticBase<K,S extends ResultTaggable>
extends java.lang.Object

Base class for conditional statistics. The conditioner / key can be any type and is specified by the generic parameter K. Also the type of the statistic is generic and specified by the generic type S.

Three constructors are provided for different use cases.

• ConditionalStatisticBase(SimNode, Class, StatisticCreator, Iterable, StatisticTagger) is intended to be used with generic discrete keys. All possible keys have to be provided at initialization time, so that the statistics can be created before the simulation starts. Make sure that the Iterable always returns the keys in the same order (i.e. don't iterate over a HashSet ), otherwise the order of the statistics is undefined and import simulations will fail.
• ConditionalStatisticBase(SimNode, Class, StatisticCreator, BucketUtility) is intended to be used with continuous double keys, which are mapped to discrete buckets by a BucketUtility.
• ConditionalStatisticBase(SimNode, Class, StatisticCreator, int) is a convenience constructor to be used with integer keys. Keys start at zero. For other use cases with integer keys use the generic constructor.

All constructors require the class of the key as parameter. This is used for type-checking at runtime, which is not possible with java generics alone.

In addition, the constructors require an instance of a ConditionalStatisticBase.StatisticCreator. This is a function which creates new instances of the intended statistic class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConditionalStatisticBase.StatisticCreator<S extends ResultTaggable>
static interface	ConditionalStatisticBase.StatisticTagger<K,S extends ResultTaggable>
static interface	ConditionalStatisticBase.ToIndexMapper<K>

Field Summary

Fields

Modifier and Type	Field and Description
static ConditionalStatisticBase.StatisticTagger<java.lang.Object,ResultTaggable>	TO_STRING_TAGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConditionalStatisticBase(SimNode ownNode, java.lang.Class<K> keyClass, ConditionalStatisticBase.StatisticCreator<? extends S> statCreator, BucketUtility bucketUtility) for doubles (lin or log spaced mapping)
protected	ConditionalStatisticBase(SimNode ownNode, java.lang.Class<K> keyClass, ConditionalStatisticBase.StatisticCreator<? extends S> statCreator, int numBuckets) for integers (0..numBuckets-1)
protected	ConditionalStatisticBase(SimNode ownNode, java.lang.Class<K> keyClass, ConditionalStatisticBase.StatisticCreator<? extends S> statCreator, java.lang.Iterable<? extends K> keys, ConditionalStatisticBase.StatisticTagger<? super K,? super S> tagger) for enumerable keys

Method Summary

Methods

Modifier and Type	Method and Description
protected S	getStatistic(K key)
void	registerKey(K key) register an additional key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TO_STRING_TAGGER

public static ConditionalStatisticBase.StatisticTagger<java.lang.Object,ResultTaggable> TO_STRING_TAGGER

Constructor Detail

ConditionalStatisticBase

protected ConditionalStatisticBase(SimNode ownNode,
                        java.lang.Class<K> keyClass,
                        ConditionalStatisticBase.StatisticCreator<? extends S> statCreator,
                        java.lang.Iterable<? extends K> keys,
                        ConditionalStatisticBase.StatisticTagger<? super K,? super S> tagger)

for enumerable keys

ConditionalStatisticBase

protected ConditionalStatisticBase(SimNode ownNode,
                        java.lang.Class<K> keyClass,
                        ConditionalStatisticBase.StatisticCreator<? extends S> statCreator,
                        BucketUtility bucketUtility)

for doubles (lin or log spaced mapping)

ConditionalStatisticBase

protected ConditionalStatisticBase(SimNode ownNode,
                        java.lang.Class<K> keyClass,
                        ConditionalStatisticBase.StatisticCreator<? extends S> statCreator,
                        int numBuckets)

for integers (0..numBuckets-1)

Method Detail

getStatistic

protected S getStatistic(K key)

registerKey

public void registerKey(K key)

register an additional key. A new statistic is created, tagged, and added to the internal lookup map.

Attention if keys are added at simulation runtime, it is not possible to import batch results, because the structure of the export file does not match the objects instantiated at import time.

Parameters:

key - the new key