uk.ac.soton.simulation.jsit.core

Class DistGeometric

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

All Implemented Interfaces:

java.io.Serializable, ContinuousSampler

public class DistGeometric
extends DistributionDiscrete
implements java.io.Serializable

JSIT representation of a (non-shifted) geometric distribution which models the number of failures before a success in independent trials with a success probability p.

Since:

0.2

Author:

Stuart Rossiter

See Also:

Serialized Form

Field Summary

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

CUMULATIVE_PROB_TOLERANCE

Constructor Summary

Constructors

Constructor and Description
DistGeometric(double p) Create a geometric distribution instance.

Method Summary

Modifier and Type	Method and Description
Distribution	createUnregisteredCopy() Create an unregistered copy of this distribution.
double	getP() Get the distribution's p parameter (probability of success).
void	setP(double p) Change (set) the p parameter of the distribution.
java.lang.String	toString() Custom toString implementation.

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

DistGeometric

public DistGeometric(double p)

Create a geometric distribution instance.

Parameters:

p - The p parameter (probability of success) for the distribution.

Since:

0.2

Method Detail

setP

public void setP(double p)

Change (set) the p parameter of the distribution.

Parameters:

p - The new p parameter.

getP

public double getP()

Get the distribution's p parameter (probability of success).

Returns:

The p parameter.

toString

public java.lang.String toString()

Custom toString implementation.

Specified by:

toString in class DistributionDiscrete

Returns:

A string representation of the distribution; e.g., "Geometric(0.75)".

Since:

0.2

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