Option#

class hugr.tys.Option(*tys: Type)[source]#

Bases: Sum

Optional tuple of elements.

Instances of this type correspond to Sum with two variants. The second variant is the tuple of elements, the first is empty.

Methods

as_tuple

resolve

Resolve types in the sum type using the given registry.

type_arg

The TypeTypeArg for this type.

type_bound

The bound of this type.

Attributes

variant_rows

resolve(registry: ext.ExtensionRegistry) Sum#

Resolve types in the sum type using the given registry.

type_arg() TypeTypeArg#

The TypeTypeArg for this type.

Example

>>> Qubit.type_arg()
TypeTypeArg(ty=Qubit)
type_bound() TypeBound#

The bound of this type.

Example

>>> Tuple(Bool, Bool).type_bound()
<TypeBound.Copyable: 'C'>
>>> Tuple(Qubit, Bool).type_bound()
<TypeBound.Any: 'A'>