Overview¶
The Pennylane Lightning C++ API is intended to be called from Python through Pybind11. Direct use of the C++ API is currently unsupported and is provided for reference only.
Class Hierarchy¶
-
- Namespace Catalyst
- Namespace Catalyst::Runtime
- Namespace Catalyst::Runtime::Simulator
- Template Class LightningGPUObsManager
- Class LightningGPUSimulator
- Template Class LightningKokkosObsManager
- Class LightningKokkosSimulator
- Template Class LightningObsManager
- Class LightningSimulator
- Namespace Catalyst::Runtime::Simulator
- Namespace Catalyst::Runtime
- Namespace Pennylane
- Namespace Pennylane::Algorithms
- Template Class AdjointJacobianBase
- Template Class JacobianData
- Template Class JacobianDataMPI
- Template Class OpsData
- Namespace Pennylane::LightningGPU
- Namespace Pennylane::LightningGPU::Algorithms
- Template Class AdjointJacobian
- Template Class AdjointJacobianMPI
- Namespace Pennylane::LightningGPU::cuGates
- Template Class DynamicGateDataAccess
- Namespace Pennylane::LightningGPU::Measures
- Template Class Measurements
- Template Class MeasurementsMPI
- Namespace Pennylane::LightningGPU::MPI
- Struct MPIWorkerDeleter
- Template Class CSRMatrix
- Class MPIManager
- Namespace Pennylane::LightningGPU::Observables
- Template Class Hamiltonian
- Template Class HamiltonianMPI
- Template Class HermitianObs
- Template Class HermitianObsMPI
- Template Class NamedObs
- Template Class NamedObsMPI
- Template Class SparseHamiltonian
- Template Class SparseHamiltonianMPI
- Template Class TensorProdObs
- Template Class TensorProdObsMPI
- Namespace Pennylane::LightningGPU::Util
- Struct HandleDeleter
- Struct handleDeleter
- Struct MatrixHasher
- Class CublasCaller
- Class CudaScopedDevice
- Template Class DataBuffer
- Template Class DevicePool
- Template Class DevTag
- Template Class GateCache
- Struct GateCache::gate_id_hash
- Template Class StateVectorCudaBase
- Template Class StateVectorCudaManaged
- Template Class StateVectorCudaMPI
- Namespace Pennylane::LightningGPU::Algorithms
- Namespace Pennylane::LightningKokkos
- Namespace Pennylane::LightningKokkos::Algorithms
- Template Class AdjointJacobian
- Namespace Pennylane::LightningKokkos::Functors
- Template Struct apply1QubitOpFunctor
- Template Struct apply2QubitOpFunctor
- Template Struct apply3QubitOpFunctor
- Template Struct apply4QubitOpFunctor
- Template Struct apply5QubitOpFunctor
- Template Struct applyNC1QubitOpFunctor
- Template Struct applyNC2QubitOpFunctor
- Template Struct applyNC3QubitOpFunctor
- Template Struct getExpectationValueHadamardFunctor
- Template Struct getExpectationValuePauliXFunctor
- Template Struct getExpectationValuePauliYFunctor
- Template Struct getExpectationValuePauliZFunctor
- Template Struct getExpectationValueSparseFunctor
- Template Struct getExpVal1QubitOpFunctor
- Template Struct getExpVal2QubitOpFunctor
- Template Struct getExpVal3QubitOpFunctor
- Template Struct getExpVal4QubitOpFunctor
- Template Struct getExpVal5QubitOpFunctor
- Template Struct getExpValMultiQubitOpFunctor
- Template Struct getTransposedFunctor
- Struct getTransposedIndexFunctor
- Template Struct multiQubitOpFunctor
- Template Struct NCMultiQubitOpFunctor
- Template Struct Sampler
- Template Class applyNC1Functor
- Template Class applyNC1Functor< PrecisionT, FuncT, false >
- Template Class applyNC1Functor< PrecisionT, FuncT, true >
- Template Class applyNC2Functor
- Template Class applyNC2Functor< PrecisionT, FuncT, false >
- Template Class applyNC2Functor< PrecisionT, FuncT, true >
- Template Class applyNC3Functor
- Template Class applyNC4Functor
- Template Class applyNC4Functor< PrecisionT, FuncT, false >
- Template Class applyNC4Functor< PrecisionT, FuncT, true >
- Template Class applyNCGenerator1Functor
- Template Class applyNCGenerator2Functor
- Template Class applyNCGenerator4Functor
- Template Class applyNCNFunctor
- Template Class getProbsFunctor
- Template Class getProbsNQubitOpFunctor
- Namespace Pennylane::LightningKokkos::Measures
- Template Class Measurements
- Namespace Pennylane::LightningKokkos::Observables
- Template Class Hamiltonian
- Template Class HermitianObs
- Template Class NamedObs
- Template Class SparseHamiltonian
- Template Class TensorProdObs
- Namespace Pennylane::LightningKokkos::Util
- Template Struct axpy_KokkosFunctor
- Template Struct getImagOfComplexInnerProductFunctor
- Template Struct getRealOfComplexInnerProductFunctor
- Template Struct SparseMV_KokkosFunctor
- Template Class StateVectorKokkos
- Namespace Pennylane::LightningKokkos::Algorithms
- Namespace Pennylane::LightningQubit
- Namespace Pennylane::LightningQubit::Algorithms
- Template Class AdjointJacobian
- Template Class VectorJacobianProduct
- Namespace Pennylane::LightningQubit::Gates
- Namespace Pennylane::LightningQubit::Gates::AVXCommon
- Template Struct ApplyCNOT
- Template Struct ApplyControlledPhaseShift
- Template Struct ApplyCRX
- Template Struct ApplyCRY
- Template Struct ApplyCRZ
- Template Struct ApplyCY
- Template Struct ApplyCZ
- Template Struct ApplyGeneratorIsingXX
- Template Struct ApplyGeneratorIsingYY
- Template Struct ApplyGeneratorIsingZZ
- Template Struct ApplyGeneratorPhaseShift
- Template Struct ApplyHadamard
- Template Struct ApplyIsingXX
- Template Struct ApplyIsingXY
- Template Struct ApplyIsingYY
- Template Struct ApplyIsingZZ
- Template Struct ApplyPauliX
- Template Struct ApplyPauliY
- Template Struct ApplyPauliZ
- Template Struct ApplyPhaseShift
- Template Struct ApplyRX
- Template Struct ApplyRY
- Template Struct ApplyRZ
- Template Struct ApplyS
- Template Struct ApplySingleQubitOp
- Template Struct ApplySWAP
- Template Struct ApplyT
- Template Struct AVX2Concept
- Template Struct AVX512Concept
- Template Class SingleQubitGateWithoutParamHelper
- Template Class SingleQubitGateWithParamHelper
- Template Class TwoQubitGateWithoutParamHelper
- Template Class TwoQubitGateWithParamHelper
- Struct GateIndices
- Template Struct GateOpToMemberFuncPtr
- Class GateImplementationsAVX2
- Class GateImplementationsAVX512
- Template Class GateImplementationsAVXCommon
- Class GateImplementationsLM
- Template Class PauliGenerator
- Namespace Pennylane::LightningQubit::Gates::AVXCommon
- Namespace Pennylane::LightningQubit::KernelMap
- Template Class OperationKernelMap
- Namespace Pennylane::LightningQubit::Measures
- Template Class DiscreteRandomVariable
- Template Class LocalTransitionKernel
- Template Class Measurements
- Template Class NonZeroRandomTransitionKernel
- Template Class TransitionKernel
- Namespace Pennylane::LightningQubit::Observables
- Template Class Hamiltonian
- Template Class HermitianObs
- Template Class NamedObs
- Template Class SparseHamiltonian
- Template Class TensorProdObs
- Namespace Pennylane::LightningQubit::Util
- Template Class IntegerInterval
- Template Class DynamicDispatcher
- Template Class StateVectorLQubit
- Template Class StateVectorLQubitManaged
- Template Class StateVectorLQubitRaw
- Namespace Pennylane::LightningQubit::Algorithms
- Namespace Pennylane::LightningTensor
- Namespace Pennylane::LightningTensor::TNCuda
- Namespace Pennylane::LightningTensor::TNCuda::Gates
- Template Class TNCudaGateCache
- Namespace Pennylane::LightningTensor::TNCuda::Measures
- Template Class MeasurementsTNCuda
- Namespace Pennylane::LightningTensor::TNCuda::Observables
- Template Class HamiltonianTNCuda
- Template Class HermitianObsTNCuda
- Template Class NamedObsTNCuda
- Template Class ObservableTNCuda
- Template Class ObservableTNCudaOperator
- Template Class TensorProdObsTNCuda
- Namespace Pennylane::LightningTensor::TNCuda::Util
- Struct TNCudaHandleDeleter
- Template Class ExactTNCuda
- Template Class MPOTNCuda
- Template Class MPSTNCuda
- Template Class TensorCuda
- Template Class TNCuda
- Template Class TNCudaBase
- Namespace Pennylane::LightningTensor::TNCuda::Gates
- Template Class TensorBase
- Namespace Pennylane::LightningTensor::TNCuda
- Namespace Pennylane::Measures
- Template Class MeasurementsBase
- Namespace Pennylane::Observables
- Template Class HamiltonianBase
- Template Class HermitianObsBase
- Template Class NamedObsBase
- Template Class Observable
- Template Class SparseHamiltonianBase
- Template Class TensorProdObsBase
- Namespace Pennylane::Util
- Namespace Pennylane::Util::MemoryStorageLocation
- Template Struct FuncReturn
- Template Struct FuncReturn< R(\*)(A...) >
- Template Struct FuncReturn< R(A...) >
- Template Struct getNth
- Struct PairHash
- Template Struct remove_complex
- Template Struct TypeNode
- Template Class AlignedAllocator
- Class BLASLibLoaderManager
- Class LightningException
- Class RuntimeInfo
- Class SharedLibLoader
- Template Class StateVectorBase
- Namespace Pennylane::Algorithms
- Template Struct ImagFactor
- Template Class TSQueue
- Namespace Catalyst
File Hierarchy¶
-
- Directory pennylane_lightning
- Directory core
- Directory src
- Directory algorithms
- File AdjointJacobianBase.hpp
- File JacobianData.hpp
- Directory bindings
- File Bindings.hpp
- File BindingsBase.hpp
- File BindingsCudaUtils.hpp
- File BindingsMPI.hpp
- Directory gates
- File Constant.hpp
- File GateOperation.hpp
- File Gates.hpp
- Directory measurements
- File MeasurementsBase.hpp
- Directory observables
- File Observables.hpp
- Directory simulators
- Directory base
- File StateVectorBase.hpp
- Directory lightning_gpu
- Directory algorithms
- Directory bindings
- File LGPUBindings.hpp
- File LGPUBindingsMPI.hpp
- Directory catalyst
- Directory gates
- File cuGateCache.hpp
- Directory measurements
- Directory observables
- File ObservablesGPU.hpp
- File ObservablesGPUMPI.hpp
- Directory utils
- File MPIWorker.hpp
- File StateVectorCudaBase.hpp
- File StateVectorCudaManaged.hpp
- File StateVectorCudaMPI.hpp
- Directory lightning_kokkos
- Directory algorithms
- Directory bindings
- File LKokkosBindings.hpp
- Directory catalyst
- Directory gates
- Directory measurements
- File ExpValFunctors.hpp
- File MeasurementsKokkos.hpp
- File MeasuresFunctors.hpp
- Directory observables
- Directory utils
- File StateVectorKokkos.hpp
- Directory lightning_qubit
- Directory algorithms
- Directory bindings
- File LQubitBindings.hpp
- Directory catalyst
- Directory gates
- Directory cpu_kernels
- Directory avx_common
- File ApplyCNOT.hpp
- File ApplyControlledPhaseShift.hpp
- File ApplyCRX.hpp
- File ApplyCRY.hpp
- File ApplyCRZ.hpp
- File ApplyCY.hpp
- File ApplyCZ.hpp
- File ApplyGeneratorIsingXX.hpp
- File ApplyGeneratorIsingYY.hpp
- File ApplyGeneratorIsingZZ.hpp
- File ApplyGeneratorPhaseShift.hpp
- File ApplyHadamard.hpp
- File ApplyIsingXX.hpp
- File ApplyIsingXY.hpp
- File ApplyIsingYY.hpp
- File ApplyIsingZZ.hpp
- File ApplyPauliX.hpp
- File ApplyPauliY.hpp
- File ApplyPauliZ.hpp
- File ApplyPhaseShift.hpp
- File ApplyRX.hpp
- File ApplyRY.hpp
- File ApplyRZ.hpp
- File ApplyS.hpp
- File ApplySingleQubitOp.hpp
- File ApplySWAP.hpp
- File ApplyT.hpp
- File AVX2Concept.hpp
- File AVX512Concept.hpp
- File AVXConceptType.hpp
- File AVXGateKernels.hpp
- File AVXUtil.hpp
- File Blender.hpp
- File Permutation.hpp
- File SingleQubitGateHelper.hpp
- File TwoQubitGateHelper.hpp
- File GateImplementationsAVX2.hpp
- File GateImplementationsAVX512.hpp
- File GateImplementationsAVXCommon.hpp
- File GateImplementationsLM.hpp
- File GatePragmas.hpp
- File PauliGenerator.hpp
- Directory avx_common
- Directory tests
- File TestConstant.hpp
- File AssignKernelMap_AVX2.hpp
- File AssignKernelMap_AVX512.hpp
- File AssignKernelMap_Default.hpp
- File DynamicDispatcher.hpp
- File GateIndices.hpp
- File KernelMap.hpp
- File KernelType.hpp
- File OpToMemberFuncPtr.hpp
- File RegisterKernel.hpp
- File RegisterKernels_x64.hpp
- Directory cpu_kernels
- Directory measurements
- File ExpValFunc.hpp
- File MeasurementKernels.hpp
- File MeasurementsLQubit.hpp
- File TransitionKernels.hpp
- Directory observables
- Directory utils
- File IntegerInterval.hpp
- File LinearAlgebra.hpp
- File SparseLinAlg.hpp
- File TestHelpersStateVectors.hpp
- File Threading.hpp
- File StateVectorLQubit.hpp
- File StateVectorLQubitManaged.hpp
- File StateVectorLQubitRaw.hpp
- Directory lightning_tensor
- Directory tensor
- Directory base
- File TensorBase.hpp
- Directory tncuda
- File TensorCuda.hpp
- Directory base
- Directory tncuda
- Directory base
- File TNCudaBase.hpp
- Directory bindings
- Directory gates
- File TNCudaGateCache.hpp
- Directory measurements
- Directory observables
- Directory utils
- File ExactTNCuda.hpp
- File MPOTNCuda.hpp
- File MPSTNCuda.hpp
- File TNCuda.hpp
- Directory base
- Directory utils
- Directory tncuda_utils
- File tncuda_helpers.hpp
- File tncudaError.hpp
- Directory tncuda_utils
- Directory tensor
- Directory base
- Directory utils
- Directory cuda_utils
- File CSRMatrix.hpp
- File cuda_helpers.hpp
- File cuError.hpp
- File cuGates_host.hpp
- File DataBuffer.hpp
- File DevicePool.hpp
- File DevTag.hpp
- File LinearAlg.hpp
- File MPILinearAlg.hpp
- File MPIManager.hpp
- File TSQueue.hpp
- File BitUtil.hpp
- File BLASLibLoaderManager.hpp
- File ConstantTestHelpers.hpp
- File ConstantUtil.hpp
- File CPUMemoryModel.hpp
- File Error.hpp
- File Macros.hpp
- File Memory.hpp
- File RuntimeInfo.hpp
- File SharedLibLoader.hpp
- File TestHelpers.hpp
- File TestHelpersSparse.hpp
- File TestHelpersWires.hpp
- File TestKernels.hpp
- File TypeList.hpp
- File TypeTraits.hpp
- File Util.hpp
- File UtilLinearAlg.hpp
- Directory cuda_utils
- Directory algorithms
- Directory src
- Directory core
- Directory pennylane_lightning
Full API¶
Namespaces¶
Classes and Structs¶
Functions¶
Variables¶
Defines¶
Typedefs¶
api/library_root
Download Python script
Download Notebook
View on GitHub