tnfr 4.5.2__py3-none-any.whl → 7.0.0__py3-none-any.whl

tnfr/dynamics/__init__.pyi

@@ -0,0 +1,82 @@
+from typing import Any, Literal, Sequence
+
+from tnfr.types import GlyphCode, TNFRGraph
+from tnfr.validation import ValidationOutcome
+
+__all__: tuple[str, ...]
+
+dnfr: Any
+integrators: Any
+
+ALIAS_D2EPI: Sequence[str]
+ALIAS_DNFR: Sequence[str]
+ALIAS_DSI: Sequence[str]
+ALIAS_EPI: Sequence[str]
+ALIAS_SI: Sequence[str]
+ALIAS_VF: Sequence[str]
+
+AbstractSelector: Any
+DefaultGlyphSelector: Any
+ParametricGlyphSelector: Any
+_SelectorPreselection: Any
+_apply_glyphs: Any
+_apply_selector: Any
+_choose_glyph: Any
+_configure_selector_weights: Any
+ProcessPoolExecutor: Any
+_maybe_remesh: Any
+_normalize_job_overrides: Any
+_prepare_dnfr: Any
+_prepare_dnfr_data: Any
+_prepare_selector_preselection: Any
+_resolve_jobs_override: Any
+_resolve_preselected_glyph: Any
+_run_after_callbacks: Any
+_run_before_callbacks: Any
+_run_validators: Any
+_selector_parallel_jobs: Any
+_update_epi_hist: Any
+_update_node_sample: Any
+_update_nodes: Any
+_compute_dnfr: Any
+_compute_neighbor_means: Any
+_init_dnfr_cache: Any
+_refresh_dnfr_vectors: Any
+adapt_vf_by_coherence: Any
+apply_canonical_clamps: Any
+coordinate_global_local_phase: Any
+default_compute_delta_nfr: Any
+default_glyph_selector: Any
+dnfr_epi_vf_mixed: Any
+dnfr_laplacian: Any
+dnfr_phase_only: Any
+enforce_canonical_grammar: Any
+get_numpy: Any
+on_applied_glyph: Any
+apply_glyph: Any
+parametric_glyph_selector: Any
+
+AbstractIntegrator: Any
+DefaultIntegrator: Any
+
+def prepare_integration_params(
+    G: TNFRGraph,
+    dt: float | None = ...,
+    t: float | None = ...,
+    method: Literal["euler", "rk4"] | None = ...,
+) -> tuple[float, int, float, Literal["euler", "rk4"]]: ...
+
+run: Any
+set_delta_nfr_hook: Any
+step: Any
+
+def update_epi_via_nodal_equation(
+    G: TNFRGraph,
+    *,
+    dt: float | None = ...,
+    t: float | None = ...,
+    method: Literal["euler", "rk4"] | None = ...,
+    n_jobs: int | None = ...,
+) -> None: ...
+
+def validate_canon(G: TNFRGraph) -> ValidationOutcome[TNFRGraph]: ...

tnfr/dynamics/adaptation.py

@@ -0,0 +1,267 @@
+"""νf adaptation routines for TNFR dynamics."""
+
+from __future__ import annotations
+
+import math
+from concurrent.futures import ProcessPoolExecutor
+from typing import Any, cast
+
+from ..alias import collect_attr, set_vf
+from ..constants import get_graph_param
+from ..utils import clamp, resolve_chunk_size
+from ..metrics.common import ensure_neighbors_map
+from ..types import CoherenceMetric, DeltaNFR, NodeId, TNFRGraph
+from ..utils import get_numpy
+from .aliases import ALIAS_DNFR, ALIAS_SI, ALIAS_VF
+
+__all__ = ("adapt_vf_by_coherence",)
+
+
+def _vf_adapt_chunk(
+    args: tuple[list[tuple[Any, int, tuple[int, ...]]], tuple[float, ...], float],
+) -> list[tuple[Any, float]]:
+    """Return proposed νf updates for ``chunk`` of stable nodes."""
+
+    chunk, vf_values, mu = args
+    updates: list[tuple[Any, float]] = []
+    for node, idx, neighbor_idx in chunk:
+        vf = vf_values[idx]
+        if neighbor_idx:
+            mean = math.fsum(vf_values[j] for j in neighbor_idx) / len(neighbor_idx)
+        else:
+            mean = vf
+        updates.append((node, vf + mu * (mean - vf)))
+    return updates
+
+
+def adapt_vf_by_coherence(G: TNFRGraph, n_jobs: int | None = None) -> None:
+    """Synchronise νf to the neighbour mean once ΔNFR and Si stay coherent.
+
+    Parameters
+    ----------
+    G : TNFRGraph
+        Graph that stores the TNFR nodes and configuration required for
+        adaptation. The routine reads ``VF_ADAPT_TAU`` (τ) to decide how many
+        consecutive stable steps a node must accumulate in ``stable_count``
+        before updating. The adaptation weight ``VF_ADAPT_MU`` (μ) controls how
+        quickly νf moves toward the neighbour mean. Stability is detected when
+        the absolute ΔNFR stays below ``EPS_DNFR_STABLE`` and the sense index Si
+        exceeds the selector threshold ``SELECTOR_THRESHOLDS['si_hi']`` (falling
+        back to ``GLYPH_THRESHOLDS['hi']``). Only nodes that satisfy both
+        thresholds for τ successive evaluations are eligible for μ-weighted
+        averaging.
+    n_jobs : int or None, optional
+        Number of worker processes used for eligible nodes. ``None`` (the
+        default) keeps the adaptation serial, ``1`` disables parallelism, and
+        any value greater than one dispatches chunks of nodes to a
+        :class:`~concurrent.futures.ProcessPoolExecutor` so large graphs can
+        adjust νf without blocking the main dynamic loop.
+
+    Returns
+    -------
+    None
+        The graph is updated in place; no value is returned.
+
+    Raises
+    ------
+    KeyError
+        Raised when ``G.graph`` lacks the canonical adaptation parameters and
+        defaults have not been injected.
+
+    Examples
+    --------
+    >>> from tnfr.constants import inject_defaults
+    >>> from tnfr.dynamics import adapt_vf_by_coherence
+    >>> from tnfr.structural import create_nfr
+    >>> G, seed = create_nfr("seed", vf=0.2)
+    >>> _, anchor = create_nfr("anchor", graph=G, vf=1.0)
+    >>> G.add_edge(seed, anchor)
+    >>> inject_defaults(G)
+    >>> G.graph["VF_ADAPT_TAU"] = 2      # τ: consecutive stable steps
+    >>> G.graph["VF_ADAPT_MU"] = 0.5      # μ: neighbour coupling strength
+    >>> G.graph["SELECTOR_THRESHOLDS"] = {"si_hi": 0.8}
+    >>> for node in G.nodes:
+    ...     G.nodes[node]["Si"] = 0.9      # above ΔSi threshold
+    ...     G.nodes[node]["ΔNFR"] = 0.0    # within |ΔNFR| ≤ eps guard
+    ...     G.nodes[node]["stable_count"] = 1
+    >>> adapt_vf_by_coherence(G)
+    >>> round(G.nodes[seed]["νf"], 2), round(G.nodes[anchor]["νf"], 2)
+    (0.6, 0.6)
+    >>> G.nodes[seed]["stable_count"], G.nodes[anchor]["stable_count"] >= 2
+    (2, True)
+    """
+
+    required_keys = ("VF_ADAPT_TAU", "VF_ADAPT_MU")
+    missing_keys = [key for key in required_keys if key not in G.graph]
+    if missing_keys:
+        missing_list = ", ".join(sorted(missing_keys))
+        raise KeyError(
+            "adapt_vf_by_coherence requires graph parameters "
+            f"{missing_list}; call tnfr.constants.inject_defaults(G) "
+            "before adaptation."
+        )
+
+    tau = get_graph_param(G, "VF_ADAPT_TAU", int)
+    mu = float(get_graph_param(G, "VF_ADAPT_MU"))
+    eps_dnfr = cast(DeltaNFR, get_graph_param(G, "EPS_DNFR_STABLE"))
+    thr_sel = get_graph_param(G, "SELECTOR_THRESHOLDS", dict)
+    thr_def = get_graph_param(G, "GLYPH_THRESHOLDS", dict)
+    si_hi = cast(
+        CoherenceMetric,
+        float(thr_sel.get("si_hi", thr_def.get("hi", 0.66))),
+    )
+    vf_min = float(get_graph_param(G, "VF_MIN"))
+    vf_max = float(get_graph_param(G, "VF_MAX"))
+
+    nodes = list(G.nodes)
+    if not nodes:
+        return
+
+    neighbors_map = ensure_neighbors_map(G)
+    node_count = len(nodes)
+    node_index = {node: idx for idx, node in enumerate(nodes)}
+
+    jobs: int | None
+    if n_jobs is None:
+        jobs = None
+    else:
+        try:
+            jobs = int(n_jobs)
+        except (TypeError, ValueError):
+            jobs = None
+        else:
+            if jobs <= 1:
+                jobs = None
+
+    np_mod = get_numpy()
+    use_np = np_mod is not None
+
+    si_values = collect_attr(G, nodes, ALIAS_SI, 0.0, np=np_mod if use_np else None)
+    dnfr_values = collect_attr(G, nodes, ALIAS_DNFR, 0.0, np=np_mod if use_np else None)
+    vf_values = collect_attr(G, nodes, ALIAS_VF, 0.0, np=np_mod if use_np else None)
+
+    if use_np:
+        np = np_mod  # type: ignore[assignment]
+        assert np is not None
+        si_arr = si_values.astype(float, copy=False)
+        dnfr_arr = np.abs(dnfr_values.astype(float, copy=False))
+        vf_arr = vf_values.astype(float, copy=False)
+
+        prev_counts = np.fromiter(
+            (int(G.nodes[node].get("stable_count", 0)) for node in nodes),
+            dtype=int,
+            count=node_count,
+        )
+        stable_mask = (si_arr >= si_hi) & (dnfr_arr <= eps_dnfr)
+        new_counts = np.where(stable_mask, prev_counts + 1, 0)
+
+        for node, count in zip(nodes, new_counts.tolist()):
+            G.nodes[node]["stable_count"] = int(count)
+
+        eligible_mask = new_counts >= tau
+        if not bool(eligible_mask.any()):
+            return
+
+        max_degree = 0
+        if node_count:
+            degree_counts = np.fromiter(
+                (len(neighbors_map.get(node, ())) for node in nodes),
+                dtype=int,
+                count=node_count,
+            )
+            if degree_counts.size:
+                max_degree = int(degree_counts.max())
+
+        if max_degree > 0:
+            neighbor_indices = np.zeros((node_count, max_degree), dtype=int)
+            mask = np.zeros((node_count, max_degree), dtype=bool)
+            for idx, node in enumerate(nodes):
+                neigh = neighbors_map.get(node, ())
+                if not neigh:
+                    continue
+                idxs = [node_index[nbr] for nbr in neigh if nbr in node_index]
+                if not idxs:
+                    continue
+                length = len(idxs)
+                neighbor_indices[idx, :length] = idxs
+                mask[idx, :length] = True
+            neighbor_values = vf_arr[neighbor_indices]
+            sums = (neighbor_values * mask).sum(axis=1)
+            counts = mask.sum(axis=1)
+            neighbor_means = np.where(counts > 0, sums / counts, vf_arr)
+        else:
+            neighbor_means = vf_arr
+
+        vf_updates = vf_arr + mu * (neighbor_means - vf_arr)
+        for idx in np.nonzero(eligible_mask)[0]:
+            node = nodes[int(idx)]
+            vf_new = clamp(float(vf_updates[int(idx)]), vf_min, vf_max)
+            set_vf(G, node, vf_new)
+        return
+
+    si_list = [float(val) for val in si_values]
+    dnfr_list = [abs(float(val)) for val in dnfr_values]
+    vf_list = [float(val) for val in vf_values]
+
+    prev_counts = [int(G.nodes[node].get("stable_count", 0)) for node in nodes]
+    stable_flags = [
+        si >= si_hi and dnfr <= eps_dnfr for si, dnfr in zip(si_list, dnfr_list)
+    ]
+    new_counts = [
+        prev + 1 if flag else 0 for prev, flag in zip(prev_counts, stable_flags)
+    ]
+
+    for node, count in zip(nodes, new_counts):
+        G.nodes[node]["stable_count"] = int(count)
+
+    eligible_nodes = [node for node, count in zip(nodes, new_counts) if count >= tau]
+    if not eligible_nodes:
+        return
+
+    if jobs is None:
+        for node in eligible_nodes:
+            idx = node_index[node]
+            neigh_indices = [
+                node_index[nbr]
+                for nbr in neighbors_map.get(node, ())
+                if nbr in node_index
+            ]
+            if neigh_indices:
+                total = math.fsum(vf_list[i] for i in neigh_indices)
+                mean = total / len(neigh_indices)
+            else:
+                mean = vf_list[idx]
+            vf_new = vf_list[idx] + mu * (mean - vf_list[idx])
+            set_vf(G, node, clamp(float(vf_new), vf_min, vf_max))
+        return
+
+    work_items: list[tuple[Any, int, tuple[int, ...]]] = []
+    for node in eligible_nodes:
+        idx = node_index[node]
+        neigh_indices = tuple(
+            node_index[nbr] for nbr in neighbors_map.get(node, ()) if nbr in node_index
+        )
+        work_items.append((node, idx, neigh_indices))
+
+    approx_chunk = math.ceil(len(work_items) / jobs) if jobs else None
+    chunk_size = resolve_chunk_size(
+        approx_chunk,
+        len(work_items),
+        minimum=1,
+    )
+    chunks = [
+        work_items[i : i + chunk_size] for i in range(0, len(work_items), chunk_size)
+    ]
+    vf_tuple = tuple(vf_list)
+    updates: dict[Any, float] = {}
+    with ProcessPoolExecutor(max_workers=jobs) as executor:
+        args = ((chunk, vf_tuple, mu) for chunk in chunks)
+        for chunk_updates in executor.map(_vf_adapt_chunk, args):
+            for node, value in chunk_updates:
+                updates[node] = float(value)
+
+    for node in eligible_nodes:
+        vf_new = updates.get(node)
+        if vf_new is None:
+            continue
+        set_vf(G, node, clamp(float(vf_new), vf_min, vf_max))

tnfr/dynamics/aliases.py

@@ -0,0 +1,23 @@
+"""Shared alias tokens used across TNFR dynamics submodules."""
+
+from __future__ import annotations
+
+from ..constants.aliases import (
+    ALIAS_D2EPI,
+    ALIAS_DNFR,
+    ALIAS_DSI,
+    ALIAS_EPI,
+    ALIAS_SI,
+    ALIAS_THETA,
+    ALIAS_VF,
+)
+
+__all__ = (
+    "ALIAS_VF",
+    "ALIAS_DNFR",
+    "ALIAS_EPI",
+    "ALIAS_SI",
+    "ALIAS_THETA",
+    "ALIAS_D2EPI",
+    "ALIAS_DSI",
+)