API documentation

class pytket.extensions.cutensornet.CuTensorNetHandle(device_id: int | None = None)

Initialise the cuTensorNet library with automatic workspace memory management.

Note

Always use as with CuTensorNetHandle() as libhandle: so that cuTensorNet handles are automatically destroyed at the end of execution.

handle

The cuTensorNet library handle created by this initialisation.

Type:

int

device_id

The ID of the device (GPU) where cuTensorNet is initialised. If not provided, defaults to cp.cuda.Device().

Type:

int

destroy() → None

Destroys the memory handle, releasing memory.

Only call this method if you are initialising a CuTensorNetHandle outside a with CuTensorNetHandle() as libhandle statement.

• General state (exact) simulation
  • GeneralState
    • GeneralState.__init__()
    • GeneralState.get_statevector()
    • GeneralState.expectation_value()
    • GeneralState.sample()
    • GeneralState.destroy()
  • cuQuantum contract API interface
    • TensorNetwork
    • PauliOperatorTensorNetwork
    • ExpectationValueTensorNetwork
    • tk_to_tensor_network()
    • measure_qubits_state()
    • get_operator_expectation_value()
    • get_circuit_overlap()
  • Pytket backend
    • CuTensorNetShotsBackend
      • CuTensorNetShotsBackend.process_circuits()
      • CuTensorNetShotsBackend.backend_info
    • CuTensorNetStateBackend
      • CuTensorNetStateBackend.process_circuits()
      • CuTensorNetStateBackend.backend_info
• Structured state evolution
  • Simulation
    • simulate()
    • SimulationAlgorithm
      • SimulationAlgorithm.TTNxGate
      • SimulationAlgorithm.MPSxGate
      • SimulationAlgorithm.MPSxMPO
    • Config
      • Config.__init__()
  • Classes
    • StructuredState
      • StructuredState.is_valid()
      • StructuredState.apply_gate()
      • StructuredState.apply_unitary()
      • StructuredState.apply_scalar()
      • StructuredState.vdot()
      • StructuredState.sample()
      • StructuredState.measure()
      • StructuredState.postselect()
      • StructuredState.expectation_value()
      • StructuredState.get_fidelity()
      • StructuredState.get_statevector()
      • StructuredState.get_amplitude()
      • StructuredState.get_qubits()
      • StructuredState.get_byte_size()
      • StructuredState.get_device_id()
      • StructuredState.update_libhandle()
      • StructuredState.copy()
    • TTNxGate
      • TTNxGate.__init__()
    • MPSxGate
      • MPSxGate.__init__()
      • MPSxGate.add_qubit()
    • MPSxMPO
      • MPSxMPO.__init__()
      • MPSxMPO.add_qubit()
  • Miscellaneous
    • prepare_circuit_mps()