Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

HUGR-py v0.12.1 API documentation.

Toggle table of contents sidebar

HUGR-py v0.12.1 API documentation.

hugr
Toggle navigation of hugr
- build
  Toggle navigation of build
  - base
    Toggle navigation of base
    - ParentBuilder
  - cfg
    Toggle navigation of cfg
    - Block
    - Cfg
  - cond_loop
    Toggle navigation of cond_loop
    - Case
    - Conditional
    - Else
    - If
    - TailLoop
    - ConditionalError
  - dfg
    Toggle navigation of dfg
  - function
    Toggle navigation of function
    - Module
  - tracked_dfg
    Toggle navigation of tracked_dfg
    - TrackedDfg
- envelope
  Toggle navigation of envelope
- exceptions
  Toggle navigation of exceptions
- ext
  Toggle navigation of ext
- hugr
  Toggle navigation of hugr
  - base
    Toggle navigation of base
    - Hugr
    - NodeData
  - node_port
    Toggle navigation of node_port
    - Direction
    - InPort
    - Node
    - OutPort
    - ToNode
    - Wire
  - render
    Toggle navigation of render
- model
  Toggle navigation of model
  - Apply
  - Block
  - Cfg
  - Conditional
  - CustomOp
  - DeclareAlias
  - DeclareConstructor
  - DeclareFunc
  - DeclareOperation
  - DefineAlias
  - DefineFunc
  - Dfg
  - Func
  - Import
  - InvalidOp
  - List
  - Literal
  - Module
  - Node
  - Op
  - Package
  - Param
  - Region
  - RegionKind
  - Splice
  - Symbol
  - TailLoop
  - Term
  - Tuple
  - Var
  - Wildcard
  - export
    Toggle navigation of export
    - ModelExport
- ops
  Toggle navigation of ops
  - is_dataflow_op
  - is_df_parent_op
  - AliasDecl
  - AliasDefn
  - AsExtOp
  - Break
  - CFG
  - Call
  - CallIndirect
  - Case
  - Command
  - Conditional
  - Const
  - Continue
  - Custom
  - DFG
  - DataflowBlock
  - DataflowOp
  - DfParentOp
  - ExitBlock
  - ExtOp
  - FuncDecl
  - FuncDefn
  - Input
  - Left
  - LoadConst
  - LoadFunc
  - MakeTuple
  - Module
  - Noop
  - Op
  - Output
  - RegisteredOp
  - Right
  - Some
  - Tag
  - TailLoop
  - UnpackTuple
  - IncompleteOp
  - InvalidPort
  - NoConcreteFunc
- package
  Toggle navigation of package
- qsystem
  Toggle navigation of qsystem
  - result
    Toggle navigation of result
    - DataPrimitive
    - DataValue
    - HResult
    - HShots
    - QsysResult
    - QsysShot
- std
  Toggle navigation of std
  - collections
    Toggle navigation of collections
    - array
      Toggle navigation of array
      - Array
      - ArrayVal
    - list
      Toggle navigation of list
      - List
      - ListVal
    - static_array
      Toggle navigation of static_array
      - StaticArray
      - StaticArrayVal
    - value_array
      Toggle navigation of value_array
      - ValueArray
      - ValueArrayVal
  - float
    Toggle navigation of float
    - FloatVal
  - int
    Toggle navigation of int
    - INT_T
    - DivMod
    - int_t
    - IntVal
  - logic
    Toggle navigation of logic
    - Not
  - prelude
    Toggle navigation of prelude
    - StringVal
- tys
  Toggle navigation of tys
  - TypeRow
  - Qubit
  - Bool
  - Unit
  - Kind
  - get_first_sum
  - Alias
  - BoundedNatArg
  - BoundedNatParam
  - CFKind
  - ConstKind
  - Either
  - ExtType
  - FunctionKind
  - FunctionType
  - ListParam
  - Opaque
  - Option
  - OrderKind
  - PolyFuncType
  - RowVariable
  - SequenceArg
  - StringArg
  - StringParam
  - Sum
  - Tuple
  - TupleParam
  - Type
  - TypeArg
  - TypeParam
  - TypeTypeArg
  - TypeTypeParam
  - USize
  - UnitSum
  - ValueKind
  - Variable
  - VariableArg
- utils
  Toggle navigation of utils
- val
  Toggle navigation of val
  - Unit
  - TRUE
  - FALSE
  - bool_value
  - Extension
  - ExtensionValue
  - Function
  - Left
  - None_
  - Right
  - Some
  - Sum
  - Tuple
  - UnitSum
  - Value

Github
HUGR Specification
pypi

Toggle table of contents sidebar

HUGR Python API Documentation¶

This is the API documentation for the HUGR Python package.

hugr is a Python package for the Quantinuum HUGR common representation.

Github
HUGR Specification
pypi

Indices and tables¶

Index
Module Index
Search Page

Copyright © 2025, Quantinuum

Made with Sphinx and @pradyunsg's Furo

On this page

HUGR Python API Documentation
- Indices and tables