desmoj.core.dist

Class BoolDistBernoulli

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.dist.Distribution

desmoj.core.dist.BoolDist

desmoj.core.dist.BoolDistBernoulli

public class BoolDistBernoulli
extends BoolDist

Boolean Bernoulli distribution returning true values with the given probability. Samples of this distribution can either be true or false with a given probability for value "true". The probabilitiy for "true" can only be set via the constructor. It has to be a value between 0 and 1. Higher values will be interpreted as 1 (always return "true"). Negative values will be interpreted as 0 (always return "false").

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
BoolDistBernoulli(Model owner, java.lang.String name, double probabilityForTrue, boolean showInReport, boolean showInTrace) Constructs a boolean Bernoulli distribution with the given probability to return a "true" value.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the BoolDistBernoulli distribution.
double	getProbability() Returns the probability for true values.
boolean	sample() Returns the next Bernoulli distributed sample of the distribution.

Methods inherited from class desmoj.core.dist.BoolDist

sampleObject

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

BoolDistBernoulli

public BoolDistBernoulli(Model owner,
                         java.lang.String name,
                         double probabilityForTrue,
                         boolean showInReport,
                         boolean showInTrace)

Constructs a boolean Bernoulli distribution with the given probability to return a "true" value. The given probability has to be in the range between 0 and 1. Higher values will be interpreted as 1 (always return "true"). Negative values are interpreted as 0 (always return "false").

Parameters:

owner - Model : The distribution's owner

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

probabilityForTrue - double : The probability for producing a true sample

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

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the BoolDistBernoulli distribution

See Also:

DistributionReporter

getProbability

public double getProbability()

Returns the probability for true values. The value returned is passed through the constructor.

Returns:

double : the probability of a true value being returned

sample

public boolean sample()

Returns the next Bernoulli distributed sample of the distribution. The returned value will depend upon the seed of the underlying random generator and the probability given for this distribution.

Specified by:

sample in class BoolDist

Returns:

boolean : The next Bernoulli distributed random sample