jas.random
Class EmpiricalDistribution

java.lang.Object
  cern.colt.PersistentObject
      cern.jet.random.AbstractDistribution
          cern.jet.random.AbstractContinousDistribution
              cern.jet.random.Empirical
                  jas.random.EmpiricalDistribution

All Implemented Interfaces:

cern.colt.function.DoubleFunction, cern.colt.function.IntFunction, java.io.Serializable, java.lang.Cloneable

public class EmpiricalDistribution
extends cern.jet.random.Empirical

A custom probability distribution. This class is a wrapper for the Empirical class of the COLT library. See cern.jet.random.Empirical API documentation for more details. The user has to define the probability distribution specifing an array of double numbers representing the probability distribution function. The generator is able to make interpolation of missing probabilities.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa

See Also:

Serialized Form

Field Summary

static int	LINEAR_INTERPOLATION Uses interpolation.
static int	NO_INTERPOLATION Do not use interpolation.

Constructor Summary

EmpiricalDistribution(double[] pdf, int interpolationType)
Create an empirical random generator with given parameters and the default generator of JAS engine (Sim.getRnd() generator).

EmpiricalDistribution(double[] pdf, int interpolationType, cern.jet.random.engine.RandomEngine randomEngine)
Create an empirical random generator with given parameters and a given generator.

Method Summary

Methods inherited from class cern.jet.random.Empirical

cdf, clone, nextDouble, pdf, pdf, setState, toString

Methods inherited from class cern.jet.random.AbstractDistribution

apply, apply, makeDefaultGenerator, nextInt

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LINEAR_INTERPOLATION

public static final int LINEAR_INTERPOLATION

Uses interpolation.

See Also:

Constant Field Values

NO_INTERPOLATION

public static final int NO_INTERPOLATION

Do not use interpolation.

See Also:

Constant Field Values

Constructor Detail

EmpiricalDistribution

public EmpiricalDistribution(double[] pdf,
                             int interpolationType)

Create an empirical random generator with given parameters and the default generator of JAS engine (Sim.getRnd() generator).

Parameters:

pdf - The probability distribution function.

interpolationType - Define which type of interpolation to use. It could be LINEAR_INTERPOLATION or NO_INTERPOLATION.

EmpiricalDistribution

public EmpiricalDistribution(double[] pdf,
                             int interpolationType,
                             cern.jet.random.engine.RandomEngine randomEngine)

Create an empirical random generator with given parameters and a given generator.

Parameters:

pdf - The probability distribution function.

interpolationType - Define which type of interpolation to use. It could be LINEAR_INTERPOLATION or NO_INTERPOLATION.

randomGenerator - A random number generator. It is taken from COLT library. See cern.jet.random.engine.RandomEngine for more details.