@PublicationReference(author="Wikipedia", title="Yule-Simon Distribution", type=WebPage, year=2010, url="http://en.wikipedia.org/wiki/Yule%E2%80%93Simon_distribution") public class YuleSimonDistribution extends AbstractClosedFormIntegerDistribution implements ClosedFormDiscreteUnivariateDistribution<java.lang.Number>
Modifier and Type | Class and Description |
---|---|
static class |
YuleSimonDistribution.CDF
CDF of the Yule-Simon Distribution
|
static class |
YuleSimonDistribution.PMF
PMF of the Yule-Simon Distribution
|
Modifier and Type | Field and Description |
---|---|
static double |
DEFAULT_SHAPE
Default shape, 3.0.
|
protected double |
shape
Shape parameter, must be greater than zero
|
Constructor and Description |
---|
YuleSimonDistribution()
Creates a new instance of YuleSimonDistribution
|
YuleSimonDistribution(double shape)
Creates a new instance of YuleSimonDistribution
|
YuleSimonDistribution(YuleSimonDistribution other)
Copy constructor
|
Modifier and Type | Method and Description |
---|---|
YuleSimonDistribution |
clone()
This makes public the clone method on the
Object class and
removes the exception that it throws. |
void |
convertFromVector(Vector parameters)
Converts the object from a Vector of parameters.
|
Vector |
convertToVector()
Converts the object to a vector.
|
YuleSimonDistribution.CDF |
getCDF()
Gets the CDF of a scalar distribution.
|
IntegerSpan |
getDomain()
Returns an object that allows an iteration through the domain
(x-axis, independent variable) of the Distribution
|
int |
getDomainSize()
Gets the size of the domain.
|
java.lang.Number |
getMaxSupport()
Gets the minimum support (domain or input) of the distribution.
|
java.lang.Double |
getMean()
Gets the arithmetic mean, or "first central moment" or "expectation",
of the distribution.
|
double |
getMeanAsDouble()
Gets the mean of the distribution as a double.
|
java.lang.Integer |
getMinSupport()
Gets the minimum support (domain or input) of the distribution.
|
YuleSimonDistribution.PMF |
getProbabilityFunction()
Gets the distribution function associated with this Distribution,
either the PDF or PMF.
|
double |
getShape()
Getter for shape
|
double |
getVariance()
Gets the variance of the distribution.
|
int |
sampleAsInt(java.util.Random random)
Draws a single random sample from the distribution as an int.
|
void |
sampleInto(java.util.Random random,
int sampleCount,
java.util.Collection<? super java.lang.Number> output)
Draws multiple random samples from the distribution and puts the result
into the given collection.
|
void |
setShape(double shape)
Setter for shape
|
sampleAsInts, sampleInto
sample, sample
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
sample, sample
public static final double DEFAULT_SHAPE
protected double shape
public YuleSimonDistribution()
public YuleSimonDistribution(double shape)
shape
- Shape parameter, must be greater than zeropublic YuleSimonDistribution(YuleSimonDistribution other)
other
- YuleSimonDistribution to copypublic YuleSimonDistribution clone()
AbstractCloneableSerializable
Object
class and
removes the exception that it throws. Its default behavior is to
automatically create a clone of the exact type of object that the
clone is called on and to copy all primitives but to keep all references,
which means it is a shallow copy.
Extensions of this class may want to override this method (but call
super.clone()
to implement a "smart copy". That is, to target
the most common use case for creating a copy of the object. Because of
the default behavior being a shallow copy, extending classes only need
to handle fields that need to have a deeper copy (or those that need to
be reset). Some of the methods in ObjectUtil
may be helpful in
implementing a custom clone method.
Note: The contract of this method is that you must use
super.clone()
as the basis for your implementation.clone
in interface Vectorizable
clone
in interface CloneableSerializable
clone
in class AbstractClosedFormUnivariateDistribution<java.lang.Number>
public double getShape()
public void setShape(double shape)
shape
- Shape parameter, must be greater than zeropublic java.lang.Double getMean()
DistributionWithMean
getMean
in interface DistributionWithMean<java.lang.Number>
public double getMeanAsDouble()
UnivariateDistribution
getMeanAsDouble
in interface UnivariateDistribution<java.lang.Number>
public double getVariance()
UnivariateDistribution
getVariance
in interface UnivariateDistribution<java.lang.Number>
public int sampleAsInt(java.util.Random random)
IntegerDistribution
sampleAsInt
in interface IntegerDistribution
random
- The random number generator to use.public void sampleInto(java.util.Random random, int sampleCount, java.util.Collection<? super java.lang.Number> output)
Distribution
sampleInto
in interface Distribution<java.lang.Number>
random
- Random number generator to use.sampleCount
- The number of samples to draw. Cannot be negative.output
- The collection to add the samples into.public Vector convertToVector()
Vectorizable
convertToVector
in interface Vectorizable
public void convertFromVector(Vector parameters)
Vectorizable
convertFromVector
in interface Vectorizable
parameters
- The parameters to incorporate.public java.lang.Integer getMinSupport()
UnivariateDistribution
getMinSupport
in interface UnivariateDistribution<java.lang.Number>
public java.lang.Number getMaxSupport()
UnivariateDistribution
getMaxSupport
in interface UnivariateDistribution<java.lang.Number>
public IntegerSpan getDomain()
DiscreteDistribution
getDomain
in interface DiscreteDistribution<java.lang.Number>
public int getDomainSize()
DiscreteDistribution
getDomainSize
in interface DiscreteDistribution<java.lang.Number>
public YuleSimonDistribution.PMF getProbabilityFunction()
ComputableDistribution
getProbabilityFunction
in interface ComputableDistribution<java.lang.Number>
getProbabilityFunction
in interface DiscreteDistribution<java.lang.Number>
public YuleSimonDistribution.CDF getCDF()
UnivariateDistribution
getCDF
in interface ClosedFormUnivariateDistribution<java.lang.Number>
getCDF
in interface UnivariateDistribution<java.lang.Number>