API Reference¶
Complete API documentation for gds-framework, auto-generated from source docstrings.
Core¶
| Module | Description |
|---|---|
| gds | Package root — version, top-level imports |
| gds.spec | GDSSpec central registry |
| gds.canonical | Canonical h = f . g decomposition |
Blocks & Composition¶
| Module | Description |
|---|---|
| gds.blocks | AtomicBlock, roles, composition operators |
| gds.compiler | 3-stage compiler: flatten, wire, hierarchy |
| gds.ir | SystemIR, BlockIR, WiringIR, HierarchyNodeIR |
Type System¶
| Module | Description |
|---|---|
| gds.types | TypeDef, token utilities, port helpers |
| gds.spaces | Space, EMPTY, TERMINAL |
| gds.state | Entity, StateVariable |
Verification & Query¶
| Module | Description |
|---|---|
| gds.verification | Generic checks (G-001..G-006), semantic checks (SC-001..SC-007) |
| gds.query | Structural queries on specs and IR |
| gds.parameters | ParameterDef — structural metadata |
Utilities¶
| Module | Description |
|---|---|
| gds.serialize | Serialization support |