desmoj.core.dist

Class DiscreteDistBinomial

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.dist.Distribution

desmoj.core.dist.NumericalDist<N>

desmoj.core.dist.DiscreteDist<java.lang.Long>

desmoj.core.dist.DiscreteDistBinomial

public class DiscreteDistBinomial
extends DiscreteDist<java.lang.Long>

Distribution returning binomial distributed long values. The binomial distribution describes the probability of having a certain amount of successes in a series of indepedent Bernoulli experiments, all having the same success probability.

Version:

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

Author:

Peter Wueppen 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
DiscreteDistBinomial(Model owner, java.lang.String name, double probability, int amount, boolean showInReport, boolean showInTrace) Creates a stream of pseudo random numbers following a binomial distribution.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the DiscreteDistBinomial distribution.
int	getAmount() Returns the amount of separate Bernoulli experiments that lead to the result.
java.lang.Long	getInverseOfCumulativeProbabilityFunction(double p) Abstract method to map a double p from 0...1 to the distribution's domain by determining the value x that satisfies P(X < x) = p.
double	getProbability() Returns the probability of success in each separate Bernoulli experiment
java.lang.Long	sample() Returns the next sample from this distribution.

Methods inherited from class desmoj.core.dist.NumericalDist

sampleObject, sampleTimeSpan, sampleTimeSpan

Methods inherited from class desmoj.core.dist.Distribution

changeRandomGenerator, getInitialSeed, getNonNegative, getNumSamples, isAntithetic, reset, reset, setAntithetic, setNonNegative, setSeed

Methods inherited from class desmoj.core.simulator.Reportable

getCorrespondingSchedulable, getDescription, getObservations, getReporter, incrementObservations, incrementObservations, reportIsOn, reportOff, reportOn, resetAt, setCorrespondingSchedulable, setDescription, setReporter

Methods inherited from class desmoj.core.simulator.ModelComponent

current, currentEntity, currentEntityAll, currentEvent, currentModel, currentSimProcess, debugIsOn, debugOff, debugOn, getModel, isExperimentCompatible, isModelCompatible, presentTime, sendDebugNote, sendMessage, sendTraceNote, sendWarning, skipTraceNote, skipTraceNote, traceIsOn, traceOff, traceOn

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

DiscreteDistBinomial

public DiscreteDistBinomial(Model owner,
                            java.lang.String name,
                            double probability,
                            int amount,
                            boolean showInReport,
                            boolean showInTrace)

Creates a stream of pseudo random numbers following a binomial distribution. The specific parameters p (probability) and n (amount) have to be given here at creation time.

Parameters:

owner - Model : The distribution's owner

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

probability - double : The probability of success in each separate Bernoulli experiment.

amount - int : The amount of separate Bernoulli experiments that lead to the result.

showInReport - boolean : Flag for producing reports

showInTrace - boolean : Flag for producing trace output

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Creates the default reporter for the DiscreteDistBinomial distribution.

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the DiscreteDistBinomial distribution

See Also:

DistributionReporter

getProbability

public double getProbability()

Returns the probability of success in each separate Bernoulli experiment

Returns:

double : The probability of success in each separate Bernoulli experiment.

getAmount

public int getAmount()

Returns the amount of separate Bernoulli experiments that lead to the result.

Returns:

int : The amount of separate Bernoulli experiments that lead to the result.

sample

public java.lang.Long sample()

Returns the next sample from this distribution. The value depends upon the seed, the number of values taken from the stream by using this method before and the probability and amount of trials specified for this distribution.

Overrides:

sample in class NumericalDist<java.lang.Long>

Returns:

Long : The next binomial distributed sample from this distribution.

getInverseOfCumulativeProbabilityFunction

public java.lang.Long getInverseOfCumulativeProbabilityFunction(double p)

Abstract method to map a double p from 0...1 to the distribution's domain by determining the value x that satisfies P(X < x) = p.

Specified by:

getInverseOfCumulativeProbabilityFunction in class NumericalDist<java.lang.Long>

Parameters:

p - double: A value between 0 and 1

Returns:

N : The value x that satisfies P(X < x) = p