uk.ac.soton.simulation.jsit.core

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

java.lang.Object

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

uk.ac.soton.simulation.jsit.core.Distribution

uk.ac.soton.simulation.jsit.core.DistributionDiscrete

uk.ac.soton.simulation.jsit.core.DistributionCategorical<C>

uk.ac.soton.simulation.jsit.core.DistUniformDiscrete<C>

All Implemented Interfaces:

java.io.Serializable, ContinuousSampler

public class DistUniformDiscrete<C extends java.lang.Enum<C>>
extends DistributionCategorical<C>
implements java.io.Serializable

JSIT representation of the discrete uniform distribution.

Since:

0.1

Author:

Stuart Rossiter

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class uk.ac.soton.simulation.jsit.core.DistributionCategorical

DistributionCategorical.Range

Field Summary

Fields inherited from class uk.ac.soton.simulation.jsit.core.DistributionDiscrete

CUMULATIVE_PROB_TOLERANCE

Constructor Summary

Constructors

Constructor and Description
DistUniformDiscrete(java.lang.Class<C> categoryEnumType) Create an instance where sampling returns a Java enum category.
DistUniformDiscrete(int min, int max) Create an instance returning an integer value from a single range.

Method Summary

Modifier and Type	Method and Description
Distribution	createUnregisteredCopy() Create an unregistered copy of this distribution.
DistributionCategorical.Range	getRange() Get the Range (DistributionCategorical.Range) for this distribution.
void	setRange(int min, int max) Change or add a range for the distribution.
java.lang.String	toString() Custom toString implementation.

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

addRange, clearRanges, getK, isLocked, lock, sampleCategory, unlock, usesEnumCategory, usesMappedRanges

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

sampleDouble, sampleInt

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

createRegisteredCopy

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, wait, wait, wait

Constructor Detail

DistUniformDiscrete

public DistUniformDiscrete(java.lang.Class<C> categoryEnumType)

Create an instance where sampling returns a Java enum category.

Parameters:

categoryEnumType - The type (Class instance) of the category enum.

Since:

0.1

DistUniformDiscrete

public DistUniformDiscrete(int min,
                           int max)

Create an instance returning an integer value from a single range.

Parameters:

min - The range minimum.

max - The range maximum.

Since:

0.1

Method Detail

setRange

public void setRange(int min,
                     int max)

Change or add a range for the distribution. Will error if it is also set to return an enum category with a different number of categories.

Parameters:

min - The revised range minimum.

max - The revised range maximum.

Since:

0.1

getRange

public DistributionCategorical.Range getRange()

Get the Range (DistributionCategorical.Range) for this distribution.

Returns:

The uniform discrete range as a Range object.

Since:

0.2

toString

public java.lang.String toString()

Custom toString implementation.

Specified by:

toString in class DistributionCategorical<C extends java.lang.Enum<C>>

Returns:

A string representation of the distribution; e.g., "DiscreteUniform(1,10)".

Since:

0.1

createUnregisteredCopy

public Distribution createUnregisteredCopy()

Create an unregistered copy of this distribution.

Specified by:

createUnregisteredCopy in class Distribution

Returns:

The unregistered copy. (This will need casting as appropriate.)

Since:

0.2