Skip to content

gds.canonical

Bases: BaseModel

Canonical projection of a GDSSpec to formal GDS structure.

Pure derivation — always computable, never authoritative. GDSSpec remains ground truth.

Source code in packages/gds-framework/gds/canonical.py 
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
class CanonicalGDS(BaseModel):
    """Canonical projection of a GDSSpec to formal GDS structure.

    Pure derivation — always computable, never authoritative.
    GDSSpec remains ground truth.
    """

    model_config = ConfigDict(frozen=True)

    # State space X: entity.variable entries
    state_variables: tuple[tuple[str, str], ...] = ()

    # Parameter space Θ
    parameter_schema: ParameterSchema = Field(default_factory=ParameterSchema)

    # Controlled input space U_c: BoundaryAction forward_out
    input_ports: tuple[tuple[str, str], ...] = ()

    # Disturbance space W: disturbance-tagged BoundaryAction forward_out
    disturbance_ports: tuple[tuple[str, str], ...] = ()

    # Decision space D: (block_name, port_name) from Policy forward_out
    decision_ports: tuple[tuple[str, str], ...] = ()

    # Output space Y: (block_name, port_name) from ControlAction forward_out
    output_ports: tuple[tuple[str, str], ...] = ()

    # Structural decomposition: block names by role
    boundary_blocks: tuple[str, ...] = ()
    control_blocks: tuple[str, ...] = ()
    policy_blocks: tuple[str, ...] = ()
    mechanism_blocks: tuple[str, ...] = ()

    # Mechanism update targets: (entity, variable) per mechanism
    update_map: tuple[tuple[str, tuple[tuple[str, str], ...]], ...] = ()

    # Admissibility deps: (constraint_name, ((entity, var), ...))
    admissibility_map: tuple[tuple[str, tuple[tuple[str, str], ...]], ...] = ()

    # Mechanism read deps: (mechanism_name, ((entity, var), ...))
    read_map: tuple[tuple[str, tuple[tuple[str, str], ...]], ...] = ()

    @property
    def has_parameters(self) -> bool:
        """True if the system has any parameters."""
        return len(self.parameter_schema) > 0

    @property
    def has_disturbances(self) -> bool:
        """True if the system has disturbance-tagged inputs."""
        return len(self.disturbance_ports) > 0

    def formula(self) -> str:
        """Render as mathematical formula string."""
        has_f = len(self.mechanism_blocks) > 0
        has_g = len(self.policy_blocks) > 0
        has_c = len(self.control_blocks) > 0

        if has_f and has_g:
            decomp = "f ∘ g"
        elif has_g:
            decomp = "g"
        elif has_f:
            decomp = "f"
        else:
            decomp = "id"

        if self.has_parameters:
            decomp_theta = decomp.replace("f", "f_θ").replace("g", "g_θ")
            result = f"h_θ : X → X  (h = {decomp_theta}, θ ∈ Θ)"
        else:
            result = f"h : X → X  (h = {decomp})"

        if has_c:
            result += ", y = C(x, d)"

        if self.has_disturbances:
            result += "; f : X x D x W → X"

        return result

has_parameters property

True if the system has any parameters.

has_disturbances property

True if the system has disturbance-tagged inputs.

formula()

Render as mathematical formula string.

Source code in packages/gds-framework/gds/canonical.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
def formula(self) -> str:
    """Render as mathematical formula string."""
    has_f = len(self.mechanism_blocks) > 0
    has_g = len(self.policy_blocks) > 0
    has_c = len(self.control_blocks) > 0

    if has_f and has_g:
        decomp = "f ∘ g"
    elif has_g:
        decomp = "g"
    elif has_f:
        decomp = "f"
    else:
        decomp = "id"

    if self.has_parameters:
        decomp_theta = decomp.replace("f", "f_θ").replace("g", "g_θ")
        result = f"h_θ : X → X  (h = {decomp_theta}, θ ∈ Θ)"
    else:
        result = f"h : X → X  (h = {decomp})"

    if has_c:
        result += ", y = C(x, d)"

    if self.has_disturbances:
        result += "; f : X x D x W → X"

    return result

Pure function: GDSSpec → CanonicalGDS.

Deterministic, stateless. Never mutates the spec.

Source code in packages/gds-framework/gds/canonical.py 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def project_canonical(spec: GDSSpec) -> CanonicalGDS:
    """Pure function: GDSSpec → CanonicalGDS.

    Deterministic, stateless. Never mutates the spec.
    """
    # 1. State space X: all entity variables
    state_variables: list[tuple[str, str]] = []
    for entity in spec.entities.values():
        for var_name in entity.variables:
            state_variables.append((entity.name, var_name))

    # 2. Parameter space Θ
    parameter_schema = spec.parameter_schema

    # 3. Classify blocks by role
    boundary_blocks: list[str] = []
    control_blocks: list[str] = []
    policy_blocks: list[str] = []
    mechanism_blocks: list[str] = []

    for bname, block in spec.blocks.items():
        if isinstance(block, BoundaryAction):
            boundary_blocks.append(bname)
        elif isinstance(block, ControlAction):
            control_blocks.append(bname)
        elif isinstance(block, Policy):
            policy_blocks.append(bname)
        elif isinstance(block, Mechanism):
            mechanism_blocks.append(bname)

    # 4. U_c / W partition: BoundaryAction forward_out ports
    input_ports: list[tuple[str, str]] = []
    disturbance_ports: list[tuple[str, str]] = []
    for bname in boundary_blocks:
        block = spec.blocks[bname]
        is_disturbance = getattr(block, "tags", {}).get("role") == "disturbance"
        target = disturbance_ports if is_disturbance else input_ports
        for p in block.interface.forward_out:
            target.append((bname, p.name))

    # 5. Decision space D: Policy forward_out ports
    decision_ports: list[tuple[str, str]] = []
    for bname in policy_blocks:
        block = spec.blocks[bname]
        for p in block.interface.forward_out:
            decision_ports.append((bname, p.name))

    # 6. Output space Y: ControlAction forward_out ports
    output_ports: list[tuple[str, str]] = []
    for bname in control_blocks:
        block = spec.blocks[bname]
        for p in block.interface.forward_out:
            output_ports.append((bname, p.name))

    # 7. Mechanism update targets
    update_map: list[tuple[str, tuple[tuple[str, str], ...]]] = []
    for bname in mechanism_blocks:
        block = spec.blocks[bname]
        if isinstance(block, Mechanism):
            updates = tuple(tuple(pair) for pair in block.updates)
            update_map.append((bname, updates))  # type: ignore[arg-type]

    # 8. Admissibility dependencies
    admissibility_map: list[tuple[str, tuple[tuple[str, str], ...]]] = []
    for ac_name, ac in spec.admissibility_constraints.items():
        deps = tuple(tuple(pair) for pair in ac.depends_on)
        admissibility_map.append((ac_name, deps))  # type: ignore[arg-type]

    # 9. Transition read map
    read_map: list[tuple[str, tuple[tuple[str, str], ...]]] = []
    for mname, ts in spec.transition_signatures.items():
        reads = tuple(tuple(pair) for pair in ts.reads)
        read_map.append((mname, reads))  # type: ignore[arg-type]

    return CanonicalGDS(
        state_variables=tuple(state_variables),
        parameter_schema=parameter_schema,
        input_ports=tuple(input_ports),
        disturbance_ports=tuple(disturbance_ports),
        decision_ports=tuple(decision_ports),
        output_ports=tuple(output_ports),
        boundary_blocks=tuple(boundary_blocks),
        control_blocks=tuple(control_blocks),
        policy_blocks=tuple(policy_blocks),
        mechanism_blocks=tuple(mechanism_blocks),
        update_map=tuple(update_map),
        admissibility_map=tuple(admissibility_map),
        read_map=tuple(read_map),
    )