Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode
Skip to content
Guppy v1.0.1 Documentation
Logo
Guppy v1.0.1 Documentation
  • Getting Started
  • Guppy Language Guide
    • Data types
      • Arrays
      • Tuples
      • Structs
      • Angles
      • Type Aliases
    • Functions
    • Type Argument Syntax
    • Control flow
    • Static compilation and typing
    • Differences between Guppy and Python
    • Ownership and Linear Types
    • Measurements
    • Comptime
    • Libraries
    • Custom Metadata
    • Protocols
    • Random Number Generation
    • Modifiers
      • Control
      • Dagger
      • Function flags
  • Examples Gallery
    • N-qubit GHZ and Graph state preparation
    • The SWAP test and loading pytket circuits
    • Canonical Quantum Phase estimation
    • Solving the Max-Cut Problem with QAOA
    • Repeat Until Success
    • Adaptive QPE
    • Random Number Generation
    • Postselection: exit and panic
    • Debugging with state_result statements
    • T state distillation and the Option type
  • guppylang API
    • @guppy decorator
    • Standard Library
      • angles
        • angle
      • array
        • ArrayIter
        • FrozenarrayIter
        • array
        • frozenarray
        • array_swap
      • bool
        • bool
      • builtins
        • array
        • bool
        • float
        • Function
        • frozenarray
        • int
        • list
        • Measurement
        • nat
        • Option
        • qubit
        • str
        • Unitary
        • Controllable
        • Daggerable
        • abs
        • callable
        • control
        • dagger
        • divmod
        • exit
        • len
        • nothing
        • output
        • panic
        • pow
        • power
        • range
        • result
        • round
        • some
      • lang
        • Controllable
        • Copy
        • Daggerable
        • Drop
        • Unitary
        • control
        • dagger
        • power
      • collections
        • PriorityQueue
        • Queue
        • Stack
        • empty_priority_queue
        • empty_queue
        • empty_stack
      • debug
        • state_output
        • state_result
      • either
        • Either
        • left
        • right
      • futures
        • Future
      • iter
        • range
        • SizedIter
        • range
      • list
        • list
      • mem
        • mem_swap
        • with_owned
      • num
        • float
        • int
        • nat
        • abs
        • bytecast_float_to_nat
        • bytecast_nat_to_float
        • divmod
        • len
        • pow
        • round
      • option
        • Option
        • nothing
        • some
      • platform
        • barrier
        • exit
        • output
        • panic
        • result
      • qsystem
        • functional
        • helios
          • MaybeLeaked
          • collect_measurements
          • lazy_measure
          • lazy_measure_and_reset
          • lazy_measure_and_reset_array
          • lazy_measure_array
          • measure
          • measure_and_reset
          • measure_and_reset_array
          • measure_array
          • measure_leaked
          • phased_x
          • qfree
          • reset
          • rz
          • zz_max
          • zz_phase
        • random
          • DiscreteDistribution
          • RNG
          • make_discrete_distribution
        • sol
          • MaybeLeaked
          • collect_measurements
          • lazy_measure
          • lazy_measure_and_reset
          • lazy_measure_and_reset_array
          • lazy_measure_array
          • measure
          • measure_and_reset
          • measure_and_reset_array
          • measure_array
          • measure_leaked
          • phased_x
          • phased_xx
          • phased_xx_max
          • qfree
          • reset
          • rz
          • xx_max
          • yy_max
        • utils
          • get_current_shot
        • wasm
          • spawn_wasm_contexts
      • quantum
        • Measurement
        • qubit
        • ch
        • collect_measurements
        • crz
        • cx
        • cy
        • cz
        • discard
        • discard_array
        • h
        • maybe_qubit
        • measure
        • measure_array
        • project_z
        • reset
        • rx
        • ry
        • rz
        • s
        • sdg
        • t
        • tdg
        • toffoli
        • v
        • vdg
        • x
        • y
        • z
        • functional
          • ch
          • crz
          • cx
          • cy
          • cz
          • h
          • project_z
          • reset
          • rx
          • ry
          • rz
          • s
          • sdg
          • t
          • tdg
          • toffoli
          • v
          • vdg
          • x
          • y
          • z
      • random
        • PCG32
        • seeded_pcg32
      • reflection
        • callable
      • string
        • str
      • err
        • Result
        • err
        • ok
    • Definitions
    • Library
    • Optimizer
      • OptimizerInstance
      • OptimizationLevel
    • Emulator
      • EmulatorInstance
      • EmulatorResult
      • QsysShot
      • TaggedResult
      • EmulatorBuilder
      • PartialVector
      • PartialState
      • TracedState
      • EmulatorError
      • EmulatorBuildError
    • Experimental
  • Changelog
  • Migrating to Guppy Version 1.0
  • Migrating to Guppy from pytket
  • FAQs
  • Guppy v0.x docs (old)
  • GitHub
Back to top

guppylang API¶

  • @guppy decorator
  • Standard Library
  • Definitions
  • Library
  • Optimizer
  • Emulator
  • Experimental

Indices and tables¶

  • Index

  • Module Index

  • Search Page

Next
@guppy decorator
Previous
T state distillation and the Option type
Copyright © 2025 Quantinuum Ltd. All rights reserved.
Privacy Statement
/
Cookie Notice
/
Terms and Conditions
Made with Sphinx and @pradyunsg's Furo
On this page
  • guppylang API
    • Indices and tables