SSJ
V. 1.2.5.

umontreal.iro.lecuyer.randvar
Class HyperbolicSecantGen

java.lang.Object
  extended by umontreal.iro.lecuyer.randvar.RandomVariateGen
      extended by umontreal.iro.lecuyer.randvar.HyperbolicSecantGen

public class HyperbolicSecantGen
extends RandomVariateGen

This class implements random variate generators for the Hyperbolic Secant distribution with location parameter μ and scale parameter σ. The density function of this distribution is

f (x) = 1/(2σ) sech(π/2(x - μ)/σ).


Constructor Summary
HyperbolicSecantGen(RandomStream s, HyperbolicSecantDist dist)
          Creates a new generator for the distribution dist, using stream s.
 
Method Summary
 double nextDouble()
          Generates a random number from the continuous distribution contained in this object.
static double nextDouble(RandomStream s, double mu, double sigma)
          Generates a variate from the Hyperbolic Secant distribution with location parameter μ and scale parameter σ.
 
Methods inherited from class umontreal.iro.lecuyer.randvar.RandomVariateGen
getDistribution, getStream, nextArrayOfDouble, setStream
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HyperbolicSecantGen

public HyperbolicSecantGen(RandomStream s,
                           HyperbolicSecantDist dist)
Creates a new generator for the distribution dist, using stream s.

Method Detail

nextDouble

public double nextDouble()
Description copied from class: RandomVariateGen
Generates a random number from the continuous distribution contained in this object. By default, this method uses inversion by calling the inverseF method of the distribution object. Alternative generating methods are provided in subclasses.

Overrides:
nextDouble in class RandomVariateGen
Returns:
the generated value

nextDouble

public static double nextDouble(RandomStream s,
                                double mu,
                                double sigma)
Generates a variate from the Hyperbolic Secant distribution with location parameter μ and scale parameter σ.


SSJ
V. 1.2.5.

To submit a bug or ask questions, send an e-mail to Pierre L'Ecuyer.