Adding machine (odometer)
The adding machine r → r + 1 on the q-adic integers, the odometer acting on the q-ary tree.
- Name:
adding_machine - Field:
computer_science/automata - Formalism: lattice dynamics
- References: Ceccherini-Silberstein and Coornaert 2023
Select this system
from skcomplex.systems import create_simulation, create_system, describe
system = create_system('adding_machine')
entry = describe('adding_machine')
trajectory = create_simulation('adding_machine').prepare().run().trajectory_
Factory
@register_system(
field='computer_science/automata',
tags=('odometer', 'q-adic integers', 'self-similar group', 'tree automorphism'),
references=('Ceccherini-Silberstein and Coornaert 2023',),
defaults={'until': 64, 'dt': 1},
)
def adding_machine(
digits: int = 6,
*,
base: int = 2,
initial: npt.ArrayLike | None = None,
) -> System:
"""Return the adding machine `r → r + 1` on the q-adic integers, the odometer acting on the q-ary tree.
The cells hold the digits of `r`, the lowest first, the first `digits` letters of its infinite word, a vertex of the
q-ary tree. Every step adds 1: the lowest digit turns by the cycle `0 → 1 → ... → q - 1 → 0`, and a digit turns
when every lower digit is `q - 1`, the carry (Ceccherini-Silberstein and Coornaert 2023, Exercise 6.59). The machine
is an automorphism of the tree of infinite order whose orbits are dense, and on the first `digits` levels it
visits all `q^digits` vertices in turn. The lowest digit reads `q - 1` beyond the segment, the carry of `+1`.
Args:
digits:
The number of digits kept, the depth of the tree.
base:
The base `q`, at least 2.
initial:
The initial digits, the lowest first, or `None` for 0.
Returns:
system:
The system, with the digits `cells.digit`.
Raises:
ParameterError:
The base is below 2.
Examples:
>>> from skcomplex.systems.computer_science.automata import adding_machine
>>> adding_machine(4).elements[0].prepare().size_
4
"""
if base < MIN_BASE:
error_msg = f'The base of the adding machine is at least 2, but it is {base}.'
raise ParameterError(error_msg)
values = np.zeros(digits) if initial is None else np.asarray(initial, dtype=float)
return System(
elements=[
LatticeElement(
'cells',
element=DigitCellElement,
space=LatticeSpace(digits, boundary='fixed', fill=base - 1),
values={'digit': values, 'base': base},
),
],
interactions=[
LocalRuleInteraction(
'carry',
target='cells',
state='digit',
rule=_carry,
neighborhood=LatticeNeighborhood(tuple((offset,) for offset in range(1 - digits, 1))),
),
],
)
Components
Elements:
DigitCellElement, fromElement
Interactions:
LocalRuleInteraction
class DigitCellElement(Element):
"""Cell holding a digit of a q-adic integer, from 0 to `base - 1`, the label of a vertex of the q-ary tree.
Args:
label:
The label of the cell or the lattice group.
visual:
How the element is drawn, or `None` for `default_visual_`.
digit:
The initial digit.
base:
The base `q` of the digits, at least 2.
Examples:
>>> from skcomplex.systems.computer_science.automata import DigitCellElement
>>> DigitCellElement('cell', digit=1).base
2
"""
def __init__(
self,
label: str,
visual: VisualSpec | None = None,
*,
digit: Annotated[float, StateSpec(domain=ZZ)] = 0,
base: Annotated[float, ParameterSpec(domain=RealSet.open(0, oo))] = 2,
) -> None:
super().__init__(label, visual=visual)
self.digit = digit
self.base = base
class LocalRuleInteraction(Interaction):
"""Local rule of a cellular automaton, which sets the next value of every cell from its ordered neighbourhood.
The rule is a table of the next value of every configuration of the neighbourhood, `TableSpec`, a rule of the sum
of the neighbourhood, `TotalisticSpec`, a rule of the cell and the sum of its neighbours, `OuterTotalisticSpec`, an
object whose `table()` returns a `TableSpec`, or a function. A function receives one array per neighbour of every
read state, in neighbourhood order, with one value per cell, the uniform array `random` when the rule is stochastic,
and the parameters of the bound group it names, and returns the next values of the states, one array per state. A
state of several components per cell, such as a truncated power series of `PowerSeriesSpec`, reaches a function as
one row of components per cell. A `StateTranslationNeighborhood` reads a group space at the product of every site
and the group element that the first read state holds there.
Args:
label:
The label of the interaction, unique among the parts of its system.
target:
The path of the group on the cells of a lattice, the nodes of a network, or a Cayley graph.
state:
The name of the state the rule sets, or a tuple of the names of the states it sets together.
rule:
The table, the totalistic rule, or the function.
neighborhood:
The ordered neighbourhood of every cell, such as `VonNeumannNeighborhood(center=True)`.
reads:
The names of the states whose neighbourhoods a function reads, or `None` for the states it sets.
schedule:
`'synchronous'`, `'random-sequential'`, `'random-site'`, `'checkerboard'`, or `'colored'`.
stochastic:
Whether a function receives the uniform random array `random`.
Raises:
ValidationError:
The state or the read states are not names, or the neighbourhood is not a neighbourhood.
Examples:
>>> from skcomplex.core.components.interactions import LocalRuleInteraction
>>> from skcomplex.core.components.spaces import VonNeumannNeighborhood
>>> from skcomplex.core.specs import TotalisticSpec
>>> parity = TotalisticSpec({1: 1, 3: 1})
>>> around = VonNeumannNeighborhood(n_dim=1, center=True)
>>> rule = LocalRuleInteraction('parity', target='cells', state='cell', rule=parity, neighborhood=around)
>>> rule.schedule
'synchronous'
"""
law_classes: ClassVar[tuple[type[BaseLaw], ...]] = (LocalRuleLaw,)
def __init__(
self,
label: str,
*,
target: Annotated[str, RoleSpec(elements=(ElementKind.ANY,), states=('state', 'reads'))],
state: str | tuple[str, ...],
rule: object,
neighborhood: BaseNeighborhood,
reads: Sequence[str] | None = None,
schedule: str = 'synchronous',
stochastic: bool = False,
) -> None:
super().__init__(label)
self.target = target
self.state = state
self.rule = rule
self.neighborhood = neighborhood
self.reads = reads
self.schedule = schedule
self.stochastic = stochastic
def _get_names(self) -> tuple[str, ...]:
"""Return the names of the states the rule sets."""
return (self.state,) if isinstance(self.state, str) else tuple(self.state)
def _check(self) -> None:
"""Raise an error for states that are not names, or a neighbourhood that is not one.
Raises:
ValidationError:
The state or the read states are not names, or the neighbourhood is not a neighbourhood.
"""
super()._check()
names = [*self._get_names(), *(self.reads or ())]
if not names or not all(isinstance(name, str) and name.isidentifier() for name in names):
error_msg = f'The local rule {self.label!r} sets {self.state!r} and reads {self.reads!r}. Give state names.'
raise ValidationError(error_msg)
if not isinstance(self.neighborhood, BaseNeighborhood):
error_msg = f'The neighbourhood of the local rule {self.label!r} is {self.neighborhood!r}. Give one.'
raise ValidationError(error_msg)
def _get_laws(self, namespace: SimpleNamespace) -> list[BaseLaw]:
"""Return the local rule law of the states of the target.
Args:
namespace:
The namespace of the symbols the laws can use, with `namespace.target`.
Returns:
laws:
The local rule law.
"""
targets = tuple(getattr(self._get_member(namespace, 'target'), name) for name in self._get_names())
reads = (
None
if self.reads is None
else tuple(getattr(self._get_member(namespace, 'target'), name) for name in self.reads)
)
return [
LocalRuleLaw(
targets[0] if isinstance(self.state, str) else targets,
self.neighborhood,
self.rule,
reads=reads,
schedule=self.schedule,
stochastic=self.stochastic,
label=self.label,
),
]