metasyn.distribution.uniquekey.UniqueKeyDistribution

class metasyn.distribution.uniquekey.UniqueKeyDistribution(lower, consecutive)

Unique key distribution for identifiers.

Discrete distribution that ensures the uniqueness of the drawn values.

Parameters:
  • lower (int) – Minimum value for the keys.

  • consecutive (bool) – True if keys are consecutive and increasing, False otherwise.

Examples

>>> UniqueKeyDistribution(lower=0, consecutive=True)
name

core.unique_key

unique

True

version

1.0

var_type

discrete

__init__(lower, consecutive)
Parameters:
  • lower (int)

  • consecutive (bool)

Methods

__init__(lower, consecutive)

default_distribution([var_type])

Get a distribution with default parameters.

draw()

Draw a random element from the fitted distribution.

draw_list(n)

Draw a list of values from the distribution.

draw_reset()

Reset the drawing of elements to start again.

from_dict(dist_dict)

Create a distribution from a dictionary.

information_criterion(values)

Get the BIC value for a particular set of values.

matches_name(name)

Check whether the name matches the distribution.

provides_var_type(var_type)

schema()

Create sub-schema to validate GMF file.

to_dict()

Convert the distribution to a dictionary.

Attributes

name

The identifier for the implemented distribution

unique

Whether the distribution creates only unique values

var_type

The variable type of the distribution

version

Version of the implemented distribution