DistributionParameters

class DistributionParameters(*args)

Define a distribution with particular parameters.

This class enables to create a set of non-native parameters in order to define distribution.

A DistributionParameters object can be used through its derived classes:

Methods

__call__(inP)
evaluate() Compute native parameters values.
getClassName() Accessor to the object’s name.
getDescription() Get the description of the parameters.
getDistribution() Build a distribution based on a set of native parameters.
getId() Accessor to the object’s id.
getImplementation(*args) Accessor to the underlying implementation.
getName() Accessor to the object’s name.
getValues() Accessor to the parameters values.
gradient() Get the gradient.
inverse(inP) Convert to native parameters.
setName(name) Accessor to the object’s name.
setValues(values) Accessor to the parameters values.
__init__(*args)
evaluate()

Compute native parameters values.

Returns:

values : Point

The native parameter values.

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getDescription()

Get the description of the parameters.

Returns:

collection : Description

List of parameters names.

getDistribution()

Build a distribution based on a set of native parameters.

Returns:

distribution : Distribution

Distribution built with the native parameters.

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getImplementation(*args)

Accessor to the underlying implementation.

Returns:

impl : Implementation

The implementation class.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getValues()

Accessor to the parameters values.

Returns:

values : Point

List of parameters values.

gradient()

Get the gradient.

Returns:

gradient : Matrix

The gradient of the transformation of the native parameters into the new parameters.

Notes

If we note (p_1, \dots, p_q) the native parameters and (p'_1, \dots, p'_q) the new ones, then the gradient matrix is \left( \dfrac{\partial p'_i}{\partial p_j} \right)_{1 \leq i,j \leq  q}.

inverse(inP)

Convert to native parameters.

Parameters:

inP : sequence of float

The non-native parameters.

Returns:

outP : Point

The native parameters.

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setValues(values)

Accessor to the parameters values.

Parameters:

values : sequence of float

List of parameters values.