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 Pennylane
- Namespace Pennylane::Algorithms
- Template Class AdjointJacobianBase
- Template Class JacobianData
- Template Class OpsData
- Namespace Pennylane::Gates
- Enum GateOperation
- Enum GeneratorOperation
- Enum KernelType
- Enum MatrixOperation
- 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 cnotFunctor
- Template Struct controlledPhaseShiftFunctor
- Template Struct cRotFunctor
- Template Struct crxFunctor
- Template Struct cryFunctor
- Template Struct crzFunctor
- Template Struct cSWAPFunctor
- Template Struct cyFunctor
- Template Struct czFunctor
- Template Struct doubleExcitationFunctor
- Template Struct doubleExcitationMinusFunctor
- Template Struct doubleExcitationPlusFunctor
- Template Struct generatorControlledPhaseShiftFunctor
- Template Struct generatorCRXFunctor
- Template Struct generatorCRYFunctor
- Template Struct generatorCRZFunctor
- Template Struct generatorDoubleExcitationFunctor
- Template Struct generatorDoubleExcitationMinusFunctor
- Template Struct generatorDoubleExcitationPlusFunctor
- Template Struct generatorIsingXXFunctor
- Template Struct generatorIsingXYFunctor
- Template Struct generatorIsingYYFunctor
- Template Struct generatorIsingZZFunctor
- Template Struct generatorMultiRZFunctor
- Template Struct generatorPhaseShiftFunctor
- Template Struct generatorSingleExcitationFunctor
- Template Struct generatorSingleExcitationMinusFunctor
- Template Struct generatorSingleExcitationPlusFunctor
- Template Struct getExpectationValueHadamardFunctor
- Template Struct getExpectationValueIdentityFunctor
- 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 getProbFunctor
- Template Struct getTransposedFunctor
- Struct getTransposedIndexFunctor
- Template Struct hadamardFunctor
- Template Struct isingXXFunctor
- Template Struct isingXYFunctor
- Template Struct isingYYFunctor
- Template Struct isingZZFunctor
- Template Struct multiQubitOpFunctor
- Template Struct multiRZFunctor
- Template Struct pauliXFunctor
- Template Struct pauliYFunctor
- Template Struct pauliZFunctor
- Template Struct phaseShiftFunctor
- Template Struct rotFunctor
- Template Struct rxFunctor
- Template Struct ryFunctor
- Template Struct rzFunctor
- Template Struct Sampler
- Template Struct sFunctor
- Template Struct singleExcitationFunctor
- Template Struct singleExcitationMinusFunctor
- Template Struct singleExcitationPlusFunctor
- Template Struct swapFunctor
- Template Struct tFunctor
- Template Struct toffoliFunctor
- Namespace Pennylane::LightningKokkos::Measures
- Template Class Measurements
- Namespace Pennylane::LightningKokkos::Observables
- Template Class Hamiltonian
- Template Class HermitianObs
- Template Class NamedObs
- Template Class TensorProdObs
- Namespace Pennylane::LightningKokkos::Util
- Template Struct axpy_KokkosFunctor
- Template Struct getImagOfComplexInnerProductFunctor
- Template Struct getRealOfComplexInnerProductFunctor
- Template Struct SparseMV_KokkosFunctor
- Template Struct StateVectorToName
- Template Struct StateVectorToName< StateVectorKokkos< double > >
- Template Struct StateVectorToName< StateVectorKokkos< float > >
- 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
- Namespace Pennylane::LightningQubit::Gates::AVXCommon::Permutation
- Template Struct CompiledPermutation
- Template Struct CompiledPermutation< double, 4 >
- Template Struct CompiledPermutation< double, 8 >
- Template Struct CompiledPermutation< float, 16 >
- Template Struct CompiledPermutation< float, 8 >
- 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 Struct AVXConcept
- Template Struct AVXIntrinsic
- Template Struct CompileMask
- Template Struct CompileMask< double, 4 >
- Template Struct CompileMask< double, 8 >
- Template Struct CompileMask< float, 16 >
- Template Struct CompileMask< float, 8 >
- Template Struct ImagFactor
- Template Struct InternalWires
- Template Struct Set1
- Template Class SingleQubitGateWithoutParamHelper
- Template Class SingleQubitGateWithParamHelper
- Template Class TwoQubitGateWithoutParamHelper
- Template Class TwoQubitGateWithParamHelper
- Namespace Pennylane::LightningQubit::Gates::AVXCommon::Permutation
- Struct GateIndices
- Template Struct GateOpToMemberFuncPtr
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::CNOT >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::ControlledPhaseShift >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::CRot >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::CRX >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::CRY >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::CRZ >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::CSWAP >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::CY >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::CZ >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::DoubleExcitation >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::DoubleExcitationMinus >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::DoubleExcitationPlus >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::Hadamard >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::Identity >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::IsingXX >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::IsingXY >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::IsingYY >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::IsingZZ >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::MultiRZ >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::PauliX >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::PauliY >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::PauliZ >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::PhaseShift >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::Rot >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::RX >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::RY >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::RZ >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::S >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::SingleExcitation >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::SingleExcitationMinus >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::SingleExcitationPlus >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::SWAP >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::T >
- Template Struct GateOpToMemberFuncPtr< PrecisionT, ParamT, GateImplementation, GateOperation::Toffoli >
- Template Struct GeneratorOpToMemberFuncPtr
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::ControlledPhaseShift >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::CRX >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::CRY >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::CRZ >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::DoubleExcitation >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::DoubleExcitationMinus >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::DoubleExcitationPlus >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::IsingXX >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::IsingXY >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::IsingYY >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::IsingZZ >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::MultiRZ >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::PhaseShift >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::RX >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::RY >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::RZ >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::SingleExcitation >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::SingleExcitationMinus >
- Template Struct GeneratorOpToMemberFuncPtr< PrecisionT, GateImplementation, GeneratorOperation::SingleExcitationPlus >
- Template Struct MatrixOpToMemberFuncPtr
- Template Struct MatrixOpToMemberFuncPtr< PrecisionT, GateImplementation, MatrixOperation::MultiQubitOp >
- Template Struct MatrixOpToMemberFuncPtr< PrecisionT, GateImplementation, MatrixOperation::SingleQubitOp >
- Template Struct MatrixOpToMemberFuncPtr< PrecisionT, GateImplementation, MatrixOperation::TwoQubitOp >
- Class GateImplementationsAVX2
- Class GateImplementationsAVX512
- Template Class GateImplementationsAVXCommon
- Class GateImplementationsLM
- Class GateImplementationsPI
- Template Class PauliGenerator
- Namespace Pennylane::LightningQubit::Gates::AVXCommon
- Namespace Pennylane::LightningQubit::KernelMap
- Struct AllMemoryModel
- Struct AllThreading
- Template Class OperationKernelMap
- Namespace Pennylane::LightningQubit::Measures
- Template Class LocalTransitionKernel
- Template Class Measurements
- Template Class NonZeroRandomTransitionKernel
- Template Class TransitionKernel
- Enum TransitionKernelType
- Namespace Pennylane::LightningQubit::Observables
- Template Class Hamiltonian
- Template Class HermitianObs
- Template Class NamedObs
- Template Class TensorProdObs
- Namespace Pennylane::LightningQubit::Util
- Template Struct StateVectorToName
- Template Struct StateVectorToName< StateVectorLQubitManaged< double > >
- Template Struct StateVectorToName< StateVectorLQubitManaged< float > >
- Template Struct StateVectorToName< StateVectorLQubitRaw< double > >
- Template Struct StateVectorToName< StateVectorLQubitRaw< float > >
- Template Class IntegerInterval
- Enum Threading
- Enum Trans
- Template Class DynamicDispatcher
- Template Class StateVectorLQubit
- Template Class StateVectorLQubitManaged
- Template Class StateVectorLQubitRaw
- Namespace Pennylane::LightningQubit::Algorithms
- Namespace Pennylane::Measures
- Template Class MeasurementsBase
- Namespace Pennylane::Observables
- Template Class HamiltonianBase
- Template Class HermitianObsBase
- Template Class NamedObsBase
- Template Class Observable
- Template Class TensorProdObsBase
- Namespace Pennylane::Util
- Namespace Pennylane::Util::MemoryStorageLocation
- Enum Compiler
- Enum CPUArch
- Enum CPUMemoryModel
- Enum OperatingSystem
- Template Struct FuncReturn
- Template Struct FuncReturn< R(\*)(A...) >
- Template Struct FuncReturn< R(A...) >
- Template Struct getNth
- Template Struct is_complex
- Struct PairHash
- Template Struct PLApprox
- Template Struct PLApproxComplex
- Template Struct PrecisionToName
- Template Struct PrecisionToName< double >
- Template Struct PrecisionToName< float >
- Template Struct remove_complex
- Template Struct TypeNode
- Template Class AlignedAllocator
- Class CombinationGenerator
- Class LightningException
- Class PermutationGenerator
- Class RuntimeInfo
- Class WiresGenerator
- Template Class StateVectorBase
- Namespace Pennylane::Algorithms
- Namespace Pennylane
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
- 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_kokkos
- Directory algorithms
- Directory bindings
- File LKokkosBindings.hpp
- 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 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 GateImplementationsPI.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
- 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 base
- Directory utils
- File BitUtil.hpp
- File ConstantTestHelpers.hpp
- File ConstantUtil.hpp
- File CPUMemoryModel.hpp
- File Error.hpp
- File Macros.hpp
- File Memory.hpp
- File RuntimeInfo.hpp
- File TestHelpers.hpp
- File TestHelpersWires.hpp
- File TestKernels.hpp
- File TypeList.hpp
- File TypeTraits.hpp
- File Util.hpp
- Directory algorithms
- Directory src
- Directory core
- Directory pennylane_lightning
api/library_root
Download Python script
Download Notebook
View on GitHub