desmoj.core.dist

Class DiscreteDistHypergeo

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.DiscreteDistHypergeo

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

Distribution returning hypergeometrically distributed long values. The Hypergeometrical distribution describes the probability of having a certain amount of marked objects within a subset of a set of objects in which a certain amount of them is marked.

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
DiscreteDistHypergeo(Model owner, java.lang.String name, int setSize, int markedAmount, int subsetSize, boolean showInReport, boolean showInTrace) Creates a stream of pseudo random numbers following a Hypergeometrical distribution.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the DiscreteDistHypergeo distribution.
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.
int	getMarkedAmount()
int	getSetSize()
int	getSubsetSize()
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

DiscreteDistHypergeo

public DiscreteDistHypergeo(Model owner,
                            java.lang.String name,
                            int setSize,
                            int markedAmount,
                            int subsetSize,
                            boolean showInReport,
                            boolean showInTrace)

Creates a stream of pseudo random numbers following a Hypergeometrical distribution. The specific parameters N (set size), n (marked amount) and k (subset size) have to be given here at creation time.

Parameters:

owner - Model : The distribution's owner

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

setSize - int : The size of the underlying set.

markedAmount - int : The amount of marked objects within the underlying set.

subsetSize - int : The size of the random subset of the underlying set.

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 DiscreteDistHypergeo distribution.

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the DiscreteDistHypergeo distribution

See Also:

DistributionReporter

getSetSize

public int getSetSize()

Returns:

double : The size of the underlying set.

getMarkedAmount

public int getMarkedAmount()

Returns:

int : The amount of marked objects within the underlying set.

getSubsetSize

public int getSubsetSize()

Returns:

int : The size of the (random) subset of the underlying set.

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 parameters specified for this distribution.

Overrides:

sample in class NumericalDist<java.lang.Long>

Returns:

Long : The next hypergeometrically 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:

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