graph
ZX graph construction, manipulation, and preparation for sampling.
ConnectedComponent dataclass
ConnectedComponent(
graph: BaseGraph, output_indices: list[int]
)
A connected subgraph with its associated output indices.
build_sampling_graph
build_sampling_graph(
built: GraphRepresentation,
sample_detectors: bool = False,
) -> BaseGraph
Build a ZX graph for sampling from a GraphRepresentation.
This is the internal implementation of get_sampling_graph.
Source code in src/tsim/core/graph.py
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 | |
classify_direct
classify_direct(
component: ConnectedComponent,
) -> tuple[int, bool] | None
Check if a component is directly determined by a single f-variable.
A component qualifies when its graph consists of exactly two vertices — one boundary output and one Z-spider — connected by a Hadamard edge, where the Z-spider carries a single f parameter and a constant phase of either 0 (no flip) or π (flip).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
component | ConnectedComponent | A connected component to classify. | required |
Returns:
| Type | Description |
|---|---|
tuple[int, bool] | None |
|
Source code in src/tsim/core/graph.py
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 | |
connected_components
connected_components(
g: BaseGraph,
) -> list[ConnectedComponent]
Return each connected component of g as its own ZX subgraph.
Each component is packaged inside a :class:ConnectedComponent that contains the subgraph and a list of output indices matching the original output indices.
Source code in src/tsim/core/graph.py
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | |
evaluate_graph
evaluate_graph(
g: GraphS, vals: dict[str, Fraction] | None = None
) -> np.ndarray
Evaluate a ZX graph to a tensor with given parameter values.
Source code in src/tsim/core/graph.py
447 448 449 450 451 452 453 454 455 456 457 458 459 | |
get_params
get_params(g: BaseGraph) -> set[str]
Get all parameter variables that appear in the graph and its scalar.
Collects variables from: - Vertex phases (g._phaseVars) - Scalar phase variables (phasevars_pi, phasevars_pi_pair, phasevars_halfpi) - Scalar phase pairs (phasepairs with paramsA, paramsB) - Scalar phase nodes (phasenodevars)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
g | BaseGraph | A ZX graph with parametrized phases | required |
Returns:
| Type | Description |
|---|---|
set[str] | Set of all variable names (e.g., {'f0', 'f2', 'm1'}) that appear in the graph |
Source code in src/tsim/core/graph.py
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 | |
prepare_graph
prepare_graph(
circuit: Circuit, *, sample_detectors: bool
) -> SamplingGraph
Prepare a circuit for compilation.
This function performs the graph preparation phase: 1. Parse the stim circuit into a ZX graph 2. Build the sampling graph (compose with adjoint, add outputs) 3. Reduce the graph via zx.full_reduce 4. Transform error basis via Gaussian elimination (e → f) 5. Clear the scalar (safe before stabilizer rank decomposition)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
circuit | Circuit | The quantum circuit to prepare. | required |
sample_detectors | bool | If True, prepare for detector sampling. If False, prepare for measurement sampling. | required |
Returns:
| Type | Description |
|---|---|
SamplingGraph | A SamplingGraph containing the reduced graph and error transformation. |
Source code in src/tsim/core/graph.py
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 | |
scale_horizontally
scale_horizontally(g: BaseGraph, scale: float) -> None
Scale horizontal positions of graph vertices by a factor of scale.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
g | BaseGraph | A ZX graph | required |
scale | float | The factor to scale the graph by | required |
Source code in src/tsim/core/graph.py
505 506 507 508 509 510 511 512 513 514 | |
squash_graph
squash_graph(g: BaseGraph) -> None
Compact the graph by placing vertices underneath their output connections.
Starting from output vertices, each vertex is placed directly underneath (same row, qubit - 1) its already-placed neighbor. Positions are assigned via BFS traversal from outputs, ensuring no (qubit, row) collisions.
Source code in src/tsim/core/graph.py
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 | |
transform_error_basis
transform_error_basis(
g: BaseGraph, num_e: int | None = None
) -> tuple[BaseGraph, np.ndarray]
Transform phase variables from the original 'e' basis to a reduced 'f' basis.
This function finds a linearly independent basis for the phase variables across all vertices and transforms them accordingly. The original variables (e0, e1, ...) are mapped to a smaller set (f0, f1, ...) where each f_i corresponds to a linear combination of original e variables.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
g | BaseGraph | A ZX graph with phase variables attached to vertices. | required |
num_e | int | None | Total number of e-variables. If provided, the returned matrix will have exactly this many columns (padded with zeros if needed). If None, the matrix will have only the columns that appear in the graph. | None |
Returns:
| Type | Description |
|---|---|
tuple[BaseGraph, ndarray] | A tuple containing: - The modified graph (same object, mutated in place) - A binary matrix of shape (num_f, num_e) where entry [i, j] = 1 means f_i depends on e_j. For example, if row 0 is [0, 1, 0, 1], then f0 = e1 XOR e3. |
Source code in src/tsim/core/graph.py
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 | |