IRPact_modellierung.distributions

Class PowerlawDistribution

java.lang.Object

IRPact_modellierung.distributions.Distribution

IRPact_modellierung.distributions.UnivariateDistribution

IRPact_modellierung.distributions.ContinuousDistribution

IRPact_modellierung.distributions.COLTContinuousDistribution

IRPact_modellierung.distributions.PowerlawDistribution

public class PowerlawDistribution
extends COLTContinuousDistribution

Class that models a power law distribution (with cut off) based on the COLT library (see https://dst.lbl.gov/ACSSoftware/colt/api/cern/jet/random/Distributions.html#nextPowLaw(double,%20double,%20cern.jet.random.engine.RandomEngine)) Should return values following a power law (probably not exactly, since it does not asymptotically go to a power law, see https://en.wikipedia.org/wiki/Power_law#Power-law_probability_distributions)

Field Summary

Fields inherited from class IRPact_modellierung.distributions.COLTContinuousDistribution

generator

Fields inherited from class IRPact_modellierung.distributions.Distribution

name

Constructor Summary

Constructors

Constructor and Description
PowerlawDistribution(java.lang.String name, double alpha, double cut) Generates a wrapper for the power law distribution as implemented in the COLT library

Method Summary

Modifier and Type	Method and Description
double	draw() Draw a value from the distribution according to the distribution at hand
double	getAlpha()
double	getCut()

Methods inherited from class IRPact_modellierung.distributions.Distribution

getName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PowerlawDistribution

public PowerlawDistribution(java.lang.String name,
                            double alpha,
                            double cut)
                     throws java.lang.IllegalArgumentException

Generates a wrapper for the power law distribution as implemented in the COLT library

Parameters:

name - Name of the power law distribution (will be prefixed by PowerlawDistribution_)

alpha - The exponent of the power law distribution

cut - The cut-off of the corresponding distribution (as realized in the COLT library). No values larger than this will be returned.

Throws:

java.lang.IllegalArgumentException - Will be thrown when cut off is <= 0

Method Detail

getAlpha

public double getAlpha()

getCut

public double getCut()

draw

public double draw()

Description copied from class: UnivariateDistribution

Draw a value from the distribution according to the distribution at hand

Specified by:

draw in class UnivariateDistribution

Returns:

A double number drawn from the modeled distribution