DistPoisson (DSOL core project 4.2.1 API)

java.lang.Object
- nl.tudelft.simulation.jstats.distributions.Dist
- - nl.tudelft.simulation.jstats.distributions.DistDiscrete
  - - nl.tudelft.simulation.jstats.distributions.DistPoisson

All Implemented Interfaces:

Serializable
```
public class DistPoisson
extends DistDiscrete
```
The Poisson distribution. For more information on this distribution see https://mathworld.wolfram.com/PoissonDistribution.html
Copyright (c) 2002-2023 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://https://simulation.tudelft.nl/dsol/docs/latest/license.html.

Author:

Peter Jacobs , Alexander Verbraeck

See Also:

Serialized Form

Field Summary
- Fields inherited from class nl.tudelft.simulation.jstats.distributions.Dist
  stream

Constructor Summary

Constructors
Constructor Description

DistPoisson(StreamInterface stream, double lambda)
constructs a new Poisson distribution.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`long`	`draw()`	draws the next long from the stream.
`double`	`getLambda()`
`double`	`probability(long observation)`	returns the probability of the observation in this particular distribution.
`String`	`toString()`

Methods inherited from class nl.tudelft.simulation.jstats.distributions.Dist
getStream, setStream

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

- Constructor Detail
  - DistPoisson
```
public DistPoisson(StreamInterface stream,
                   double lambda)
```
    constructs a new Poisson distribution.
    
    Parameters:
    
    stream - StreamInterface; the random number stream
    
    lambda - double; the lambda parameter
    
    Throws:
    
    IllegalArgumentException - when lambda <= 0
- Method Detail
  - draw
```
public long draw()
```
    draws the next long from the stream.
    
    Specified by:
    
    draw in class DistDiscrete
    
    Returns:
    
    long
  - probability
```
public double probability(long observation)
```
    returns the probability of the observation in this particular distribution.
    
    Specified by:
    
    probability in class DistDiscrete
    
    Parameters:
    
    observation - long; the discrete observation.
    
    Returns:
    
    double the probability.
  - getLambda
```
public double getLambda()
```
    Returns:
    
    lambda
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object