Class ZipfPar

java.lang.Object

random.AbstractParameter

random.discrete.ZipfPar

All Implemented Interfaces:

AutoCheck, Parameter

public class ZipfPar
extends AbstractParameter
implements Parameter

Parameters of the Zipf distribution.

Constructor Summary

Constructors

Constructor	Description
ZipfPar(int numberOfElements, double alpha)
ZipfPar(Double alpha, Integer numberOfElements)
ZipfPar(Integer numberOfElements, Double alpha)

Method Summary

Modifier and Type	Method	Description
boolean	check()	It provide a method for the user to verify if the parameter that he is using is correct.
double	getAlpha()
int	getNumberOfElements()
void	setAlpha(double alpha)
void	setMax(int numberOfElements)

Methods inherited from class AbstractParameter

setMean

Methods inherited from class Object

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

Methods inherited from interface Parameter

setMean

Constructor Details

ZipfPar

public ZipfPar(int numberOfElements,
 double alpha)
        throws IncorrectDistributionParameterException

Throws:

IncorrectDistributionParameterException

ZipfPar

public ZipfPar(Integer numberOfElements,
 Double alpha)
        throws IncorrectDistributionParameterException

Throws:

IncorrectDistributionParameterException

ZipfPar

public ZipfPar(Double alpha,
 Integer numberOfElements)
        throws IncorrectDistributionParameterException

Throws:

IncorrectDistributionParameterException

Method Details

check

public boolean check()

Description copied from class: AbstractParameter

It provide a method for the user to verify if the parameter that he is using is correct.

Specified by:

check in interface AutoCheck

Specified by:

check in interface Parameter

Overrides:

check in class AbstractParameter

Returns:

boolean indicating whether or not the parameter is right.

getNumberOfElements

public int getNumberOfElements()

getAlpha

public double getAlpha()

setMax

public void setMax(int numberOfElements)
            throws IncorrectDistributionParameterException

Throws:

IncorrectDistributionParameterException

setAlpha

public void setAlpha(double alpha)
              throws IncorrectDistributionParameterException

Throws:

IncorrectDistributionParameterException