GridSim
v3.1

eduni.simjava.distributions
Class Sim_cauchy_obj

Object
  extended byeduni.simjava.distributions.Sim_cauchy_obj
All Implemented Interfaces:
ContinuousGenerator, Generator

public class Sim_cauchy_obj
extends Object
implements ContinuousGenerator

A random number generator based on the Cauchy distribution.

Version:
1.0, 13 May 2002
Author:
Costas Simatos

Constructor Summary
Sim_cauchy_obj(String name, double median, double scale)
          Constructor with which Sim_system is allowed to set the random number generator's seed
Sim_cauchy_obj(String name, double median, double scale, long seed)
          The constructor with which a specific seed is set for the random number generator
 
Method Summary
 String get_name()
          Get the random number generator's name.
 long get_seed()
          Get the random number generator's seed.
 double sample()
          Generate a new random number.
(package private) static double sample(Sim_random_obj source, double median, double scale)
           
 void set_seed(long seed)
          Set the random number generator's seed.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Sim_cauchy_obj

public Sim_cauchy_obj(String name,
                      double median,
                      double scale)
Constructor with which Sim_system is allowed to set the random number generator's seed

Parameters:
name - The name to be associated with this instance
median - The median of the distribution
scale - The scale of the distribution

Sim_cauchy_obj

public Sim_cauchy_obj(String name,
                      double median,
                      double scale,
                      long seed)
The constructor with which a specific seed is set for the random number generator

Parameters:
name - The name to be associated with this instance
median - The median of the distribution
scale - The scale of the distribution
seed - The initial seed for the generator, two instances with the same seed will generate the same sequence of numbers
Method Detail

sample

public double sample()
Generate a new random number.

Specified by:
sample in interface ContinuousGenerator
Returns:
The next random number in the sequence

sample

static double sample(Sim_random_obj source,
                     double median,
                     double scale)

set_seed

public void set_seed(long seed)
Set the random number generator's seed.

Specified by:
set_seed in interface Generator
Parameters:
seed - The new seed for the generator

get_seed

public long get_seed()
Get the random number generator's seed.

Specified by:
get_seed in interface Generator
Returns:
The generator's seed

get_name

public String get_name()
Get the random number generator's name.

Specified by:
get_name in interface Generator
Returns:
The generator's name

GridSim
v3.1

The University of Melbourne, Australia, 2004