desmoj.core.dist

Class DistributionManager

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.dist.DistributionManager

public class DistributionManager
extends NamedObject

Controls all distributions used during an experiment. Provides the service of automatic seed generation for all distributions registered at the distributionmanager. Note that all distributions register at instantiation time at the experiment's distributionmanager automatically.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Tim Lechler Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor and Description
DistributionManager(java.lang.String name, long seed) Creates a new distributionManager with the given name and the given initial seed for the seed-generator.

Method Summary

Modifier and Type	Method and Description
void	deRegister(Distribution dist) De-registers a distribution from the experiment.
java.util.List<Distribution>	getDistributions() Returns a list containing all distributions.
long	getSeed() Returns the initial seed.
void	newSeedAll() Provides all registered distributions with new seed values, thus resetting all distribution statistics at the same time.
long	nextSeed() Returns a new seed value to be used as an initial seed for registered distributions.
void	register(Distribution dist) Registers a new distribution at the experiment to control antithetic mode and set random seed values.
void	resetAll() Resets all registered distributions.
void	setAntitheticAll(boolean antitheticMode) Sets antithetic mode to true on all registered distributions regardless of their previous status.
void	setRandomNumberGenerator(java.lang.Class<? extends UniformRandomGenerator> randomNumberGenerator) Sets the underlying pseudo random number generator to be used by all distributions created from now on.
void	setSeed(long newSeed) Sets the seed of the SeedGenerator to the given value.

Methods inherited from class desmoj.core.simulator.NamedObject

getName, getQuotedName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributionManager

public DistributionManager(java.lang.String name,
                           long seed)

Creates a new distributionManager with the given name and the given initial seed for the seed-generator.

Parameters:

name - java.lang.String : The distributionmanager's name

seed - long : The initial seed for the seedgenerator

Method Detail

deRegister

public void deRegister(Distribution dist)

De-registers a distribution from the experiment.

Parameters:

dist - desmoj.dist.Distribution : The distribution to be deregistered

newSeedAll

public void newSeedAll()

Provides all registered distributions with new seed values, thus resetting all distribution statistics at the same time.

nextSeed

public long nextSeed()

Returns a new seed value to be used as an initial seed for registered distributions.

Returns:

long : A new seed value for a registered distribution

register

public void register(Distribution dist)

Registers a new distribution at the experiment to control antithetic mode and set random seed values.

Parameters:

dist - desmoj.dist.Distribution : The distribution to be registered

resetAll

public void resetAll()

Resets all registered distributions. Just calls all distribution's individual reset method.

setAntitheticAll

public void setAntitheticAll(boolean antitheticMode)

Sets antithetic mode to true on all registered distributions regardless of their previous status. No reset of statistical counters.

Parameters:

antitheticMode - boolean : The new status of antithetic mode

setSeed

public void setSeed(long newSeed)

Sets the seed of the SeedGenerator to the given value. If the seed is not set here, its default is zero, unless specified in the experimentoptions.

Parameters:

newSeed - long : The new seed for the seedgenerator

getSeed

public long getSeed()

Returns the initial seed.

Returns:

long : the initial seed

setRandomNumberGenerator

public void setRandomNumberGenerator(java.lang.Class<? extends UniformRandomGenerator> randomNumberGenerator)

Sets the underlying pseudo random number generator to be used by all distributions created from now on. The default generator is LinearCongruentialRandomGenerator; any other generator to be used must implement the interface UniformRandomGenerator.

Parameters:

randomNumberGenerator - Class : The random number generator class to be used

See Also:

LinearCongruentialRandomGenerator, UniformRandomGenerator

getDistributions

public java.util.List<Distribution> getDistributions()

Returns a list containing all distributions.