metadataΒΆ

Metadata values defined by the TKET compiler.

Examples:
>>> from hugr import Hugr
>>> from tket.metadata import (
...     MaxQubitsHint,
...     PytketInputParameters,
...     PytketPhaseExpr,
...     PytketQubitRegisterNames,
... )
>>>
>>> hugr = Hugr()
>>> node = hugr[hugr.module_root]
>>>
>>> node.metadata[MaxQubitsHint] = 3
>>> node.metadata[PytketInputParameters] = ["theta", "phi"]
>>> node.metadata[PytketQubitRegisterNames] = [("q", [0]), ("ancilla", [1])]
>>> node.metadata[PytketPhaseExpr] = "1/2"
>>> node.metadata[MaxQubitsHint]
3
>>> node.metadata.get(PytketQubitRegisterNames)
[('q', [0]), ('ancilla', [1])]

Classes

RewriteTraceValue

Serialized rewrite trace metadata entry.

InlineAnnotation(*args, **kwargs)

Metadata hinting the compiler that a function declaration should be inlined at its call sites.

CircuitRewriteTraces(*args, **kwargs)

Metadata key for rewrite traces recorded during circuit transformation.

UnitaryFlags(*args, **kwargs)

Metadata key for unitary/modifier flags stored on a HUGR node.

PytketInputParameters(*args, **kwargs)

Metadata key for explicit names of input parameter wires.

PytketOpGroup(*args, **kwargs)

Metadata key for the pytket opgroup field on a decoded operation.

PytketBitRegisterNames(*args, **kwargs)

Metadata key for explicit names of input bit registers.

PytketQubitRegisterNames(*args, **kwargs)

Metadata key for explicit names of input qubit registers.

PytketPhaseExpr(*args, **kwargs)

Metadata key for the serialized pytket global phase expression.