uk.ac.soton.simulation.jsit.anylogic

Class HyperArrayLookup<C extends java.lang.Enum<C>>

java.lang.Object

uk.ac.soton.simulation.jsit.core.AbstractStochasticItem

uk.ac.soton.simulation.jsit.anylogic.HyperArrayLookup<C>

All Implemented Interfaces:

java.io.Serializable

public class HyperArrayLookup<C extends java.lang.Enum<C>>
extends AbstractStochasticItem
implements java.io.Serializable

An enum-or-numeric-dimensions-indexed lookup array ('field') for categorical distributions using an AnyLogic HyperArray and related Dimensions (which provides a nice mechanism to edit this 'custom distribution field' and thus provide it as a model parameter), but using enums in the main model which can map to AnyLogic Dimension indices (via the DimConvertable interface). (We want to avoid using Dimensions directly in the model because---as static fields in a generated HyperArrays class with a single scope for alternative names---they aren't amenable to use as agent attributes.)

Since Dimension values will typically be returned from simulation Agents (e.g. querying death-in-year for an agent of particular gender and age-range), enums which match the dimensions need to be used internally, with the (zero-based) ordinals of given enum values used for querying this lookup.

As examples,

• probabilities (say of dieing per year) by age-range and gender → Binary lookup by Gender and AgeRange Dimension values, backed by a HyperArray of probabilities for Gender and AgeRange Dimensions;
• age range determined from empirical probabilities per gender AgeRange lookup by Gender Dimension value, also backed by a HyperArray of probabilities for Gender and AgeRange Dimensions, but with the probabilities representing the chance of being in that AgeRange for the given Gender.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HyperArrayLookup(java.lang.Class<C> categoryEnumType, com.anylogic.engine.HyperArray hyperArray)

Method Summary

Modifier and Type	Method and Description
C	sampleCategory(DimConvertable... dimIndexSources)
Sampler.Binary	sampleTrialOutcome(DimConvertable... dimIndexSources)

Methods inherited from class uk.ac.soton.simulation.jsit.core.AbstractStochasticItem

getSampler, registerAccessInfo, registerSampler

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperArrayLookup

public HyperArrayLookup(java.lang.Class<C> categoryEnumType,
                        com.anylogic.engine.HyperArray hyperArray)

Method Detail

sampleCategory

public C sampleCategory(DimConvertable... dimIndexSources)

sampleTrialOutcome

public Sampler.Binary sampleTrialOutcome(DimConvertable... dimIndexSources)