# ParetoFactory¶

class ParetoFactory(*args)

Pareto factory.

Notes

Several estimators to build a Pareto distribution from a scalar sample are proposed.

Moments based estimator:

Lets denote:

• the empirical mean of the sample,

• its empirical variance,

• the empirical skewness of the sample

The estimator of is defined as follows :

The parameter is solution of the equation:

There exists a symbolic solution. If , then we get as follows:

Maximum likelihood based estimator:

The likelihood of the sample is defined by:

The maximum likelihood based estimator of maximizes the likelihood:

The following strategy is to be implemented soon: For a given , the likelihood of the sample is defined by:

We get which maximizes :

We get:

Then the parameter is obtained by maximizing the likelihood :

The initial point of the optimisation problem is .

Least squares estimator:

The parameter is numerically optimized by non-linear least-squares:

where are computed from linear least-squares at each optimization evaluation.

When is known and the follow a Pareto distribution then we use linear least-squares to solve the relation:

(1)

And the remaining parameters are estimated with:

The default strategy is to use the least squares estimator.

Methods

 build(*args) Estimate the distribution using the default strategy. buildAsPareto(*args) Estimate the distribution as native distribution. buildEstimator(*args) Build the distribution and the parameter distribution. Method of least-squares. Method of likelihood maximization. buildMethodOfMoments(sample) Method of moments estimator. Accessor to the bootstrap size. Accessor to the object’s name. Accessor to the object’s id. Accessor to the object’s name. Accessor to the object’s shadowed id. Accessor to the object’s visibility state. Test if the object is named. Test if the object has a distinguishable name. setBootstrapSize(bootstrapSize) Accessor to the bootstrap size. setName(name) Accessor to the object’s name. Accessor to the object’s shadowed id. setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)

Initialize self. See help(type(self)) for accurate signature.

build(*args)

Estimate the distribution using the default strategy.

Parameters
sampleSample

Data

Returns
distributionDistribution

The estimated distribution

buildAsPareto(*args)

Estimate the distribution as native distribution.

Parameters
sampleSample

Data

Returns
distributionPareto

The estimated distribution

buildEstimator(*args)

Build the distribution and the parameter distribution.

Parameters
sample2-d sequence of float

Sample from which the distribution parameters are estimated.

parametersDistributionParameters

Optional, the parametrization.

Returns
resDistDistributionFactoryResult

The results.

Notes

According to the way the native parameters of the distribution are estimated, the parameters distribution differs:

• Moments method: the asymptotic parameters distribution is normal and estimated by Bootstrap on the initial data;

• Maximum likelihood method with a regular model: the asymptotic parameters distribution is normal and its covariance matrix is the inverse Fisher information matrix;

• Other methods: the asymptotic parameters distribution is estimated by Bootstrap on the initial data and kernel fitting (see KernelSmoothing).

If another set of parameters is specified, the native parameters distribution is first estimated and the new distribution is determined from it:

• if the native parameters distribution is normal and the transformation regular at the estimated parameters values: the asymptotic parameters distribution is normal and its covariance matrix determined from the inverse Fisher information matrix of the native parameters and the transformation;

• in the other cases, the asymptotic parameters distribution is estimated by Bootstrap on the initial data and kernel fitting.

buildMethodOfLeastSquares(*args)

Method of least-squares.

Refer to LeastSquaresFactory.

Parameters
sampleSample

Data

gammafloat, optional

Gamma parameter.

Returns
distributionPareto

The estimated distribution

buildMethodOfLikelihoodMaximization(sample)

Method of likelihood maximization.

Refer to MaximumLikelihoodFactory.

Parameters
sampleSample

Data

Returns
distributionPareto

The estimated distribution

buildMethodOfMoments(sample)

Method of moments estimator.

Parameters
sampleSample

Data

Returns
distributionPareto

The estimated distribution

getBootstrapSize()

Accessor to the bootstrap size.

Returns
sizeinteger

Size of the bootstrap.

getClassName()

Accessor to the object’s name.

Returns
class_namestr

The object class name (object.__class__.__name__).

getId()

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns
namestr

The name of the object.

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

hasName()

Test if the object is named.

Returns
hasNamebool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns
hasVisibleNamebool

True if the name is not empty and not the default one.

setBootstrapSize(bootstrapSize)

Accessor to the bootstrap size.

Parameters
sizeinteger

Size of the bootstrap.

setName(name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.