core/language_packs/scalar_equivalence.py
Shay 58a94c8e4b
feat: implement kernel substrate tranche 1 base-layer foundations (#829)
* feat: implement kernel substrate tranche 1 base-layer foundations

* fix(kernel): ground scalar spans and tighten morphology labels

Add extract_scalar_candidates() with exact source spans and problem_text
provenance while keeping canonicalize_scalar() as the detached pack helper.
Morphology labels now emit missing_* only when substrate frame/unit lookups
actually fail, not on mere trigger-surface presence.
2026-06-18 18:46:20 -07:00

446 lines
No EOL
15 KiB
Python

"""Scalar equivalence facade — canonical rational scalar facts from ADR-0128.
Tranche 1 — broad base-layer foundations.
Thin facade over ``numerics_loader.py`` exposing canonical ``Fraction``
values for scalar surfaces. Respects ADR-0128 boundaries: if a surface
is refused by the underlying pack, this facade does not silently broaden it.
``canonicalize_scalar`` is the pack-level helper for detached surfaces.
``extract_scalar_candidates`` is the text-level API that grounds spans in
problem text with ``problem_text`` provenance.
The facade MAY emit ``ScalarCandidate`` records.
It MAY NOT solve problems, bind base quantities, choose operations,
or infer final answers.
"""
from __future__ import annotations
import re
from dataclasses import dataclass
from fractions import Fraction
from language_packs.ambiguity_hazards import lookup_hazards
from language_packs.numerics_loader import (
FractionEntry,
MultiplierEntry,
ParsedNumber,
lookup_fraction,
lookup_multiplier,
match_number_format,
number_format_entries,
)
# ---------------------------------------------------------------------------
# Documented unsupported surfaces — Tranche 1 scope.
# ---------------------------------------------------------------------------
_UNSUPPORTED_SURFACES: tuple[str, ...] = (
".5", # no leading digit — ambiguous tokenisation
"1 / 2", # spaces around slash — not a single token
)
PROVENANCE_PROBLEM_TEXT: str = "problem_text"
# ---------------------------------------------------------------------------
# Source category constants — closed set per Tranche 1 spec.
# ---------------------------------------------------------------------------
SOURCE_FRACTION_WORD: str = "fraction_word"
SOURCE_FRACTION_SYMBOL: str = "fraction_symbol"
SOURCE_PERCENTAGE: str = "percentage"
SOURCE_DECIMAL: str = "decimal"
SOURCE_SLASH_FRACTION: str = "slash_fraction"
SOURCE_MULTIPLIER: str = "multiplier"
# Mapping from FractionEntry morphology to source category.
_MORPHOLOGY_TO_SOURCE: dict[str, str] = {
"fraction": SOURCE_FRACTION_WORD,
"fraction-symbol": SOURCE_FRACTION_SYMBOL,
"fraction-compound": SOURCE_FRACTION_WORD,
}
# Mapping from number-format format_id to source category.
_FORMAT_ID_TO_SOURCE: dict[str, str] = {
"decimal": SOURCE_DECIMAL,
"slash_fraction": SOURCE_SLASH_FRACTION,
"mixed_number": SOURCE_SLASH_FRACTION,
"percentage": SOURCE_PERCENTAGE,
"thousand_separated": SOURCE_DECIMAL,
"signed_integer": SOURCE_DECIMAL,
}
# Format search priority — longer / more specific patterns first.
_FORMAT_SEARCH_ORDER: tuple[str, ...] = (
"mixed_number",
"slash_fraction",
"percentage",
"decimal",
"thousand_separated",
"signed_integer",
)
_UNICODE_FRACTION_SYMBOLS: frozenset[str] = frozenset({"½", "¼", "¾", "", ""})
_WORD_SCALAR_PATTERNS: tuple[re.Pattern[str], ...] = (
re.compile(r"three\s+quarters?", re.IGNORECASE),
re.compile(r"two\s+thirds?", re.IGNORECASE),
re.compile(r"one\s+quarter", re.IGNORECASE),
re.compile(r"one\s+third", re.IGNORECASE),
re.compile(r"one\s+half", re.IGNORECASE),
re.compile(r"one-half", re.IGNORECASE),
re.compile(r"one-third", re.IGNORECASE),
re.compile(r"three-quarters?", re.IGNORECASE),
re.compile(r"\bhalf\b", re.IGNORECASE),
re.compile(r"\bquarter\b", re.IGNORECASE),
re.compile(r"\bthird\b", re.IGNORECASE),
)
# ---------------------------------------------------------------------------
# ScalarCandidate — frozen, immutable result record.
# ---------------------------------------------------------------------------
@dataclass(frozen=True, slots=True)
class ScalarCandidate:
"""A canonicalised scalar value derived from a surface string.
``canonical`` is always an exact ``fractions.Fraction`` — never a float.
``source`` classifies how the value was resolved (see source constants).
``entry_id`` is the ``en_numerics_v1`` entry id when the value came from
a pack-backed lookup, ``None`` for purely format-parsed values.
``hazards`` carries hazard IDs from the ambiguity registry.
Grounding fields are populated only by :func:`extract_scalar_candidates`.
Detached :func:`canonicalize_scalar` results leave them ``None``.
"""
surface: str
canonical: Fraction
source: str
entry_id: str | None
hazards: tuple[str, ...]
source_surface: str | None = None
source_span: tuple[int, int] | None = None
provenance_kind: str | None = None
# ---------------------------------------------------------------------------
# Internal helpers
# ---------------------------------------------------------------------------
def _collect_hazard_ids(surface: str) -> tuple[str, ...]:
"""Look up ambiguity hazards for *surface* and return their IDs."""
hazards = lookup_hazards(surface)
if not hazards:
return ()
return tuple(h.hazard_id for h in hazards)
def _fraction_entry_to_candidate(
surface: str,
entry: FractionEntry,
*,
source_surface: str | None = None,
source_span: tuple[int, int] | None = None,
provenance_kind: str | None = None,
) -> ScalarCandidate:
"""Convert a ``FractionEntry`` to a ``ScalarCandidate``."""
canonical = Fraction(entry.numerator, entry.denominator)
if entry.morphology == "fraction-symbol" or surface in _UNICODE_FRACTION_SYMBOLS:
source = SOURCE_FRACTION_SYMBOL
else:
source = _MORPHOLOGY_TO_SOURCE.get(entry.morphology, SOURCE_FRACTION_WORD)
return ScalarCandidate(
surface=surface,
canonical=canonical,
source=source,
entry_id=entry.entry_id,
hazards=_collect_hazard_ids(surface),
source_surface=source_surface,
source_span=source_span,
provenance_kind=provenance_kind,
)
def _parsed_number_to_candidate(
surface: str,
parsed: ParsedNumber,
*,
source_surface: str | None = None,
source_span: tuple[int, int] | None = None,
provenance_kind: str | None = None,
) -> ScalarCandidate | None:
"""Convert a ``ParsedNumber`` to a ``ScalarCandidate``.
Ensures the canonical value is an exact ``Fraction``.
"""
source = _FORMAT_ID_TO_SOURCE.get(parsed.format_id)
if source is None:
return None
# Derive an exact Fraction from the raw string, avoiding float intermediaries.
canonical: Fraction
if parsed.format_id == "percentage":
# Raw is like "50%" or "12.5%" — strip '%', convert to Fraction, divide by 100.
number_str = parsed.raw.rstrip("%")
canonical = Fraction(number_str) / 100
elif parsed.format_id == "decimal":
# Raw is like "0.5" or "-3.14" — Fraction(str) gives exact representation.
canonical = Fraction(parsed.raw)
elif parsed.format_id == "slash_fraction":
# Raw is like "1/2" or "-3/4" — Fraction(str) handles this directly.
canonical = Fraction(parsed.raw)
elif parsed.format_id == "mixed_number":
# Raw is like "1 1/2" — parsed.value is already a Fraction from the loader.
if isinstance(parsed.value, Fraction):
canonical = parsed.value
else:
# Fallback: parse manually.
parts = parsed.raw.split(" ", 1)
sign = 1
body = parsed.raw
if body.startswith("-"):
sign = -1
body = body[1:]
parts = body.split(" ", 1)
whole = int(parts[0])
frac = Fraction(parts[1])
canonical = Fraction(sign * (whole + frac))
elif parsed.format_id == "thousand_separated":
# Raw is like "1,000" — parsed.value is int.
canonical = Fraction(int(str(parsed.value)))
elif parsed.format_id == "signed_integer":
# Raw is like "-42" or "7" — parsed.value is int.
canonical = Fraction(int(str(parsed.value)))
else:
return None
return ScalarCandidate(
surface=surface,
canonical=canonical,
source=source,
entry_id=None,
hazards=_collect_hazard_ids(surface),
source_surface=source_surface,
source_span=source_span,
provenance_kind=provenance_kind,
)
def _multiplier_entry_to_candidate(
surface: str,
entry: MultiplierEntry,
*,
source_surface: str | None = None,
source_span: tuple[int, int] | None = None,
provenance_kind: str | None = None,
) -> ScalarCandidate:
"""Convert a ``MultiplierEntry`` to a ``ScalarCandidate``.
The multiplier factor is stored as float in the pack; we convert to
an exact Fraction via the string representation for clean rationals.
"""
canonical = Fraction(entry.factor).limit_denominator(10000)
return ScalarCandidate(
surface=surface,
canonical=canonical,
source=SOURCE_MULTIPLIER,
entry_id=entry.entry_id,
hazards=_collect_hazard_ids(surface),
source_surface=source_surface,
source_span=source_span,
provenance_kind=provenance_kind,
)
def _strip_regex_anchors(regex: str) -> str:
body = regex
if body.startswith("^"):
body = body[1:]
if body.endswith("$"):
body = body[:-1]
return body
def _format_search_patterns() -> tuple[re.Pattern[str], ...]:
by_id = {fmt.format_id: fmt for fmt in number_format_entries()}
patterns: list[re.Pattern[str]] = []
for format_id in _FORMAT_SEARCH_ORDER:
fmt = by_id.get(format_id)
if fmt is None:
continue
body = _strip_regex_anchors(fmt.regex)
# Allow trailing sentence punctuation; refuse embedded spaced slashes.
patterns.append(
re.compile(
r"(?<!\S)" + body + r"(?=\s|$|[.,;:!?)\]}\"'])"
)
)
return tuple(patterns)
def _is_rejected_span(text: str, start: int, end: int, surface: str) -> bool:
"""Reject ambiguous spans such as ``1`` in ``1 / 2`` or ``.5`` tokenisations."""
if surface in _UNSUPPORTED_SURFACES:
return True
if surface.startswith("."):
return True
if start > 0 and text[start - 1] == ".":
return True
if re.match(r"\s+/\s+\d", text[end:]):
return True
if re.search(r"/\s+$", text[:start]):
return True
if re.match(r"\.\d+\b", text[start:end] if start == 0 else text[max(0, start - 1):end]):
return True
return False
def _select_non_overlapping(
spans: list[tuple[int, int, str]],
) -> list[tuple[int, int, str]]:
"""Greedy longest-leftmost selection, then return in span order."""
ranked = sorted(spans, key=lambda item: (item[0], -(item[1] - item[0])))
selected: list[tuple[int, int, str]] = []
occupied: list[tuple[int, int]] = []
for start, end, surface in ranked:
overlaps = any(not (end <= occ_start or start >= occ_end) for occ_start, occ_end in occupied)
if overlaps:
continue
selected.append((start, end, surface))
occupied.append((start, end))
return sorted(selected, key=lambda item: item[0])
def _discover_scalar_spans(text: str) -> list[tuple[int, int, str]]:
spans: list[tuple[int, int, str]] = []
for pattern in _format_search_patterns():
for match in pattern.finditer(text):
start, end = match.start(), match.end()
surface = match.group(0)
if _is_rejected_span(text, start, end, surface):
continue
spans.append((start, end, surface))
for symbol in _UNICODE_FRACTION_SYMBOLS:
start = 0
while True:
idx = text.find(symbol, start)
if idx < 0:
break
spans.append((idx, idx + len(symbol), symbol))
start = idx + len(symbol)
for pattern in _WORD_SCALAR_PATTERNS:
for match in pattern.finditer(text):
spans.append((match.start(), match.end(), match.group(0)))
return _select_non_overlapping(spans)
def _grounded_candidate(
text: str,
start: int,
end: int,
source_surface: str,
detached: ScalarCandidate,
) -> ScalarCandidate:
if text[start:end] != source_surface:
raise ValueError(
f"source span [{start}:{end}] does not slice source_surface {source_surface!r}"
)
return ScalarCandidate(
surface=detached.surface,
canonical=detached.canonical,
source=detached.source,
entry_id=detached.entry_id,
hazards=detached.hazards,
source_surface=source_surface,
source_span=(start, end),
provenance_kind=PROVENANCE_PROBLEM_TEXT,
)
# ---------------------------------------------------------------------------
# Public API
# ---------------------------------------------------------------------------
def canonicalize_scalar(surface: str) -> ScalarCandidate | None:
"""Attempt to canonicalize a surface string to an exact Fraction.
Resolution order:
1. Try ``lookup_fraction`` (handles word forms, symbols, compounds).
2. Try ``match_number_format`` (handles ``1/2``, ``0.5``, ``50%``, etc.).
3. Try ``lookup_multiplier`` (handles ``half`` as multiplier).
Returns ``None`` if the surface is unsupported or refused by the
underlying pack. Detached results do not carry span/provenance fields.
"""
if not surface:
return None
# Explicitly refuse documented unsupported surfaces.
if surface in _UNSUPPORTED_SURFACES:
return None
# 1. Fraction lookup — word forms, Unicode symbols, compounds.
frac_entry: FractionEntry | None = lookup_fraction(surface)
if frac_entry is not None:
return _fraction_entry_to_candidate(surface, frac_entry)
# 2. Number format matching — slash fractions, decimals, percentages, etc.
parsed: ParsedNumber | None = match_number_format(surface)
if parsed is not None:
candidate = _parsed_number_to_candidate(surface, parsed)
if candidate is not None:
return candidate
# 3. Multiplier lookup — 'half' as multiplier, 'double', 'triple'.
mult_entry: MultiplierEntry | None = lookup_multiplier(surface)
if mult_entry is not None:
return _multiplier_entry_to_candidate(surface, mult_entry)
return None
def extract_scalar_candidates(text: str) -> tuple[ScalarCandidate, ...]:
"""Extract grounded scalar candidates from problem text.
Every emitted candidate carries:
* ``source_surface`` — exact substring from *text*
* ``source_span`` — ``(start, end)`` character offsets
* ``provenance_kind`` — ``"problem_text"``
* ``canonical`` — exact ``Fraction``
* ``source`` — scalar resolution kind
* ``hazards`` — ambiguity hazard IDs
Candidates are returned in deterministic span order (left-to-right).
Unsupported surfaces (``.5``, ``1 / 2``, etc.) are omitted.
"""
if not text:
return ()
candidates: list[ScalarCandidate] = []
for start, end, source_surface in _discover_scalar_spans(text):
detached = canonicalize_scalar(source_surface)
if detached is None:
continue
candidates.append(_grounded_candidate(text, start, end, source_surface, detached))
return tuple(candidates)
def is_supported_scalar(surface: str) -> bool:
"""Return ``True`` if the surface can be canonicalized."""
return canonicalize_scalar(surface) is not None
def list_unsupported_surfaces() -> tuple[str, ...]:
"""Return documented unsupported scalar surfaces.
These are surfaces that look numeric but are explicitly refused
by the pack or this facade due to tokenisation or ambiguity issues.
"""
return _UNSUPPORTED_SURFACES