SSJ API Documentation
Stochastic Simulation in Java
Loading...
Searching...
No Matches
umontreal.ssj.randvar.LogisticGen Class Reference

This class implements random variate generators for the logistic distribution. More...

Inheritance diagram for umontreal.ssj.randvar.LogisticGen:
umontreal.ssj.randvar.RandomVariateGen

Public Member Functions

 LogisticGen (RandomStream s, double alpha, double lambda)
 Creates a logistic random variate generator with parameters.
 LogisticGen (RandomStream s)
 Creates a logistic random variate generator with parameters.
 LogisticGen (RandomStream s, LogisticDist dist)
 Creates a new generator for the logistic distribution dist and stream s.
double getAlpha ()
 Returns the parameter \(\alpha\) of this object.
double getLambda ()
 Returns the parameter \(\lambda\) of this object.
Public Member Functions inherited from umontreal.ssj.randvar.RandomVariateGen
 RandomVariateGen (RandomStream s, Distribution dist)
 Creates a new random variate generator from the distribution dist, using stream s.
double nextDouble ()
 Generates a random number from the continuous distribution contained in this object.
void nextArrayOfDouble (double[] v, int start, int n)
 Generates n random numbers from the continuous distribution contained in this object.
double[] nextArrayOfDouble (int n)
 Generates n random numbers from the continuous distribution contained in this object, and returns them in a new array of size n.
RandomStream getStream ()
 Returns the umontreal.ssj.rng.RandomStream used by this generator.
void setStream (RandomStream stream)
 Sets the umontreal.ssj.rng.RandomStream used by this generator to stream.
Distribution getDistribution ()
 Returns the umontreal.ssj.probdist.Distribution used by this generator.
String toString ()
 Returns a String containing information about the current generator.

Static Public Member Functions

static double nextDouble (RandomStream s, double alpha, double lambda)
 Generates a new variate from the logistic distribution with parameters \(\alpha= \) alpha and \(\lambda= \) lambda, using stream s.

Protected Member Functions

void setParams (double alpha, double lambda)
 Sets the parameter \(\alpha\) and \(\lambda\) of this object.

Detailed Description

This class implements random variate generators for the logistic distribution.

Its parameters are \(\alpha\) and \(\lambda> 0\). Its density function is

\[ f(x) = \frac{\lambda e^{-\lambda(x-\alpha)}}{\left(1 + e^{-\lambda(x-\alpha)}\right)^2} \qquad\mbox{ for } -\infty<x<\infty. \tag{flogistic} \]

The (non-static) nextDouble method simply calls inverseF on the distribution.

Definition at line 45 of file LogisticGen.java.

Constructor & Destructor Documentation

◆ LogisticGen() [1/3]

umontreal.ssj.randvar.LogisticGen.LogisticGen ( RandomStream s,
double alpha,
double lambda )

Creates a logistic random variate generator with parameters.

\(\alpha=\) alpha and \(\lambda=\) lambda, using stream s.

Definition at line 54 of file LogisticGen.java.

◆ LogisticGen() [2/3]

umontreal.ssj.randvar.LogisticGen.LogisticGen ( RandomStream s)

Creates a logistic random variate generator with parameters.

\(\alpha= 0\) and \(\lambda=1\), using stream s.

Definition at line 64 of file LogisticGen.java.

◆ LogisticGen() [3/3]

umontreal.ssj.randvar.LogisticGen.LogisticGen ( RandomStream s,
LogisticDist dist )

Creates a new generator for the logistic distribution dist and stream s.

Definition at line 71 of file LogisticGen.java.

Member Function Documentation

◆ getAlpha()

double umontreal.ssj.randvar.LogisticGen.getAlpha ( )

Returns the parameter \(\alpha\) of this object.

Definition at line 90 of file LogisticGen.java.

◆ getLambda()

double umontreal.ssj.randvar.LogisticGen.getLambda ( )

Returns the parameter \(\lambda\) of this object.

Definition at line 97 of file LogisticGen.java.

◆ nextDouble()

double umontreal.ssj.randvar.LogisticGen.nextDouble ( RandomStream s,
double alpha,
double lambda )
static

Generates a new variate from the logistic distribution with parameters \(\alpha= \) alpha and \(\lambda= \) lambda, using stream s.

Definition at line 83 of file LogisticGen.java.

◆ setParams()

void umontreal.ssj.randvar.LogisticGen.setParams ( double alpha,
double lambda )
protected

Sets the parameter \(\alpha\) and \(\lambda\) of this object.

Definition at line 104 of file LogisticGen.java.


The documentation for this class was generated from the following file: