Skip to main content

Function modifiers

cardinality

Commentary​

added in 0.8.3

Restricts the maximum number of unique values that a function can generate. When the limit is exceeded, previously generated values will be chosen at random.

Note that this modifier is a ceiling: if a function can't generate more unique values than the specified cardinality, it won't reach the cardinality limit.

Examples​

Setting cardinality​

Set cardinality to a positive integer. In this example:

  • a is only ever assigned one unique value
  • b is assigned 3 unique values, after which older values are reused
  • c always contains newly generated values
{
    "a": {
        "_gen": "normalDistribution",
        "mean": 10,
        "sd": 2,
        "decimals": 4,
        "cardinality": 1
    },
    "b": {
        "_gen": "normalDistribution",
        "mean": 10,
        "sd": 2,
        "decimals": 4,
        "cardinality": 3
    },
    "c": {
        "_gen": "normalDistribution",
        "mean": 10,
        "sd": 2,
        "decimals": 4
    }
}
[
    {
        "a": 8.9427,
        "b": 11.6935,
        "c": 7.1462
    },
    {
        "a": 8.9427,
        "b": 10.2091,
        "c": 10.8965
    },
    {
        "a": 8.9427,
        "b": 7.8284,
        "c": 8.0521
    },
    {
        "a": 8.9427,
        "b": 11.6935,
        "c": 9.6293
    },
    {
        "a": 8.9427,
        "b": 7.8284,
        "c": 7.6688
    },
    {
        "a": 8.9427,
        "b": 11.6935,
        "c": 10.7584
    },
    {
        "a": 8.9427,
        "b": 11.6935,
        "c": 12.7066
    },
    {
        "a": 8.9427,
        "b": 10.2091,
        "c": 11.5828
    },
    {
        "a": 8.9427,
        "b": 7.8284,
        "c": 11.7387
    },
    {
        "a": 8.9427,
        "b": 7.8284,
        "c": 8.7838
    }
]

Specification​

JSON schema​

{
    "type": "integer",
    "minimum": 1
}