SSJ API Documentation: umontreal.ssj.probdist.Distribution Interface Reference

SSJ API Documentation Stochastic Simulation in Java

Loading...

Searching...

No Matches

This interface should be implemented by all classes supporting discrete and continuous distributions. More...

Inheritance diagram for umontreal.ssj.probdist.Distribution:

Public Member Functions
double	cdf (double x)
	Returns the distribution function \(F(x)\).
double	barF (double x)
	Returns \(\bar{F}(x) = 1 - F(x)\).
double	inverseF (double u)
	Returns the inverse distribution function \(F^{-1}(u)\), defined in ( `inverseF` ).
double	getMean ()
	Returns the mean of the distribution function.
double	getVariance ()
	Returns the variance of the distribution function.
double	getStandardDeviation ()
	Returns the standard deviation of the distribution function.
double[]	getParams ()
	Returns the parameters of the distribution function in the same order as in the constructors.

Detailed Description

This interface should be implemented by all classes supporting discrete and continuous distributions.

It specifies the signature of methods that compute the distribution function \(F(x)\), the complementary distribution function \(\bar{F}(x)\), and the inverse distribution function \( F^{-1} (u)\). It also specifies the signature of methods that returns the mean, the variance and the standard deviation.

Definition at line 39 of file Distribution.java.

Member Function Documentation

◆ barF()

double umontreal.ssj.probdist.Distribution.barF ( double x )

Returns \(\bar{F}(x) = 1 - F(x)\).

Parameters

x	value at which the complementary distribution function is evaluated

Returns: complementary distribution function evaluated at x

Implemented in umontreal.ssj.probdist.AndersonDarlingDist, umontreal.ssj.probdist.AndersonDarlingDistQuick, umontreal.ssj.probdist.BetaDist, umontreal.ssj.probdist.BetaSymmetricalDist, umontreal.ssj.probdist.CauchyDist, umontreal.ssj.probdist.ChiDist, umontreal.ssj.probdist.ChiSquareDist, umontreal.ssj.probdist.ChiSquareNoncentralDist, umontreal.ssj.probdist.ContinuousDistribution, umontreal.ssj.probdist.CramerVonMisesDist, umontreal.ssj.probdist.DiscreteDistribution, umontreal.ssj.probdist.DiscreteDistributionInt, umontreal.ssj.probdist.EmpiricalDist, umontreal.ssj.probdist.ExponentialDist, umontreal.ssj.probdist.ExtremeValueDist, umontreal.ssj.probdist.FatigueLifeDist, umontreal.ssj.probdist.FisherFDist, umontreal.ssj.probdist.FoldedNormalDist, umontreal.ssj.probdist.FrechetDist, umontreal.ssj.probdist.GammaDist, umontreal.ssj.probdist.GumbelDist, umontreal.ssj.probdist.HalfNormalDist, umontreal.ssj.probdist.HyperbolicSecantDist, umontreal.ssj.probdist.HypoExponentialDist, umontreal.ssj.probdist.HypoExponentialDistEqual, umontreal.ssj.probdist.HypoExponentialDistQuick, umontreal.ssj.probdist.InverseGammaDist, umontreal.ssj.probdist.InverseGaussianDist, umontreal.ssj.probdist.JohnsonSBDist, umontreal.ssj.probdist.JohnsonSLDist, umontreal.ssj.probdist.JohnsonSUDist, umontreal.ssj.probdist.KolmogorovSmirnovDist, umontreal.ssj.probdist.KolmogorovSmirnovDistQuick, umontreal.ssj.probdist.KolmogorovSmirnovPlusDist, umontreal.ssj.probdist.LaplaceDist, umontreal.ssj.probdist.LogisticDist, umontreal.ssj.probdist.LoglogisticDist, umontreal.ssj.probdist.LognormalDist, umontreal.ssj.probdist.NakagamiDist, umontreal.ssj.probdist.NormalDist, umontreal.ssj.probdist.NormalDistQuick, umontreal.ssj.probdist.NormalInverseGaussianDist, umontreal.ssj.probdist.ParetoDist, umontreal.ssj.probdist.Pearson5Dist, umontreal.ssj.probdist.Pearson6Dist, umontreal.ssj.probdist.PiecewiseLinearEmpiricalDist, umontreal.ssj.probdist.PowerDist, umontreal.ssj.probdist.RayleighDist, umontreal.ssj.probdist.StudentDist, umontreal.ssj.probdist.StudentDistQuick, umontreal.ssj.probdist.TriangularDist, umontreal.ssj.probdist.TruncatedDist, umontreal.ssj.probdist.UniformDist, umontreal.ssj.probdist.WatsonGDist, umontreal.ssj.probdist.WatsonUDist, and umontreal.ssj.probdist.WeibullDist.

◆ cdf()

double umontreal.ssj.probdist.Distribution.cdf ( double x )

Returns the distribution function \(F(x)\).

Parameters

x	value at which the distribution function is evaluated

Returns: distribution function evaluated at x

Implemented in umontreal.ssj.probdist.AndersonDarlingDist, umontreal.ssj.probdist.AndersonDarlingDistQuick, umontreal.ssj.probdist.BetaDist, umontreal.ssj.probdist.BetaSymmetricalDist, umontreal.ssj.probdist.CauchyDist, umontreal.ssj.probdist.ChiDist, umontreal.ssj.probdist.ChiSquareDist, umontreal.ssj.probdist.ChiSquareNoncentralDist, umontreal.ssj.probdist.CramerVonMisesDist, umontreal.ssj.probdist.DiscreteDistribution, umontreal.ssj.probdist.DiscreteDistributionInt, umontreal.ssj.probdist.EmpiricalDist, umontreal.ssj.probdist.ExponentialDist, umontreal.ssj.probdist.ExtremeValueDist, umontreal.ssj.probdist.FatigueLifeDist, umontreal.ssj.probdist.FisherFDist, umontreal.ssj.probdist.FoldedNormalDist, umontreal.ssj.probdist.FrechetDist, umontreal.ssj.probdist.GammaDist, umontreal.ssj.probdist.GumbelDist, umontreal.ssj.probdist.HalfNormalDist, umontreal.ssj.probdist.HyperbolicSecantDist, umontreal.ssj.probdist.HypoExponentialDist, umontreal.ssj.probdist.HypoExponentialDistEqual, umontreal.ssj.probdist.HypoExponentialDistQuick, umontreal.ssj.probdist.InverseDistFromDensity, umontreal.ssj.probdist.InverseGammaDist, umontreal.ssj.probdist.InverseGaussianDist, umontreal.ssj.probdist.JohnsonSBDist, umontreal.ssj.probdist.JohnsonSLDist, umontreal.ssj.probdist.JohnsonSUDist, umontreal.ssj.probdist.KolmogorovSmirnovDist, umontreal.ssj.probdist.KolmogorovSmirnovDistQuick, umontreal.ssj.probdist.KolmogorovSmirnovPlusDist, umontreal.ssj.probdist.LaplaceDist, umontreal.ssj.probdist.LogisticDist, umontreal.ssj.probdist.LoglogisticDist, umontreal.ssj.probdist.LognormalDist, umontreal.ssj.probdist.NakagamiDist, umontreal.ssj.probdist.NormalDist, umontreal.ssj.probdist.NormalDistQuick, umontreal.ssj.probdist.NormalInverseGaussianDist, umontreal.ssj.probdist.ParetoDist, umontreal.ssj.probdist.Pearson5Dist, umontreal.ssj.probdist.Pearson6Dist, umontreal.ssj.probdist.PiecewiseLinearEmpiricalDist, umontreal.ssj.probdist.PowerDist, umontreal.ssj.probdist.RayleighDist, umontreal.ssj.probdist.StudentDist, umontreal.ssj.probdist.StudentDistQuick, umontreal.ssj.probdist.TriangularDist, umontreal.ssj.probdist.TruncatedDist, umontreal.ssj.probdist.UniformDist, umontreal.ssj.probdist.WatsonGDist, umontreal.ssj.probdist.WatsonUDist, and umontreal.ssj.probdist.WeibullDist.

◆ getMean()

double umontreal.ssj.probdist.Distribution.getMean ( )

Returns the mean of the distribution function.

Implemented in umontreal.ssj.probdist.BernoulliDist, umontreal.ssj.probdist.BetaDist, umontreal.ssj.probdist.BetaSymmetricalDist, umontreal.ssj.probdist.BinomialDist, umontreal.ssj.probdist.CauchyDist, umontreal.ssj.probdist.ChiDist, umontreal.ssj.probdist.ChiSquareDist, umontreal.ssj.probdist.ChiSquareNoncentralDist, umontreal.ssj.probdist.ConstantDist, umontreal.ssj.probdist.ContinuousDistribution, umontreal.ssj.probdist.CramerVonMisesDist, umontreal.ssj.probdist.DiscreteDistribution, umontreal.ssj.probdist.EmpiricalDist, umontreal.ssj.probdist.ExponentialDist, umontreal.ssj.probdist.ExtremeValueDist, umontreal.ssj.probdist.FatigueLifeDist, umontreal.ssj.probdist.FisherFDist, umontreal.ssj.probdist.FoldedNormalDist, umontreal.ssj.probdist.FrechetDist, umontreal.ssj.probdist.GammaDist, umontreal.ssj.probdist.GeometricDist, umontreal.ssj.probdist.GumbelDist, umontreal.ssj.probdist.HalfNormalDist, umontreal.ssj.probdist.HyperbolicSecantDist, umontreal.ssj.probdist.HypergeometricDist, umontreal.ssj.probdist.HypoExponentialDist, umontreal.ssj.probdist.InverseGammaDist, umontreal.ssj.probdist.InverseGaussianDist, umontreal.ssj.probdist.JohnsonSBDist, umontreal.ssj.probdist.JohnsonSLDist, umontreal.ssj.probdist.JohnsonSUDist, umontreal.ssj.probdist.LaplaceDist, umontreal.ssj.probdist.LogarithmicDist, umontreal.ssj.probdist.LogisticDist, umontreal.ssj.probdist.LoglogisticDist, umontreal.ssj.probdist.LognormalDist, umontreal.ssj.probdist.NakagamiDist, umontreal.ssj.probdist.NegativeBinomialDist, umontreal.ssj.probdist.NormalDist, umontreal.ssj.probdist.NormalInverseGaussianDist, umontreal.ssj.probdist.ParetoDist, umontreal.ssj.probdist.Pearson5Dist, umontreal.ssj.probdist.Pearson6Dist, umontreal.ssj.probdist.PiecewiseLinearEmpiricalDist, umontreal.ssj.probdist.PoissonDist, umontreal.ssj.probdist.PowerDist, umontreal.ssj.probdist.RayleighDist, umontreal.ssj.probdist.StudentDist, umontreal.ssj.probdist.TriangularDist, umontreal.ssj.probdist.TruncatedDist, umontreal.ssj.probdist.UniformDist, umontreal.ssj.probdist.UniformIntDist, umontreal.ssj.probdist.WatsonUDist, and umontreal.ssj.probdist.WeibullDist.

◆ getParams()

double[] umontreal.ssj.probdist.Distribution.getParams ( )

Returns the parameters of the distribution function in the same order as in the constructors.

Implemented in umontreal.ssj.probdist.AndersonDarlingDist, umontreal.ssj.probdist.BernoulliDist, umontreal.ssj.probdist.BetaDist, umontreal.ssj.probdist.BetaSymmetricalDist, umontreal.ssj.probdist.BinomialDist, umontreal.ssj.probdist.CauchyDist, umontreal.ssj.probdist.ChiDist, umontreal.ssj.probdist.ChiSquareDist, umontreal.ssj.probdist.ChiSquareNoncentralDist, umontreal.ssj.probdist.CramerVonMisesDist, umontreal.ssj.probdist.DiscreteDistribution, umontreal.ssj.probdist.EmpiricalDist, umontreal.ssj.probdist.ErlangDist, umontreal.ssj.probdist.ExponentialDist, umontreal.ssj.probdist.ExtremeValueDist, umontreal.ssj.probdist.FatigueLifeDist, umontreal.ssj.probdist.FisherFDist, umontreal.ssj.probdist.FoldedNormalDist, umontreal.ssj.probdist.FrechetDist, umontreal.ssj.probdist.GammaDist, umontreal.ssj.probdist.GeometricDist, umontreal.ssj.probdist.GumbelDist, umontreal.ssj.probdist.HalfNormalDist, umontreal.ssj.probdist.HyperbolicSecantDist, umontreal.ssj.probdist.HypergeometricDist, umontreal.ssj.probdist.HypoExponentialDist, umontreal.ssj.probdist.HypoExponentialDistEqual, umontreal.ssj.probdist.InverseDistFromDensity, umontreal.ssj.probdist.InverseGammaDist, umontreal.ssj.probdist.InverseGaussianDist, umontreal.ssj.probdist.JohnsonSystem, umontreal.ssj.probdist.KolmogorovSmirnovDist, umontreal.ssj.probdist.KolmogorovSmirnovPlusDist, umontreal.ssj.probdist.LaplaceDist, umontreal.ssj.probdist.LogarithmicDist, umontreal.ssj.probdist.LogisticDist, umontreal.ssj.probdist.LoglogisticDist, umontreal.ssj.probdist.LognormalDist, umontreal.ssj.probdist.NakagamiDist, umontreal.ssj.probdist.NegativeBinomialDist, umontreal.ssj.probdist.NormalDist, umontreal.ssj.probdist.NormalInverseGaussianDist, umontreal.ssj.probdist.ParetoDist, umontreal.ssj.probdist.Pearson5Dist, umontreal.ssj.probdist.Pearson6Dist, umontreal.ssj.probdist.PiecewiseLinearEmpiricalDist, umontreal.ssj.probdist.PoissonDist, umontreal.ssj.probdist.PowerDist, umontreal.ssj.probdist.RayleighDist, umontreal.ssj.probdist.StudentDist, umontreal.ssj.probdist.TriangularDist, umontreal.ssj.probdist.TruncatedDist, umontreal.ssj.probdist.UniformDist, umontreal.ssj.probdist.UniformIntDist, umontreal.ssj.probdist.WatsonGDist, umontreal.ssj.probdist.WatsonUDist, and umontreal.ssj.probdist.WeibullDist.

◆ getStandardDeviation()

double umontreal.ssj.probdist.Distribution.getStandardDeviation ( )

Returns the standard deviation of the distribution function.

Implemented in umontreal.ssj.probdist.BernoulliDist, umontreal.ssj.probdist.BetaDist, umontreal.ssj.probdist.BetaSymmetricalDist, umontreal.ssj.probdist.BinomialDist, umontreal.ssj.probdist.CauchyDist, umontreal.ssj.probdist.ChiDist, umontreal.ssj.probdist.ChiSquareDist, umontreal.ssj.probdist.ChiSquareNoncentralDist, umontreal.ssj.probdist.ConstantDist, umontreal.ssj.probdist.ContinuousDistribution, umontreal.ssj.probdist.CramerVonMisesDist, umontreal.ssj.probdist.DiscreteDistribution, umontreal.ssj.probdist.EmpiricalDist, umontreal.ssj.probdist.ExponentialDist, umontreal.ssj.probdist.ExtremeValueDist, umontreal.ssj.probdist.FatigueLifeDist, umontreal.ssj.probdist.FisherFDist, umontreal.ssj.probdist.FoldedNormalDist, umontreal.ssj.probdist.FrechetDist, umontreal.ssj.probdist.GammaDist, umontreal.ssj.probdist.GeometricDist, umontreal.ssj.probdist.GumbelDist, umontreal.ssj.probdist.HalfNormalDist, umontreal.ssj.probdist.HyperbolicSecantDist, umontreal.ssj.probdist.HypergeometricDist, umontreal.ssj.probdist.HypoExponentialDist, umontreal.ssj.probdist.InverseGammaDist, umontreal.ssj.probdist.InverseGaussianDist, umontreal.ssj.probdist.JohnsonSBDist, umontreal.ssj.probdist.JohnsonSLDist, umontreal.ssj.probdist.JohnsonSUDist, umontreal.ssj.probdist.LaplaceDist, umontreal.ssj.probdist.LogarithmicDist, umontreal.ssj.probdist.LogisticDist, umontreal.ssj.probdist.LoglogisticDist, umontreal.ssj.probdist.LognormalDist, umontreal.ssj.probdist.NakagamiDist, umontreal.ssj.probdist.NegativeBinomialDist, umontreal.ssj.probdist.NormalDist, umontreal.ssj.probdist.NormalInverseGaussianDist, umontreal.ssj.probdist.ParetoDist, umontreal.ssj.probdist.Pearson5Dist, umontreal.ssj.probdist.Pearson6Dist, umontreal.ssj.probdist.PiecewiseLinearEmpiricalDist, umontreal.ssj.probdist.PoissonDist, umontreal.ssj.probdist.PowerDist, umontreal.ssj.probdist.RayleighDist, umontreal.ssj.probdist.StudentDist, umontreal.ssj.probdist.TriangularDist, umontreal.ssj.probdist.TruncatedDist, umontreal.ssj.probdist.UniformDist, umontreal.ssj.probdist.UniformIntDist, umontreal.ssj.probdist.WatsonUDist, and umontreal.ssj.probdist.WeibullDist.

◆ getVariance()

double umontreal.ssj.probdist.Distribution.getVariance ( )

Returns the variance of the distribution function.

Implemented in umontreal.ssj.probdist.BernoulliDist, umontreal.ssj.probdist.BetaDist, umontreal.ssj.probdist.BetaSymmetricalDist, umontreal.ssj.probdist.BinomialDist, umontreal.ssj.probdist.CauchyDist, umontreal.ssj.probdist.ChiDist, umontreal.ssj.probdist.ChiSquareDist, umontreal.ssj.probdist.ChiSquareNoncentralDist, umontreal.ssj.probdist.ConstantDist, umontreal.ssj.probdist.ContinuousDistribution, umontreal.ssj.probdist.CramerVonMisesDist, umontreal.ssj.probdist.DiscreteDistribution, umontreal.ssj.probdist.EmpiricalDist, umontreal.ssj.probdist.ExponentialDist, umontreal.ssj.probdist.ExtremeValueDist, umontreal.ssj.probdist.FatigueLifeDist, umontreal.ssj.probdist.FisherFDist, umontreal.ssj.probdist.FoldedNormalDist, umontreal.ssj.probdist.FrechetDist, umontreal.ssj.probdist.GammaDist, umontreal.ssj.probdist.GeometricDist, umontreal.ssj.probdist.GumbelDist, umontreal.ssj.probdist.HalfNormalDist, umontreal.ssj.probdist.HyperbolicSecantDist, umontreal.ssj.probdist.HypergeometricDist, umontreal.ssj.probdist.HypoExponentialDist, umontreal.ssj.probdist.InverseGammaDist, umontreal.ssj.probdist.InverseGaussianDist, umontreal.ssj.probdist.JohnsonSBDist, umontreal.ssj.probdist.JohnsonSLDist, umontreal.ssj.probdist.JohnsonSUDist, umontreal.ssj.probdist.LaplaceDist, umontreal.ssj.probdist.LogarithmicDist, umontreal.ssj.probdist.LogisticDist, umontreal.ssj.probdist.LoglogisticDist, umontreal.ssj.probdist.LognormalDist, umontreal.ssj.probdist.NakagamiDist, umontreal.ssj.probdist.NegativeBinomialDist, umontreal.ssj.probdist.NormalDist, umontreal.ssj.probdist.NormalInverseGaussianDist, umontreal.ssj.probdist.ParetoDist, umontreal.ssj.probdist.Pearson5Dist, umontreal.ssj.probdist.Pearson6Dist, umontreal.ssj.probdist.PiecewiseLinearEmpiricalDist, umontreal.ssj.probdist.PoissonDist, umontreal.ssj.probdist.PowerDist, umontreal.ssj.probdist.RayleighDist, umontreal.ssj.probdist.StudentDist, umontreal.ssj.probdist.TriangularDist, umontreal.ssj.probdist.TruncatedDist, umontreal.ssj.probdist.UniformDist, umontreal.ssj.probdist.UniformIntDist, umontreal.ssj.probdist.WatsonUDist, and umontreal.ssj.probdist.WeibullDist.

◆ inverseF()

double umontreal.ssj.probdist.Distribution.inverseF ( double u )

Returns the inverse distribution function \(F^{-1}(u)\), defined in ( inverseF ).

Parameters

u	value in the interval \((0,1)\) for which the inverse distribution function is evaluated

Returns: the inverse distribution function evaluated at u

Implemented in umontreal.ssj.probdist.AndersonDarlingDist, umontreal.ssj.probdist.AndersonDarlingDistQuick, umontreal.ssj.probdist.BetaDist, umontreal.ssj.probdist.BetaSymmetricalDist, umontreal.ssj.probdist.CauchyDist, umontreal.ssj.probdist.ChiDist, umontreal.ssj.probdist.ChiSquareDist, umontreal.ssj.probdist.ChiSquareDistQuick, umontreal.ssj.probdist.ChiSquareNoncentralDist, umontreal.ssj.probdist.ConstantDist, umontreal.ssj.probdist.ContinuousDistribution, umontreal.ssj.probdist.CramerVonMisesDist, umontreal.ssj.probdist.DiscreteDistribution, umontreal.ssj.probdist.DiscreteDistributionInt, umontreal.ssj.probdist.EmpiricalDist, umontreal.ssj.probdist.ExponentialDist, umontreal.ssj.probdist.ExtremeValueDist, umontreal.ssj.probdist.FatigueLifeDist, umontreal.ssj.probdist.FisherFDist, umontreal.ssj.probdist.FoldedNormalDist, umontreal.ssj.probdist.FrechetDist, umontreal.ssj.probdist.GammaDist, umontreal.ssj.probdist.GumbelDist, umontreal.ssj.probdist.HalfNormalDist, umontreal.ssj.probdist.HyperbolicSecantDist, umontreal.ssj.probdist.HypoExponentialDist, umontreal.ssj.probdist.HypoExponentialDistEqual, umontreal.ssj.probdist.HypoExponentialDistQuick, umontreal.ssj.probdist.InverseDistFromDensity, umontreal.ssj.probdist.InverseGammaDist, umontreal.ssj.probdist.InverseGaussianDist, umontreal.ssj.probdist.JohnsonSBDist, umontreal.ssj.probdist.JohnsonSLDist, umontreal.ssj.probdist.JohnsonSUDist, umontreal.ssj.probdist.KolmogorovSmirnovDist, umontreal.ssj.probdist.KolmogorovSmirnovDistQuick, umontreal.ssj.probdist.KolmogorovSmirnovPlusDist, umontreal.ssj.probdist.LaplaceDist, umontreal.ssj.probdist.LogisticDist, umontreal.ssj.probdist.LoglogisticDist, umontreal.ssj.probdist.LognormalDist, umontreal.ssj.probdist.NakagamiDist, umontreal.ssj.probdist.NormalDist, umontreal.ssj.probdist.NormalDistQuick, umontreal.ssj.probdist.ParetoDist, umontreal.ssj.probdist.Pearson5Dist, umontreal.ssj.probdist.Pearson6Dist, umontreal.ssj.probdist.PiecewiseLinearEmpiricalDist, umontreal.ssj.probdist.PowerDist, umontreal.ssj.probdist.RayleighDist, umontreal.ssj.probdist.StudentDist, umontreal.ssj.probdist.StudentDistQuick, umontreal.ssj.probdist.TriangularDist, umontreal.ssj.probdist.TruncatedDist, umontreal.ssj.probdist.UniformDist, umontreal.ssj.probdist.WatsonGDist, umontreal.ssj.probdist.WatsonUDist, and umontreal.ssj.probdist.WeibullDist.

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

src/main/java/umontreal/ssj/probdist/Distribution.java

umontreal
ssj
probdist
Distribution
Generated by 1.16.1