Source code for pyphi.conf.numerics

"""Numerics layer of the PyPhi config.

Holds knobs that govern numerical comparison (precision).
Frozen dataclass — replace via :func:`dataclasses.replace` or top-level
write on the global config.
"""

from __future__ import annotations

from dataclasses import dataclass

from pyphi.conf._helpers import yaml_repr




@dataclass(frozen=True)
class NumericsConfig:
    """Numerical-comparison settings."""

    precision: int = 13
    """Decimal places of agreement required when φ, Φ, and α values are
    compared through :func:`pyphi.numerics.eq` and the other
    :mod:`pyphi.numerics` predicates; values smaller than
    ``10**-precision`` are treated as zero (default ``13``; the ``iit3``
    preset sets ``6``)."""

    __repr__ = yaml_repr

    def __post_init__(self) -> None:
        if not isinstance(self.precision, int) or isinstance(self.precision, bool):
            raise ValueError(
                f"precision must be int; got {type(self.precision).__name__}"
            )
        if self.precision < 0:
            raise ValueError(f"precision must be >= 0; got {self.precision}")