IntGeometric (jasima 3.0.0-RC1 API)

java.lang.Object
- jasima.core.random.continuous.DblSequence
- - jasima.core.random.discrete.IntSequence
  - - jasima.core.random.discrete.IntDistribution
    - - jasima.core.random.discrete.IntGeometric

All Implemented Interfaces:

Serializable, Cloneable
```
public class IntGeometric
extends IntDistribution
```
This class implements a discrete number stream following a Geometric distribution. It has a single parameter, the probability of success in a single trial.

Author:

Torsten Hildebrandt

See Also:

Geometric distribution (Wikipedia), Geometric distribution (MathWorld), Serialized Form

Field Summary
- Fields inherited from class jasima.core.random.continuous.DblSequence
  rndGen

Constructor Summary

Constructors
Constructor Description

IntGeometric()

IntGeometric(double probOfSuccess)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`getProbabilityOfSuccess()`
`protected void`	`setDistribution(org.apache.commons.math3.distribution.IntegerDistribution distribution)`	Sets the discrete distribution to use.
`void`	`setProbabilityOfSuccess(double probOfSuccess)`	Sets the probability of success in a single trial.
`String`	`toString()`

Methods inherited from class jasima.core.random.discrete.IntDistribution
getDistribution, getNumericalMean, getValueRange, nextInt

Methods inherited from class jasima.core.random.discrete.IntSequence
clone, nextDbl

Methods inherited from class jasima.core.random.continuous.DblSequence
createStreamDefFromStream, getName, getRndGen, init, max, min, setName, setRndGen

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IntGeometric
```
public IntGeometric()
```
  - IntGeometric
```
public IntGeometric(double probOfSuccess)
```
- Method Detail
  - setDistribution
```
protected void setDistribution(org.apache.commons.math3.distribution.IntegerDistribution distribution)
```
    Description copied from class: IntDistribution
    
    Sets the discrete distribution to use.
    
    Overrides:
    
    setDistribution in class IntDistribution
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class IntDistribution
  - getProbabilityOfSuccess
```
public double getProbabilityOfSuccess()
```
  - setProbabilityOfSuccess
```
public void setProbabilityOfSuccess(double probOfSuccess)
                             throws org.apache.commons.math3.exception.OutOfRangeException
```
    Sets the probability of success in a single trial.
    
    Parameters:
    
    probOfSuccess - The success probability.
    
    Throws:
    
    org.apache.commons.math3.exception.OutOfRangeException - If the supplied probability if not in the interval (0,1].