jhplot.math.num.pdf
Class Geometric

java.lang.Object
  extended by jhplot.math.num.pdf.DiscreteDistribution
      extended by jhplot.math.num.pdf.Geometric
All Implemented Interfaces:
Distribution

public class Geometric
extends DiscreteDistribution

The Geometric distribution.

References:

  1. Eric W. Weisstein. "Geometric Distribution." From MathWorld--A Wolfram Web Resource. http://mathworld.wolfram.com/Geometric.html

Since:
1.2

Constructor Summary
Geometric()
          Default constructor.
Geometric(double p)
          Create a distribution with the given probability of success.
 
Method Summary
 double cumulativeProbability(int x)
          The CDF for this distribution.
 double getProbabilityOfSuccess()
          Access probability of success.
 int inverseCumulativeProbability(double p)
          The inverse CDF for this distribution.
 double probability(int x)
          The PMF for this distribution.
 void setProbabilityOfSuccess(double p)
          Modify probability of success.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Geometric

public Geometric()
Default constructor. The probability of success is set to 0.5.


Geometric

public Geometric(double p)
Create a distribution with the given probability of success.

Parameters:
p - the probability of success.
Method Detail

cumulativeProbability

public double cumulativeProbability(int x)
                             throws NumericException
The CDF for this distribution. This method returns P(X ≤ x).

Specified by:
cumulativeProbability in class DiscreteDistribution
Parameters:
x - the value at which the CDF is evaluated.
Returns:
CDF for this distribution.
Throws:
NumericException - if the cumulative probability can not be computed.

getProbabilityOfSuccess

public double getProbabilityOfSuccess()
Access probability of success.

Returns:
the probability of success.

inverseCumulativeProbability

public int inverseCumulativeProbability(double p)
                                 throws NumericException
The inverse CDF for this distribution. This method returns the largest x such that, P(X ≤ x) ≤ p. The return value must also satisfy P(X ≥ x) &ge 1 - p.

Specified by:
inverseCumulativeProbability in class DiscreteDistribution
Parameters:
p - the cumulative probability.
Returns:
x
Throws:
NumericException - if the inverse cumulative probability can not be computed.

probability

public double probability(int x)
The PMF for this distribution. This method returns P(X = x).

Specified by:
probability in class DiscreteDistribution
Parameters:
x - the value at which the probability is evaluated.
Returns:
PMF for this distribution.

setProbabilityOfSuccess

public void setProbabilityOfSuccess(double p)
Modify probability of success.

Parameters:
p - the new probability of success value.


jHepWork 2.8 (©) S.Chekanov