Skip to content

HUGR documentation

Python API Reference

hugr
- build
  - base
    - ParentBuilder
  - cfg
    - Block
    - Cfg
  - cond_loop
    - Case
    - Conditional
    - Else
    - If
    - TailLoop
    - ConditionalError
  - dfg
  - function
    - Module
  - tracked_dfg
    - TrackedDfg
- cli
  - convert
  - describe
  - describe_str
  - mermaid
  - validate
  - EntrypointDesc
  - ExtensionDesc
  - ModuleDesc
  - PackageDesc
- conftest
- debug_info
- envelope
- exceptions
- ext
- hugr
  - base
    - Hugr
    - NodeData
  - node_port
    - Direction
    - InPort
    - Node
    - OutPort
    - ToNode
    - Wire
  - render
- metadata
- 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
    - ModelExport
  - load
- 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
- passes
  - composable
  - scope
- qsystem
  - result
    - DataPrimitive
    - DataValue
    - HResult
    - HShots
    - QsysResult
    - QsysShot
- std
  - collections
    - array
      - Array
      - ArrayVal
    - borrow_array
      - BorrowArray
      - BorrowArrayVal
    - list
      - List
      - ListVal
    - static_array
      - StaticArray
      - StaticArrayVal
  - float
    - FloatVal
  - int
    - INT_T
    - DivMod
    - int_t
    - IntVal
  - logic
    - Not
  - prelude
    - StringVal
  - ptr
    - Ptr
- tys
  - TypeRow
  - Qubit
  - Bool
  - Unit
  - Kind
  - get_first_sum
  - Alias
  - BoundedNatArg
  - BoundedNatParam
  - BytesArg
  - BytesParam
  - CFKind
  - ConstKind
  - ConstParam
  - Either
  - ExtType
  - FloatArg
  - FloatParam
  - FunctionKind
  - FunctionType
  - ListArg
  - ListConcatArg
  - ListParam
  - Opaque
  - Option
  - OrderKind
  - PolyFuncType
  - RowVariable
  - StringArg
  - StringParam
  - Sum
  - Tuple
  - TupleArg
  - TupleConcatArg
  - TupleParam
  - Type
  - TypeArg
  - TypeParam
  - TypeTypeArg
  - TypeTypeParam
  - USize
  - UnitSum
  - ValueKind
  - Variable
  - VariableArg
- utils
- val
  - Unit
  - TRUE
  - FALSE
  - bool_value
  - Extension
  - ExtensionValue
  - Function
  - Left
  - None_
  - Right
  - Some
  - Sum
  - Tuple
  - UnitSum
  - Value

PyPI
Github

Rust API Reference

Rust crate
Rust API docs
Github

Specification

HUGR Specification

Back to top

prelude¶

HUGR prelude values.

Classes

StringVal

Custom value for a string.

Made with Sphinx and @pradyunsg's Furo