org.apache.mahout.math.jet.random.Exponential Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mahout-math Show documentation

High performance scientific and technical computing data structures and methods, mostly based on CERN's Colt Java API

There is a newer version: 0.13.0

/*
Copyright � 1999 CERN - European Organization for Nuclear Research.
Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose 
is hereby granted without fee, provided that the above copyright notice appear in all copies and 
that both that copyright notice and this permission notice appear in supporting documentation. 
CERN makes no representations about the suitability of this software for any purpose. 
It is provided "as is" without expressed or implied warranty.
*/
package org.apache.mahout.math.jet.random;

import java.util.Locale;
import java.util.Random;

public class Exponential extends AbstractContinousDistribution {
  // rate parameter for the distribution.  Mean is 1/lambda.
  private double lambda;

  /**
   * Provides a negative exponential distribution given a rate parameter lambda and an underlying
   * random number generator.  The mean of this distribution will be equal to 1/lambda.
   *
   * @param lambda          The rate parameter of the distribution.
   * @param randomGenerator The PRNG that is used to generate values.
   */
  public Exponential(double lambda, Random randomGenerator) {
    setRandomGenerator(randomGenerator);
    this.lambda = lambda;
  }

  /**
   * Returns the cumulative distribution function.
   * @param x  The point at which the cumulative distribution function is to be evaluated.
   * @return Returns the integral from -infinity to x of the PDF, also known as the cumulative distribution
   * function.
   */
  @Override
  public double cdf(double x) {
    if (x <= 0.0) {
      return 0.0;
    }
    return 1.0 - Math.exp(-x * lambda);
  }

  /**
   * Returns a random number from the distribution.
   */
  @Override
  public double nextDouble() {
    return -Math.log1p(-randomDouble()) / lambda;
  }

  /**
   * Returns the value of the probability density function at a particular point.
   * @param x   The point at which the probability density function is to be evaluated.
   * @return  The value of the probability density function at the specified point.
   */
  @Override
  public double pdf(double x) {
    if (x < 0.0) {
      return 0.0;
    }
    return lambda * Math.exp(-x * lambda);
  }

  /**
   * Sets the rate parameter.
   * @param lambda  The new value of the rate parameter.
   */
  public void setState(double lambda) {
    this.lambda = lambda;
  }

  /**
   * Returns a String representation of the receiver.
   */
  @Override
  public String toString() {
    return String.format(Locale.ENGLISH, "%s(%.4f)", this.getClass().getName(), lambda);
  }

}