diff --git a/docs/api/qiskit/0.19/_toc.json b/docs/api/qiskit/0.19/_toc.json index 2f769d01043..90c0618faca 100644 --- a/docs/api/qiskit/0.19/_toc.json +++ b/docs/api/qiskit/0.19/_toc.json @@ -1141,30 +1141,6 @@ "title": "Overview", "url": "/api/qiskit/0.19/circuit" }, - { - "title": "AND", - "url": "/api/qiskit/0.19/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.19/qiskit.circuit.library.Barrier" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.CCXGate" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.19/qiskit.circuit.ClassicalRegister" @@ -1177,98 +1153,14 @@ "title": "ControlledGate", "url": "/api/qiskit/0.19/qiskit.circuit.ControlledGate" }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.CSwapGate" - }, - { - "title": "CU1Gate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.CU1Gate" - }, - { - "title": "CU3Gate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.CU3Gate" - }, - { - "title": "CXGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.CXGate" - }, - { - "title": "CYGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.CYGate" - }, - { - "title": "CZGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.CZGate" - }, - { - "title": "DCXGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.DCXGate" - }, - { - "title": "Diagonal", - "url": "/api/qiskit/0.19/qiskit.circuit.library.Diagonal" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2" - }, { "title": "EquivalenceLibrary", "url": "/api/qiskit/0.19/qiskit.circuit.EquivalenceLibrary" }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.19/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations" - }, { "title": "Gate", "url": "/api/qiskit/0.19/qiskit.circuit.Gate" }, - { - "title": "GMS", - "url": "/api/qiskit/0.19/qiskit.circuit.library.GMS" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.19/qiskit.circuit.library.GraphState" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.19/qiskit.circuit.library.InnerProduct" - }, { "title": "Instruction", "url": "/api/qiskit/0.19/qiskit.circuit.Instruction" @@ -1277,50 +1169,10 @@ "title": "InstructionSet", "url": "/api/qiskit/0.19/qiskit.circuit.InstructionSet" }, - { - "title": "IntegerComparator", - "url": "/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.19/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations" - }, - { - "title": "MCMT", - "url": "/api/qiskit/0.19/qiskit.circuit.library.MCMT" - }, - { - "title": "MCMTVChain", - "url": "/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain" - }, { "title": "Measure", "url": "/api/qiskit/0.19/qiskit.circuit.Measure" }, - { - "title": "Measure", - "url": "/api/qiskit/0.19/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.19/qiskit.circuit.library.NLocal" - }, - { - "title": "OR", - "url": "/api/qiskit/0.19/qiskit.circuit.library.OR" - }, { "title": "Parameter", "url": "/api/qiskit/0.19/qiskit.circuit.Parameter" @@ -1333,26 +1185,6 @@ "title": "ParameterVector", "url": "/api/qiskit/0.19/qiskit.circuit.ParameterVector" }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.19/qiskit.circuit.library.Permutation" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.19/qiskit.circuit.library.QFT" - }, { "title": "QuantumCircuit", "url": "/api/qiskit/0.19/qiskit.circuit.QuantumCircuit" @@ -1361,10 +1193,6 @@ "title": "QuantumRegister", "url": "/api/qiskit/0.19/qiskit.circuit.QuantumRegister" }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume" - }, { "title": "Qubit", "url": "/api/qiskit/0.19/qiskit.circuit.Qubit" @@ -1373,117 +1201,298 @@ "title": "random_circuit", "url": "/api/qiskit/0.19/qiskit.circuit.random.random_circuit" }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes" - }, { "title": "Reset", "url": "/api/qiskit/0.19/qiskit.circuit.Reset" }, { - "title": "Reset", - "url": "/api/qiskit/0.19/qiskit.circuit.library.Reset" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.RZGate" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.SGate" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.SwapGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.TdgGate" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.19/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.U3Gate" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.19/qiskit.circuit.library.XOR" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.19/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap" + "title": "qiskit.circuit.library", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.19/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.19/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.19/qiskit.circuit.library.Barrier" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.CCXGate" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.CHGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.19/qiskit.circuit.library.Diagonal" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.19/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.19/qiskit.circuit.library.GMS" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.19/qiskit.circuit.library.GraphState" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.19/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.19/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.19/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.19/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.19/qiskit.circuit.library.NLocal" + }, + { + "title": "OR", + "url": "/api/qiskit/0.19/qiskit.circuit.library.OR" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.19/qiskit.circuit.library.Permutation" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.19/qiskit.circuit.library.QFT" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.19/qiskit.circuit.library.Reset" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.RZGate" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.SGate" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.SwapGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.TdgGate" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.19/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.U2Gate" + }, + { + "title": "U3Gate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.U3Gate" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.19/qiskit.circuit.library.XOR" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.19/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap" + } + ] } ] }, @@ -1613,11 +1622,11 @@ "url": "/api/qiskit/0.19/qiskit.finance.applications.ising" }, { - "title": "get_operator", + "title": "qiskit.finance.applications.ising.portfolio", "url": "/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio" }, { - "title": "get_operator", + "title": "qiskit.finance.applications.ising.portfolio_diversification", "url": "/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio_diversification" } ] @@ -1999,6 +2008,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.19/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.19/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.19/qiskit.ignis.verification.QOTP" @@ -2160,52 +2173,52 @@ "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising" }, { - "title": "check_disjoint", - "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing" + "title": "qiskit.optimization.applications.ising.clique", + "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.clique" }, { - "title": "check_full_edge_coverage", - "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover" + "title": "qiskit.optimization.applications.ising.docplex", + "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex" }, { - "title": "check_solution_satisfiability", + "title": "qiskit.optimization.applications.ising.exact_cover", "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.exact_cover" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.clique" + "title": "qiskit.optimization.applications.ising.graph_partition", + "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition" + "title": "qiskit.optimization.applications.ising.knapsack", + "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack" }, { - "title": "get_graph_solution", + "title": "qiskit.optimization.applications.ising.max_cut", "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.max_cut" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set" + "title": "qiskit.optimization.applications.ising.partition", + "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.partition" }, { - "title": "get_operator", - "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex" + "title": "qiskit.optimization.applications.ising.set_packing", + "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing" }, { - "title": "get_operator", - "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack" + "title": "qiskit.optimization.applications.ising.stable_set", + "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set" }, { - "title": "get_operator", - "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.partition" + "title": "qiskit.optimization.applications.ising.tsp", + "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp" }, { - "title": "get_operator", + "title": "qiskit.optimization.applications.ising.vehicle_routing", "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.vehicle_routing" }, { - "title": "TspData", - "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp" + "title": "qiskit.optimization.applications.ising.vertex_cover", + "url": "/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover" } ] } @@ -2855,18 +2868,10 @@ "title": "Acquire", "url": "/api/qiskit/0.19/qiskit.pulse.Acquire" }, - { - "title": "Acquire", - "url": "/api/qiskit/0.19/qiskit.pulse.instructions.Acquire" - }, { "title": "AcquireChannel", "url": "/api/qiskit/0.19/qiskit.pulse.AcquireChannel" }, - { - "title": "AcquireChannel", - "url": "/api/qiskit/0.19/qiskit.pulse.channels" - }, { "title": "add_implicit_acquires", "url": "/api/qiskit/0.19/qiskit.pulse.reschedule.add_implicit_acquires" @@ -2879,14 +2884,6 @@ "title": "Constant", "url": "/api/qiskit/0.19/qiskit.pulse.Constant" }, - { - "title": "Constant", - "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant" - }, - { - "title": "constant", - "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.discrete" - }, { "title": "ControlChannel", "url": "/api/qiskit/0.19/qiskit.pulse.ControlChannel" @@ -2895,18 +2892,10 @@ "title": "Delay", "url": "/api/qiskit/0.19/qiskit.pulse.Delay" }, - { - "title": "Delay", - "url": "/api/qiskit/0.19/qiskit.pulse.instructions.Delay" - }, { "title": "Drag", "url": "/api/qiskit/0.19/qiskit.pulse.Drag" }, - { - "title": "Drag", - "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag" - }, { "title": "DriveChannel", "url": "/api/qiskit/0.19/qiskit.pulse.DriveChannel" @@ -2915,26 +2904,14 @@ "title": "Gaussian", "url": "/api/qiskit/0.19/qiskit.pulse.Gaussian" }, - { - "title": "Gaussian", - "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian" - }, { "title": "GaussianSquare", "url": "/api/qiskit/0.19/qiskit.pulse.GaussianSquare" }, - { - "title": "GaussianSquare", - "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare" - }, { "title": "Instruction", "url": "/api/qiskit/0.19/qiskit.pulse.Instruction" }, - { - "title": "Instruction", - "url": "/api/qiskit/0.19/qiskit.pulse.instructions.Instruction" - }, { "title": "InstructionScheduleMap", "url": "/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap" @@ -2955,14 +2932,14 @@ "title": "Play", "url": "/api/qiskit/0.19/qiskit.pulse.Play" }, - { - "title": "Play", - "url": "/api/qiskit/0.19/qiskit.pulse.instructions.Play" - }, { "title": "PulseError", "url": "/api/qiskit/0.19/qiskit.pulse.PulseError" }, + { + "title": "qiskit.pulse.channels", + "url": "/api/qiskit/0.19/qiskit.pulse.channels" + }, { "title": "RegisterSlot", "url": "/api/qiskit/0.19/qiskit.pulse.RegisterSlot" @@ -2971,10 +2948,6 @@ "title": "SamplePulse", "url": "/api/qiskit/0.19/qiskit.pulse.SamplePulse" }, - { - "title": "SamplePulse", - "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse" - }, { "title": "Schedule", "url": "/api/qiskit/0.19/qiskit.pulse.Schedule" @@ -2983,25 +2956,83 @@ "title": "SetFrequency", "url": "/api/qiskit/0.19/qiskit.pulse.SetFrequency" }, - { - "title": "SetFrequency", - "url": "/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency" - }, { "title": "ShiftPhase", "url": "/api/qiskit/0.19/qiskit.pulse.ShiftPhase" }, - { - "title": "ShiftPhase", - "url": "/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase" - }, { "title": "Snapshot", "url": "/api/qiskit/0.19/qiskit.pulse.Snapshot" }, { - "title": "Snapshot", - "url": "/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot" + "title": "qiskit.pulse.instructions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.19/qiskit.pulse.instructions" + }, + { + "title": "Acquire", + "url": "/api/qiskit/0.19/qiskit.pulse.instructions.Acquire" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.19/qiskit.pulse.instructions.Delay" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.19/qiskit.pulse.instructions.Instruction" + }, + { + "title": "Play", + "url": "/api/qiskit/0.19/qiskit.pulse.instructions.Play" + }, + { + "title": "SetFrequency", + "url": "/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency" + }, + { + "title": "ShiftPhase", + "url": "/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot" + } + ] + }, + { + "title": "qiskit.pulse.pulse_lib", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib" + }, + { + "title": "Constant", + "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant" + }, + { + "title": "Drag", + "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag" + }, + { + "title": "Gaussian", + "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian" + }, + { + "title": "GaussianSquare", + "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare" + }, + { + "title": "qiskit.pulse.pulse_lib.discrete", + "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.discrete" + }, + { + "title": "SamplePulse", + "url": "/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse" + } + ] } ] }, @@ -3313,11 +3344,11 @@ "url": "/api/qiskit/0.19/scheduler" }, { - "title": "CircuitPulseDef", + "title": "qiskit.scheduler.methods.basic", "url": "/api/qiskit/0.19/qiskit.scheduler.methods.basic" }, { - "title": "format_meas_map", + "title": "qiskit.scheduler.utils", "url": "/api/qiskit/0.19/qiskit.scheduler.utils" }, { @@ -3690,10 +3721,6 @@ "title": "circuit_drawer", "url": "/api/qiskit/0.19/qiskit.visualization.circuit_drawer" }, - { - "title": "cubic_spline", - "url": "/api/qiskit/0.19/qiskit.visualization.pulse.interpolation" - }, { "title": "dag_drawer", "url": "/api/qiskit/0.19/qiskit.visualization.dag_drawer" @@ -3771,7 +3798,11 @@ "url": "/api/qiskit/0.19/qiskit.visualization.pulse_drawer" }, { - "title": "PulseStyle", + "title": "qiskit.visualization.pulse.interpolation", + "url": "/api/qiskit/0.19/qiskit.visualization.pulse.interpolation" + }, + { + "title": "qiskit.visualization.pulse.qcstyle", "url": "/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle" }, { diff --git a/docs/api/qiskit/0.19/circuit_library.md b/docs/api/qiskit/0.19/circuit_library.md index c5b6c2754de..ecd2ddc378d 100644 --- a/docs/api/qiskit/0.19/circuit_library.md +++ b/docs/api/qiskit/0.19/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -125,3 +137,4 @@ | [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap")(\[feature\_dimension, reps, …]) | The Pauli Expansion circuit. | | [`ZFeatureMap`](qiskit.circuit.library.ZFeatureMap "qiskit.circuit.library.ZFeatureMap")(feature\_dimension\[, reps, …]) | The first order Pauli Z-evolution circuit. | | [`ZZFeatureMap`](qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap")(feature\_dimension\[, reps, …]) | Second-order Pauli-Z evolution circuit. | + diff --git a/docs/api/qiskit/0.19/pulse.md b/docs/api/qiskit/0.19/pulse.md index 15c5df3511b..0dd399476f3 100644 --- a/docs/api/qiskit/0.19/pulse.md +++ b/docs/api/qiskit/0.19/pulse.md @@ -32,15 +32,15 @@ This is sufficient to allow the quantum physicist to explore and correct for noi `instructions` -| | | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | -| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration\[, channel, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration\[, channel, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase\[, channel, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | -| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | +| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration\[, channel, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration\[, channel, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase\[, channel, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). | +| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Pulse Library (waveforms ) diff --git a/docs/api/qiskit/0.19/qiskit.compiler.assemble.md b/docs/api/qiskit/0.19/qiskit.compiler.assemble.md index 9785ca697ce..081fcb5a243 100644 --- a/docs/api/qiskit/0.19/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.19/qiskit.compiler.assemble.md @@ -42,7 +42,7 @@ This function serializes the payloads, which could be either circuits or schedul * **meas\_lo\_range** (`Optional`\[`List`\[`int`]]) – List of measurement LO ranges each of form `[range_min, range_max]` in Hz. Used to validate the supplied qubit frequencies. -* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. +* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. * **meas\_level** (`Union`\[`int`, `MeasLevel`]) – Set the appropriate level of the measurement output for pulse experiments. diff --git a/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio.md index 24fd053c0e0..90895399d75 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.finance.applications.ising.portfolio.get_operator +title: portfolio +description: API reference for qiskit.finance.applications.ising.portfolio in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.finance.applications.ising.portfolio.get_operator +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio --- diff --git a/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio_diversification.md index 4a986b137de..f0af6db4a1f 100644 --- a/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio_diversification.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.finance.applications.ising.portfolio_diversification.get_operator +title: portfolio_diversification +description: API reference for qiskit.finance.applications.ising.portfolio_diversification in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.finance.applications.ising.portfolio_diversification.get_operator +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio_diversification --- diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.basis.md index c94f44626bd..1383fe15ac1 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.basis.md @@ -1,3 +1,12 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.clique.md index 4ef06dbe486..2c9227815b9 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.clique.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.clique.get_graph_solution +title: clique +description: API reference for qiskit.optimization.applications.ising.clique in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.clique.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.clique --- diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex.md index f920405f32f..0acb1ab34d6 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.docplex.get_operator +title: docplex +description: API reference for qiskit.optimization.applications.ising.docplex in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.docplex.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.docplex --- diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.exact_cover.md index 6a95aff51d0..dc131e826b9 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.exact_cover.md @@ -1,9 +1,9 @@ --- -title: check_solution_satisfiability -description: API reference for qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability +title: exact_cover +description: API reference for qiskit.optimization.applications.ising.exact_cover in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.exact_cover --- diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition.md index 90b05bae163..980db3fef27 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.graph_partition.get_graph_solution +title: graph_partition +description: API reference for qiskit.optimization.applications.ising.graph_partition in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.graph_partition.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.graph_partition --- @@ -50,11 +50,11 @@ Generate Hamiltonian for the graph partitioning **Notes** -## Goals: +**Goals:** 1 separate the vertices into two set of the same size 2 make sure the number of edges between the two set is minimized. -## Hamiltonian: +**Hamiltonian:** H = H\_A + H\_B H\_A = sum\_\{(i,j)in E}\{(1-ZiZj)/2} H\_B = (sum\_\{i}\{Zi})^2 = sum\_\{i}\{Zi^2}+sum\_\{i!=j}\{ZiZj} H\_A is for achieving goal 2 and H\_B is for achieving goal 1. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack.md index cdbc16451ca..6d5bb8e85cd 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.knapsack.get_operator +title: knapsack +description: API reference for qiskit.optimization.applications.ising.knapsack in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.knapsack.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.knapsack --- diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.max_cut.md index 946ed2cf90c..adc7dbd2c9a 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.max_cut.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.max_cut.get_graph_solution +title: max_cut +description: API reference for qiskit.optimization.applications.ising.max_cut in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.max_cut.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.max_cut --- diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.partition.md index 4ad8a09fc7d..19c079eda25 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.partition.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.partition.get_operator +title: partition +description: API reference for qiskit.optimization.applications.ising.partition in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.partition.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.partition --- diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing.md index 0fddf60cdbf..e9b2773d715 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing.md @@ -1,9 +1,9 @@ --- -title: check_disjoint -description: API reference for qiskit.optimization.applications.ising.set_packing.check_disjoint +title: set_packing +description: API reference for qiskit.optimization.applications.ising.set_packing in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.set_packing.check_disjoint +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.set_packing --- diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set.md index 832e3c78b5c..edaa6bec1df 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.stable_set.get_graph_solution +title: stable_set +description: API reference for qiskit.optimization.applications.ising.stable_set in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.stable_set.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.stable_set --- diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.md index dc4cf17c014..e020c7cb35b 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.md @@ -1,9 +1,9 @@ --- -title: TspData -description: API reference for qiskit.optimization.applications.ising.tsp.TspData +title: tsp +description: API reference for qiskit.optimization.applications.ising.tsp in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.optimization.applications.ising.tsp.TspData +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.tsp --- diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vehicle_routing.md index e8cb5e89665..026be751fcd 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vehicle_routing.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.vehicle_routing.get_operator +title: vehicle_routing +description: API reference for qiskit.optimization.applications.ising.vehicle_routing in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.vehicle_routing.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vehicle_routing --- @@ -72,7 +72,7 @@ float `get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") -## Constructs auxiliary matrices from a vehicle routing instance, +**Constructs auxiliary matrices from a vehicle routing instance,** which represent the encoding into a binary quadratic program. This is used in the construction of the qubit ops and computation of the solution cost. @@ -96,7 +96,7 @@ tuple(numpy.ndarray, numpy.ndarray, float) `get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") -## Tries to obtain a feasible solution (in vector form) of an instance +**Tries to obtain a feasible solution (in vector form) of an instance** of vehicle routing from the results dictionary. @@ -115,7 +115,7 @@ a solution, i.e., a path, in its binary representation. numpy.ndarray -## #TODO: support statevector simulation, results should be a statevector or counts format, not +**#TODO: support statevector simulation, results should be a statevector or counts format, not** a result from algorithm run diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover.md index 5a3ad277739..c9f9c52fafa 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover.md @@ -1,9 +1,9 @@ --- -title: check_full_edge_coverage -description: API reference for qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage +title: vertex_cover +description: API reference for qiskit.optimization.applications.ising.vertex_cover in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vertex_cover --- diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.md index e5adc02a90c..1cca7a4cc3b 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.md @@ -94,7 +94,7 @@ Return the acquisition channel for the given qubit. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") **Returns** @@ -119,7 +119,7 @@ Return the secondary drive channel for the given qubit – typically utilized fo **Return type** -`List`\[[`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")] +`List`\[[`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")] **Returns** @@ -149,7 +149,7 @@ backend.configuration().describe(ControlChannel(1)) **Parameters** -**channel** ([`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe. +**channel** ([`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe. **Raises** @@ -157,7 +157,7 @@ backend.configuration().describe(ControlChannel(1)) **Return type** -`Dict`\[[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel"), `complex`] +`Dict`\[[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel"), `complex`] **Returns** @@ -177,7 +177,7 @@ Return the drive channel for the given qubit. **Return type** -[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") +[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel") **Returns** @@ -237,7 +237,7 @@ Return a list of channels which operate on the given `qubit`. **Return type** -`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] **Returns** @@ -257,7 +257,7 @@ Return the measure stimulus channel for the given qubit. **Return type** -[`MeasureChannel`](qiskit.pulse.channels#qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") +[`MeasureChannel`](qiskit.pulse.channels#measurechannel "qiskit.pulse.channels.MeasureChannel") **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.19/qiskit.pulse.Acquire.md index 60cd0532afc..de0d6c8bb62 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Acquire.md @@ -25,11 +25,11 @@ Create a new Acquire instruction. **Parameters** * **duration** (`int`) – Length of time to acquire data in terms of dt. -* **channel** (`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), `List`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")], `None`]) – The channel that will acquire data. -* **mem\_slot** (`Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), `List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")], `None`]) – The classical memory slot in which to store the classified readout result. -* **mem\_slots** (`Optional`\[`List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]]) – Deprecated list form of `mem_slot`. -* **reg\_slots** (`Union`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot"), `List`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")], `None`]) – Deprecated list form of `reg_slot`. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** (`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), `List`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")], `None`]) – The channel that will acquire data. +* **mem\_slot** (`Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), `List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")], `None`]) – The classical memory slot in which to store the classified readout result. +* **mem\_slots** (`Optional`\[`List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]]) – Deprecated list form of `mem_slot`. +* **reg\_slots** (`Union`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot"), `List`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")], `None`]) – Deprecated list form of `reg_slot`. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -50,7 +50,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### acquires @@ -62,7 +62,7 @@ Acquire channels to be acquired on. **Return type** -`List`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")] +`List`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")] ### channel @@ -70,11 +70,11 @@ Acquire channels to be acquired on. `qiskit.pulse.channels.AcquireChannel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### channels @@ -86,7 +86,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -170,7 +170,7 @@ The classical memory slot which will store the classified readout result. **Return type** -[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot") +[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot") ### mem\_slots @@ -182,7 +182,7 @@ MemorySlots. **Return type** -`List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")] +`List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")] ### name @@ -218,7 +218,7 @@ The fast-access register slot which will store the classified readout result for **Return type** -[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot") +[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot") ### reg\_slots @@ -230,7 +230,7 @@ RegisterSlots. **Return type** -`List`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")] +`List`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")] ### start\_time @@ -266,7 +266,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -280,11 +280,11 @@ Return new `Acquire` that is fully instantiated with its channels. **Parameters** -* **channel** (`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), `List`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")], `None`]) – The channel that will acquire data. -* **mem\_slot** (`Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), `List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")], `None`]) – The classical memory slot in which to store the classified readout result. -* **mem\_slots** (`Optional`\[`List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]]) – Deprecated list form of `mem_slot`. -* **reg\_slots** (`Union`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot"), `List`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")], `None`]) – Deprecated list form of `reg_slot`. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** (`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), `List`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")], `None`]) – The channel that will acquire data. +* **mem\_slot** (`Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), `List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")], `None`]) – The classical memory slot in which to store the classified readout result. +* **mem\_slots** (`Optional`\[`List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]]) – Deprecated list form of `mem_slot`. +* **reg\_slots** (`Union`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot"), `List`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")], `None`]) – Deprecated list form of `reg_slot`. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -377,11 +377,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -389,7 +389,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Constant.md b/docs/api/qiskit/0.19/qiskit.pulse.Constant.md index e5e607de2c8..05da91991d5 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Constant.md @@ -86,7 +86,7 @@ Plot the pulse. **Parameters** * **dt** (`float`) – Time interval of samples. -* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.PulseStyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#pulsestyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Delay.md b/docs/api/qiskit/0.19/qiskit.pulse.Delay.md index 8f6d046a8d1..ffd843973a9 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Delay.md @@ -33,7 +33,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`int`) – Length of time of the delay in terms of dt. -* **channel** (`Optional`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]) – The channel that will have the delay. +* **channel** (`Optional`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ## Attributes @@ -44,11 +44,11 @@ No other instruction may be scheduled within a `Delay`. `qiskit.pulse.channels.Channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") ### channels @@ -60,7 +60,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -168,7 +168,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -182,7 +182,7 @@ Return new `Delay` that is fully instantiated with both `duration` and a `channe **Parameters** -**channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +**channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. **Return type** @@ -272,11 +272,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -284,7 +284,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Drag.md b/docs/api/qiskit/0.19/qiskit.pulse.Drag.md index 5d19c0a8915..41589cfd07f 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Drag.md @@ -124,7 +124,7 @@ Plot the pulse. **Parameters** * **dt** (`float`) – Time interval of samples. -* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.PulseStyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#pulsestyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.md index a335a9d78ae..d7b575df79f 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.md @@ -98,7 +98,7 @@ Plot the pulse. **Parameters** * **dt** (`float`) – Time interval of samples. -* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.PulseStyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#pulsestyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes diff --git a/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.md index 4dda8221980..e00bbfeff56 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.md @@ -111,7 +111,7 @@ Plot the pulse. **Parameters** * **dt** (`float`) – Time interval of samples. -* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.PulseStyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#pulsestyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.19/qiskit.pulse.Instruction.md index 95b1cc89b6b..b0ca2445f4a 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Instruction.md @@ -20,7 +20,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Union`\[`Command`, `int`]) – Length of time taken by the instruction in terms of dt. Deprecated: the first argument used to be the Command. -* **channels** (`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]) – Tuple of pulse channels that this instruction operates on. +* **channels** (`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]) – Tuple of pulse channels that this instruction operates on. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -39,7 +39,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -147,7 +147,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -227,11 +227,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -239,7 +239,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Play.md b/docs/api/qiskit/0.19/qiskit.pulse.Play.md index 2ea24cea63e..a467f1ff48b 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Play.md @@ -21,7 +21,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`SamplePulse`](qiskit.pulse.pulse_lib.SamplePulse "qiskit.pulse.pulse_lib.SamplePulse"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -36,11 +36,11 @@ Create a new pulse instruction. `qiskit.pulse.channels.PulseChannel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -52,7 +52,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -172,7 +172,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -252,11 +252,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -264,7 +264,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.md b/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.md index ec74b91e1f1..396563cfe0b 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.md @@ -69,7 +69,7 @@ Plot the interpolated envelope of pulse. **Parameters** * **dt** (`float`) – Time interval of samples. -* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.PulseStyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance. +* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#pulsestyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance. * **filename** (`Optional`\[`str`]) – Name required to save pulse image. * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation. * **scale** (`float`) – Relative visual scaling of waveform amplitudes. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.19/qiskit.pulse.Schedule.md index 5e9acd9a7fb..7ad154c2b11 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Schedule.md @@ -33,7 +33,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### duration @@ -113,7 +113,7 @@ Time keeping attribute. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -198,12 +198,12 @@ Plot the schedule. **Parameters** * **dt** (`float`) – Time interval of samples. -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance. +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance. * **filename** (`Optional`\[`str`]) – Name required to save pulse image. * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation. * **scale** (`Optional`\[`float`]) – Relative visual scaling of waveform amplitudes, see Additional Information. -* **channel\_scales** (`Optional`\[`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `float`]]) – Channel independent scaling as a dictionary of `Channel` object. -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see `channels`. +* **channel\_scales** (`Optional`\[`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `float`]]) – Channel independent scaling as a dictionary of `Channel` object. +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see `channels`. * **plot\_all** (`bool`) – Plot empty channels. * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot. * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this). @@ -211,7 +211,7 @@ Plot the schedule. * **label** (`bool`) – Label individual instructions. * **framechange** (`bool`) – Add framechange indicators. * **scaling** (`Optional`\[`float`]) – Deprecated, see `scale`. -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot. +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot. * **show\_framechange\_channels** (`bool`) – Plot channels with only framechanges. #### Additional Information: @@ -248,7 +248,7 @@ self.filter(args) | self.exclude(args) == self **Parameters** * **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, ScheduleComponent) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (*Optional\[Iterable\[Type\[*[*qiskit.pulse.Instruction*](qiskit.pulse.Instruction "qiskit.pulse.Instruction")*]]]*) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -270,7 +270,7 @@ If no arguments are provided, `self` is returned. **Parameters** * **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, ScheduleComponent) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (*Optional\[Iterable\[Type\[*[*qiskit.pulse.Instruction*](qiskit.pulse.Instruction "qiskit.pulse.Instruction")*]]]*) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.md index 162bb51a078..65c0c8d627f 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.md @@ -27,7 +27,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`float`) – New frequency of the channel in Hz. -* **channel** (`Optional`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")]) – The channel this instruction operates on. +* **channel** (`Optional`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")]) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency command. ## Attributes @@ -38,11 +38,11 @@ Creates a new set channel frequency instruction. `qiskit.pulse.channels.PulseChannel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -54,7 +54,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -174,7 +174,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -254,11 +254,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -266,7 +266,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.md index e520635d887..b557ccfc886 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.ShiftPhase `ShiftPhase(phase, channel=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/phase.py "view source code") -The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. +The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -29,7 +29,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`complex`) – The rotation angle in radians. -* **channel** (`Optional`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")]) – The channel this instruction operates on. +* **channel** (`Optional`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")]) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Attributes @@ -40,11 +40,11 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch `qiskit.pulse.channels.PulseChannel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -56,7 +56,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -176,7 +176,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -190,7 +190,7 @@ Return a new ShiftPhase instruction supporting the deprecated syntax of FrameCha **Parameters** -**channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +**channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. **Raises** @@ -280,11 +280,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -292,7 +292,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.md index 1c4df88e682..0a31da5de0b 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.md @@ -30,11 +30,11 @@ Create new snapshot. `qiskit.pulse.channels.SnapshotChannel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** -[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel") +[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel") ### channels @@ -46,7 +46,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -166,7 +166,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ### type @@ -266,11 +266,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -278,7 +278,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.channels.md b/docs/api/qiskit/0.19/qiskit.pulse.channels.md index 995a1261c3b..ed9a2cf322e 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.channels.md @@ -1,9 +1,9 @@ --- -title: AcquireChannel -description: API reference for qiskit.pulse.channels.AcquireChannel +title: channels +description: API reference for qiskit.pulse.channels in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.pulse.channels.AcquireChannel +python_api_type: module +python_api_name: qiskit.pulse.channels --- # channels diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.md index 6eec0e8492a..2066d6c9f46 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.md @@ -25,11 +25,11 @@ Create a new Acquire instruction. **Parameters** * **duration** (`int`) – Length of time to acquire data in terms of dt. -* **channel** (`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), `List`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")], `None`]) – The channel that will acquire data. -* **mem\_slot** (`Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), `List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")], `None`]) – The classical memory slot in which to store the classified readout result. -* **mem\_slots** (`Optional`\[`List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]]) – Deprecated list form of `mem_slot`. -* **reg\_slots** (`Union`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot"), `List`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")], `None`]) – Deprecated list form of `reg_slot`. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** (`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), `List`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")], `None`]) – The channel that will acquire data. +* **mem\_slot** (`Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), `List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")], `None`]) – The classical memory slot in which to store the classified readout result. +* **mem\_slots** (`Optional`\[`List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]]) – Deprecated list form of `mem_slot`. +* **reg\_slots** (`Union`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot"), `List`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")], `None`]) – Deprecated list form of `reg_slot`. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -50,7 +50,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### acquires @@ -62,7 +62,7 @@ Acquire channels to be acquired on. **Return type** -`List`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")] +`List`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")] ### channel @@ -70,11 +70,11 @@ Acquire channels to be acquired on. `qiskit.pulse.channels.AcquireChannel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### channels @@ -86,7 +86,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -170,7 +170,7 @@ The classical memory slot which will store the classified readout result. **Return type** -[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot") +[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot") ### mem\_slots @@ -182,7 +182,7 @@ MemorySlots. **Return type** -`List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")] +`List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")] ### name @@ -218,7 +218,7 @@ The fast-access register slot which will store the classified readout result for **Return type** -[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot") +[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot") ### reg\_slots @@ -230,7 +230,7 @@ RegisterSlots. **Return type** -`List`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")] +`List`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")] ### start\_time @@ -266,7 +266,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -280,11 +280,11 @@ Return new `Acquire` that is fully instantiated with its channels. **Parameters** -* **channel** (`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), `List`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")], `None`]) – The channel that will acquire data. -* **mem\_slot** (`Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), `List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")], `None`]) – The classical memory slot in which to store the classified readout result. -* **mem\_slots** (`Optional`\[`List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]]) – Deprecated list form of `mem_slot`. -* **reg\_slots** (`Union`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot"), `List`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")], `None`]) – Deprecated list form of `reg_slot`. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** (`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), `List`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")], `None`]) – The channel that will acquire data. +* **mem\_slot** (`Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), `List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")], `None`]) – The classical memory slot in which to store the classified readout result. +* **mem\_slots** (`Optional`\[`List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]]) – Deprecated list form of `mem_slot`. +* **reg\_slots** (`Union`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot"), `List`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")], `None`]) – Deprecated list form of `reg_slot`. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -377,11 +377,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -389,7 +389,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.md index 1774b6a1863..c03ee4efaa1 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.md @@ -33,7 +33,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`int`) – Length of time of the delay in terms of dt. -* **channel** (`Optional`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]) – The channel that will have the delay. +* **channel** (`Optional`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ## Attributes @@ -44,11 +44,11 @@ No other instruction may be scheduled within a `Delay`. `qiskit.pulse.channels.Channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") ### channels @@ -60,7 +60,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -168,7 +168,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -182,7 +182,7 @@ Return new `Delay` that is fully instantiated with both `duration` and a `channe **Parameters** -**channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +**channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. **Return type** @@ -272,11 +272,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -284,7 +284,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.md index a4080b043fb..d3b5168c70c 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.md @@ -20,7 +20,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Union`\[`Command`, `int`]) – Length of time taken by the instruction in terms of dt. Deprecated: the first argument used to be the Command. -* **channels** (`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]) – Tuple of pulse channels that this instruction operates on. +* **channels** (`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]) – Tuple of pulse channels that this instruction operates on. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -39,7 +39,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -147,7 +147,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -227,11 +227,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -239,7 +239,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.md index d47ec5dbeed..e40097e467a 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.md @@ -21,7 +21,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`SamplePulse`](qiskit.pulse.pulse_lib.SamplePulse "qiskit.pulse.pulse_lib.SamplePulse"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -36,11 +36,11 @@ Create a new pulse instruction. `qiskit.pulse.channels.PulseChannel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -52,7 +52,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -172,7 +172,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -252,11 +252,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -264,7 +264,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.md index d80fec69ee6..2b4ee4663f6 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.md @@ -27,7 +27,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`float`) – New frequency of the channel in Hz. -* **channel** (`Optional`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")]) – The channel this instruction operates on. +* **channel** (`Optional`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")]) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency command. ## Attributes @@ -38,11 +38,11 @@ Creates a new set channel frequency instruction. `qiskit.pulse.channels.PulseChannel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -54,7 +54,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -174,7 +174,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -254,11 +254,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -266,7 +266,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.md index f71578719d2..c4ebe68abe8 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase `ShiftPhase(phase, channel=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.14/qiskit/pulse/instructions/phase.py "view source code") -The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. +The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -29,7 +29,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`complex`) – The rotation angle in radians. -* **channel** (`Optional`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")]) – The channel this instruction operates on. +* **channel** (`Optional`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")]) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Attributes @@ -40,11 +40,11 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch `qiskit.pulse.channels.PulseChannel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -56,7 +56,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -176,7 +176,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ## Methods @@ -190,7 +190,7 @@ Return a new ShiftPhase instruction supporting the deprecated syntax of FrameCha **Parameters** -**channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +**channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. **Raises** @@ -280,11 +280,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -292,7 +292,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.md index 6675e519263..10aca1bf850 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.md @@ -30,11 +30,11 @@ Create new snapshot. `qiskit.pulse.channels.SnapshotChannel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** -[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel") +[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel") ### channels @@ -46,7 +46,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### command @@ -166,7 +166,7 @@ Occupied time slots by this instruction. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] ### type @@ -266,11 +266,11 @@ Plot the instruction. **Parameters** * **dt** (`float`) – Time interval of samples -* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*SchedStyle*](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels * **plot\_all** (`bool`) – Plot empty channels * **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot * **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) @@ -278,7 +278,7 @@ Plot the instruction. * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators * **scaling** (`Optional`\[`float`]) – Deprecated, see scale -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.instructions.md b/docs/api/qiskit/0.19/qiskit.pulse.instructions.md index 561f97ce6f5..e2ebe5bb218 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.md @@ -1,8 +1,16 @@ +--- +title: instructions +description: API reference for qiskit.pulse.instructions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.instructions +--- + # instructions -The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") specifying where the instruction will be applied. +The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") specifying where the instruction will be applied. -Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") `channel`: +Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") `channel`: ```python ShiftPhase(phase, channel) @@ -16,17 +24,18 @@ Delay(duration, channel) An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), which is a sequence of scheduled Pulse `Instruction` s over many channels. `Instruction` s and `Schedule` s implement the same interface. -| | | -| ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration\[, channel, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration\[, channel, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase\[, channel, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | -| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration\[, channel, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration\[, channel, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase\[, channel, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). | +| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Abstract Classes | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`Instruction`](qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")(operands, duration, channels\[, name]) | The smallest schedulable unit: a single instruction. | + diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.md index 5f92e2cb5be..b51ed22acfd 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Constant.md @@ -86,7 +86,7 @@ Plot the pulse. **Parameters** * **dt** (`float`) – Time interval of samples. -* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.PulseStyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#pulsestyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.md index 743d7f52b0a..5210b53bf75 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Drag.md @@ -124,7 +124,7 @@ Plot the pulse. **Parameters** * **dt** (`float`) – Time interval of samples. -* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.PulseStyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#pulsestyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.md index 2033d3a3842..e1b6f55f50b 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.Gaussian.md @@ -98,7 +98,7 @@ Plot the pulse. **Parameters** * **dt** (`float`) – Time interval of samples. -* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.PulseStyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#pulsestyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.md index 57d05bc455f..491a0e25ef6 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.GaussianSquare.md @@ -111,7 +111,7 @@ Plot the pulse. **Parameters** * **dt** (`float`) – Time interval of samples. -* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.PulseStyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance +* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#pulsestyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance * **filename** (`Optional`\[`str`]) – Name required to save pulse image * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation * **scale** (`float`) – Relative visual scaling of waveform amplitudes diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.md index 7b772d6f20f..c08933929a6 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.SamplePulse.md @@ -69,7 +69,7 @@ Plot the interpolated envelope of pulse. **Parameters** * **dt** (`float`) – Time interval of samples. -* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.PulseStyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance. +* **style** (*Optional\[*[*PulseStyle*](qiskit.visualization.pulse.qcstyle#pulsestyle "qiskit.visualization.pulse.qcstyle.PulseStyle")*]*) – A style sheet to configure plot appearance. * **filename** (`Optional`\[`str`]) – Name required to save pulse image. * **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation. * **scale** (`float`) – Relative visual scaling of waveform amplitudes. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.discrete.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.discrete.md index 24d9c138435..60b73b8b726 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.discrete.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.discrete.md @@ -1,9 +1,9 @@ --- -title: constant -description: API reference for qiskit.pulse.pulse_lib.discrete.constant +title: discrete +description: API reference for qiskit.pulse.pulse_lib.discrete in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.pulse.pulse_lib.discrete.constant +python_api_type: module +python_api_name: qiskit.pulse.pulse_lib.discrete --- # discrete diff --git a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.md b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.md index 8ad8521a791..42336520832 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.pulse_lib.md @@ -1,3 +1,11 @@ +--- +title: pulse_lib +description: API reference for qiskit.pulse.pulse_lib +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.pulse_lib +--- + # pulse\_lib @@ -18,3 +26,4 @@ The parametric pulses, [`Gaussian`](qiskit.pulse.pulse_lib.Gaussian "qiskit.puls | [`Drag`](qiskit.pulse.pulse_lib.Drag "qiskit.pulse.pulse_lib.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | | [`Gaussian`](qiskit.pulse.pulse_lib.Gaussian "qiskit.pulse.pulse_lib.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | | [`GaussianSquare`](qiskit.pulse.pulse_lib.GaussianSquare "qiskit.pulse.pulse_lib.GaussianSquare")(duration, amp, sigma, width) | A square pulse with a Gaussian shaped risefall on either side: | + diff --git a/docs/api/qiskit/0.19/qiskit.pulse.reschedule.pad.md b/docs/api/qiskit/0.19/qiskit.pulse.reschedule.pad.md index 01b563524f5..e61c85b7a7f 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.reschedule.pad.md +++ b/docs/api/qiskit/0.19/qiskit.pulse.reschedule.pad.md @@ -17,7 +17,7 @@ Pad the input `Schedule` with `Delay` s on all unoccupied timeslots until `until **Parameters** * **schedule** ([`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule")) – Schedule to pad. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Channels to pad. Defaults to all channels in `schedule` if not provided. If the supplied channel is not a member of `schedule`, it will be added. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Channels to pad. Defaults to all channels in `schedule` if not provided. If the supplied channel is not a member of `schedule`, it will be added. * **until** (`Optional`\[`int`]) – Time to pad until. Defaults to `schedule.duration` if not provided. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.md index 30b73309a42..a001df671e4 100644 --- a/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.19/qiskit.scheduler.methods.basic.md @@ -1,9 +1,9 @@ --- -title: CircuitPulseDef -description: API reference for qiskit.scheduler.methods.basic.CircuitPulseDef +title: basic +description: API reference for qiskit.scheduler.methods.basic in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.scheduler.methods.basic.CircuitPulseDef +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic --- # basic diff --git a/docs/api/qiskit/0.19/qiskit.scheduler.utils.md b/docs/api/qiskit/0.19/qiskit.scheduler.utils.md index 71e7838cbd1..1d9b05e8c30 100644 --- a/docs/api/qiskit/0.19/qiskit.scheduler.utils.md +++ b/docs/api/qiskit/0.19/qiskit.scheduler.utils.md @@ -1,9 +1,9 @@ --- -title: format_meas_map -description: API reference for qiskit.scheduler.utils.format_meas_map +title: utils +description: API reference for qiskit.scheduler.utils in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.scheduler.utils.format_meas_map +python_api_type: module +python_api_name: qiskit.scheduler.utils --- # utils diff --git a/docs/api/qiskit/0.19/qiskit.visualization.pulse.interpolation.md b/docs/api/qiskit/0.19/qiskit.visualization.pulse.interpolation.md index 00cfdee0503..af61545eb2b 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.pulse.interpolation.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.pulse.interpolation.md @@ -1,9 +1,9 @@ --- -title: cubic_spline -description: API reference for qiskit.visualization.pulse.interpolation.cubic_spline +title: interpolation +description: API reference for qiskit.visualization.pulse.interpolation in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.visualization.pulse.interpolation.cubic_spline +python_api_type: module +python_api_name: qiskit.visualization.pulse.interpolation --- # interpolation diff --git a/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.md b/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.md index 71ac0eb2f83..965fae45115 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.pulse.qcstyle.md @@ -1,9 +1,9 @@ --- -title: PulseStyle -description: API reference for qiskit.visualization.pulse.qcstyle.PulseStyle +title: qcstyle +description: API reference for qiskit.visualization.pulse.qcstyle in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.visualization.pulse.qcstyle.PulseStyle +python_api_type: module +python_api_name: qiskit.visualization.pulse.qcstyle --- # qcstyle diff --git a/docs/api/qiskit/0.19/qiskit.visualization.pulse_drawer.md b/docs/api/qiskit/0.19/qiskit.visualization.pulse_drawer.md index 47fa00a16af..2d81fb388b5 100644 --- a/docs/api/qiskit/0.19/qiskit.visualization.pulse_drawer.md +++ b/docs/api/qiskit/0.19/qiskit.visualization.pulse_drawer.md @@ -18,12 +18,12 @@ Plot the interpolated envelope of pulse and schedule. * **data** (`Union`\[[`SamplePulse`](qiskit.pulse.pulse_lib.SamplePulse "qiskit.pulse.pulse_lib.sample_pulse.SamplePulse"), `ScheduleComponent`]) – Pulse or schedule object to plot. * **dt** (`int`) – Time interval of samples. Pulses are visualized in the unit of cycle time if not provided. -* **style** (`Union`\[[`PulseStyle`](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.PulseStyle "qiskit.visualization.pulse.qcstyle.PulseStyle"), [`SchedStyle`](qiskit.visualization.pulse.qcstyle#qiskit.visualization.pulse.qcstyle.SchedStyle "qiskit.visualization.pulse.qcstyle.SchedStyle"), `None`]) – A style sheet to configure plot appearance. See [`qcstyle`](qiskit.visualization.pulse.qcstyle#module-qiskit.visualization.pulse.qcstyle "qiskit.visualization.pulse.qcstyle") for more information. +* **style** (`Union`\[[`PulseStyle`](qiskit.visualization.pulse.qcstyle#pulsestyle "qiskit.visualization.pulse.qcstyle.PulseStyle"), [`SchedStyle`](qiskit.visualization.pulse.qcstyle#schedstyle "qiskit.visualization.pulse.qcstyle.SchedStyle"), `None`]) – A style sheet to configure plot appearance. See [`qcstyle`](qiskit.visualization.pulse.qcstyle#module-qiskit.visualization.pulse.qcstyle "qiskit.visualization.pulse.qcstyle") for more information. * **filename** (`Optional`\[`str`]) – Name required to save pulse image. The drawer just returns matplot.Figure object if not provided. * **interp\_method** (`Optional`\[`Callable`]) – Interpolation function. Interpolation is disabled in default. See [`interpolation`](qiskit.visualization.pulse.interpolation#module-qiskit.visualization.pulse.interpolation "qiskit.visualization.pulse.interpolation") for more information. * **scale** (`Optional`\[`float`]) – Scaling of waveform amplitude. Pulses are automatically scaled channel by channel if not provided. -* **channel\_scales** (`Optional`\[`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `float`]]) – Dictionary of scale factor for specific channels. Scale of channels not specified here is overwritten by scale. -* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels. +* **channel\_scales** (`Optional`\[`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `float`]]) – Dictionary of scale factor for specific channels. Scale of channels not specified here is overwritten by scale. +* **channels\_to\_plot** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated, see channels. * **plot\_all** (`bool`) – When set True plot empty channels. * **plot\_range** (`Optional`\[`Tuple`\[`Union`\[`int`, `float`], `Union`\[`int`, `float`]]]) – A tuple of time range to plot. * **interactive** (`bool`) – When set True show the circuit in a new window. This depends on the matplotlib backend being used supporting this. @@ -31,7 +31,7 @@ Plot the interpolated envelope of pulse and schedule. * **label** (`bool`) – When set True draw label for individual instructions. * **framechange** (`bool`) – When set True draw framechange indicators. * **scaling** (`Optional`\[`float`]) – Deprecated, see scale. -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot. All non-empty channels are shown if not provided. +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot. All non-empty channels are shown if not provided. * **show\_framechange\_channels** (`bool`) – When set True plot channels with only framechange instructions. **Returns** diff --git a/docs/api/qiskit/0.25/_toc.json b/docs/api/qiskit/0.25/_toc.json index 8297370893c..28971a12f48 100644 --- a/docs/api/qiskit/0.25/_toc.json +++ b/docs/api/qiskit/0.25/_toc.json @@ -1740,34 +1740,6 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.25/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.25/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.25/qiskit.circuit.library.Barrier" - }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CCXGate" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.25/qiskit.circuit.ClassicalRegister" @@ -1776,214 +1748,22 @@ "title": "Clbit", "url": "/api/qiskit/0.25/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_8_3" - }, { "title": "ControlledGate", "url": "/api/qiskit/0.25/qiskit.circuit.ControlledGate" }, - { - "title": "CPhaseGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CSwapGate" - }, - { - "title": "CSXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CSXGate" - }, - { - "title": "CU1Gate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CU1Gate" - }, - { - "title": "CU3Gate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CU3Gate" - }, - { - "title": "CUGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CUGate" - }, - { - "title": "CXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CXGate" - }, - { - "title": "CYGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CYGate" - }, - { - "title": "CZGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.CZGate" - }, - { - "title": "DCXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.DCXGate" - }, { "title": "Delay", "url": "/api/qiskit/0.25/qiskit.circuit.Delay" }, - { - "title": "Diagonal", - "url": "/api/qiskit/0.25/qiskit.circuit.library.Diagonal" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.EfficientSU2" - }, { "title": "EquivalenceLibrary", "url": "/api/qiskit/0.25/qiskit.circuit.EquivalenceLibrary" }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.25/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.25/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.25/qiskit.circuit.library.FunctionalPauliRotations" - }, { "title": "Gate", "url": "/api/qiskit/0.25/qiskit.circuit.Gate" }, - { - "title": "GMS", - "url": "/api/qiskit/0.25/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.25/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.25/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.25/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.25/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.25/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.25/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.25/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.25/qiskit.circuit.library.InnerProduct" - }, { "title": "Instruction", "url": "/api/qiskit/0.25/qiskit.circuit.Instruction" @@ -1992,82 +1772,10 @@ "title": "InstructionSet", "url": "/api/qiskit/0.25/qiskit.circuit.InstructionSet" }, - { - "title": "IntegerComparator", - "url": "/api/qiskit/0.25/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.25/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.25/qiskit.circuit.library.LinearAmplitudeFunction" - }, - { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.25/qiskit.circuit.library.LinearPauliRotations" - }, - { - "title": "LogNormalDistribution", - "url": "/api/qiskit/0.25/qiskit.circuit.library.LogNormalDistribution" - }, - { - "title": "MCMT", - "url": "/api/qiskit/0.25/qiskit.circuit.library.MCMT" - }, - { - "title": "MCMTVChain", - "url": "/api/qiskit/0.25/qiskit.circuit.library.MCMTVChain" - }, - { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.MCPhaseGate" - }, - { - "title": "MCXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.MCXGate" - }, - { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.25/qiskit.circuit.library.MCXGrayCode" - }, - { - "title": "MCXRecursive", - "url": "/api/qiskit/0.25/qiskit.circuit.library.MCXRecursive" - }, - { - "title": "MCXVChain", - "url": "/api/qiskit/0.25/qiskit.circuit.library.MCXVChain" - }, { "title": "Measure", "url": "/api/qiskit/0.25/qiskit.circuit.Measure" }, - { - "title": "Measure", - "url": "/api/qiskit/0.25/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.25/qiskit.circuit.library.NLocal" - }, - { - "title": "NormalDistribution", - "url": "/api/qiskit/0.25/qiskit.circuit.library.NormalDistribution" - }, - { - "title": "OR", - "url": "/api/qiskit/0.25/qiskit.circuit.library.OR" - }, { "title": "Parameter", "url": "/api/qiskit/0.25/qiskit.circuit.Parameter" @@ -2080,58 +1788,6 @@ "title": "ParameterVector", "url": "/api/qiskit/0.25/qiskit.circuit.ParameterVector" }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.25/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.25/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.25/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.25/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.25/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.25/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.25/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.25/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.25/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.25/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.25/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.25/qiskit.circuit.library.QuadraticForm" - }, { "title": "QuantumCircuit", "url": "/api/qiskit/0.25/qiskit.circuit.QuantumCircuit" @@ -2140,10 +1796,6 @@ "title": "QuantumRegister", "url": "/api/qiskit/0.25/qiskit.circuit.QuantumRegister" }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.25/qiskit.circuit.library.QuantumVolume" - }, { "title": "Qubit", "url": "/api/qiskit/0.25/qiskit.circuit.Qubit" @@ -2152,376 +1804,733 @@ "title": "random_circuit", "url": "/api/qiskit/0.25/qiskit.circuit.random.random_circuit" }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RealAmplitudes" - }, { "title": "Reset", "url": "/api/qiskit/0.25/qiskit.circuit.Reset" }, { - "title": "Reset", - "url": "/api/qiskit/0.25/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RGate" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.SGate" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_1" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.25/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.25/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.25/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.UGate" - }, - { - "title": "UniformDistribution", - "url": "/api/qiskit/0.25/qiskit.circuit.library.UniformDistribution" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.25/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.25/qiskit.circuit.library.XOR" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.25/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.25/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.25/qiskit.circuit.library.ZZFeatureMap" - }, - { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.25/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.25/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.25/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.25/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CCXGate" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.25/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.25/qiskit.circuit.library.Diagonal" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.25/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.25/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.25/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.25/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.25/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.25/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.25/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.25/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.25/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.25/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.25/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.25/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.25/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.25/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.25/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.25/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "LogNormalDistribution", + "url": "/api/qiskit/0.25/qiskit.circuit.library.LogNormalDistribution" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.25/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.25/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.25/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.25/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.25/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.25/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.25/qiskit.circuit.library.NLocal" + }, + { + "title": "NormalDistribution", + "url": "/api/qiskit/0.25/qiskit.circuit.library.NormalDistribution" + }, + { + "title": "OR", + "url": "/api/qiskit/0.25/qiskit.circuit.library.OR" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.25/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.25/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.25/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.25/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.25/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.25/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.25/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.25/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.25/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.25/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.25/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.25/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.25/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.25/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RGate" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.25/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.SGate" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.25/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "SwapGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.SwapGate" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "SXdgGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.SXdgGate" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "SXGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.SXGate" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.25/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "TdgGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.25/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.25/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.U2Gate" + }, + { + "title": "U3Gate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.U3Gate" + }, + { + "title": "UGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.UGate" + }, + { + "title": "UniformDistribution", + "url": "/api/qiskit/0.25/qiskit.circuit.library.UniformDistribution" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.25/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.25/qiskit.circuit.library.XOR" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.25/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.25/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.25/qiskit.circuit.library.ZZFeatureMap" } ] } @@ -2681,11 +2690,11 @@ "url": "/api/qiskit/0.25/qiskit.finance.applications.ising" }, { - "title": "get_operator", + "title": "qiskit.finance.applications.ising.portfolio", "url": "/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio" }, { - "title": "get_operator", + "title": "qiskit.finance.applications.ising.portfolio_diversification", "url": "/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio_diversification" } ] @@ -3123,6 +3132,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.25/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.25/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.25/qiskit.ignis.verification.QOTP" @@ -3645,56 +3658,56 @@ "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising" }, { - "title": "check_disjoint", - "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.set_packing" + "title": "qiskit.optimization.applications.ising.clique", + "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.clique" }, { - "title": "check_full_edge_coverage", - "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.vertex_cover" + "title": "qiskit.optimization.applications.ising.common", + "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.common" }, { - "title": "check_solution_satisfiability", - "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.exact_cover" + "title": "qiskit.optimization.applications.ising.docplex", + "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.docplex" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.clique" + "title": "qiskit.optimization.applications.ising.exact_cover", + "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.exact_cover" }, { - "title": "get_graph_solution", + "title": "qiskit.optimization.applications.ising.graph_partition", "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.graph_partition" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.max_cut" + "title": "qiskit.optimization.applications.ising.knapsack", + "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.knapsack" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.stable_set" + "title": "qiskit.optimization.applications.ising.max_cut", + "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.max_cut" }, { - "title": "get_gset_result", - "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.common" + "title": "qiskit.optimization.applications.ising.partition", + "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.partition" }, { - "title": "get_operator", - "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.docplex" + "title": "qiskit.optimization.applications.ising.set_packing", + "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.set_packing" }, { - "title": "get_operator", - "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.knapsack" + "title": "qiskit.optimization.applications.ising.stable_set", + "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.stable_set" }, { - "title": "get_operator", - "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.partition" + "title": "qiskit.optimization.applications.ising.tsp", + "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp" }, { - "title": "get_operator", + "title": "qiskit.optimization.applications.ising.vehicle_routing", "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.vehicle_routing" }, { - "title": "TspData", - "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp" + "title": "qiskit.optimization.applications.ising.vertex_cover", + "url": "/api/qiskit/0.25/qiskit.optimization.applications.ising.vertex_cover" } ] } @@ -4583,10 +4596,6 @@ "title": "acquire", "url": "/api/qiskit/0.25/qiskit.pulse.builder.acquire" }, - { - "title": "Acquire", - "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Acquire" - }, { "title": "acquire_channel", "url": "/api/qiskit/0.25/qiskit.pulse.builder.acquire_channel" @@ -4595,10 +4604,6 @@ "title": "AcquireChannel", "url": "/api/qiskit/0.25/qiskit.pulse.AcquireChannel" }, - { - "title": "AcquireChannel", - "url": "/api/qiskit/0.25/qiskit.pulse.channels" - }, { "title": "active_backend", "url": "/api/qiskit/0.25/qiskit.pulse.builder.active_backend" @@ -4655,10 +4660,6 @@ "title": "call", "url": "/api/qiskit/0.25/qiskit.pulse.builder.call" }, - { - "title": "Call", - "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Call" - }, { "title": "circuit_scheduler_settings", "url": "/api/qiskit/0.25/qiskit.pulse.builder.circuit_scheduler_settings" @@ -4667,14 +4668,6 @@ "title": "Constant", "url": "/api/qiskit/0.25/qiskit.pulse.Constant" }, - { - "title": "Constant", - "url": "/api/qiskit/0.25/qiskit.pulse.library.Constant" - }, - { - "title": "constant", - "url": "/api/qiskit/0.25/qiskit.pulse.library.discrete" - }, { "title": "control_channels", "url": "/api/qiskit/0.25/qiskit.pulse.builder.control_channels" @@ -4695,10 +4688,6 @@ "title": "delay", "url": "/api/qiskit/0.25/qiskit.pulse.builder.delay" }, - { - "title": "Delay", - "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Delay" - }, { "title": "delay_qubits", "url": "/api/qiskit/0.25/qiskit.pulse.builder.delay_qubits" @@ -4707,10 +4696,6 @@ "title": "Drag", "url": "/api/qiskit/0.25/qiskit.pulse.Drag" }, - { - "title": "Drag", - "url": "/api/qiskit/0.25/qiskit.pulse.library.Drag" - }, { "title": "drive_channel", "url": "/api/qiskit/0.25/qiskit.pulse.builder.drive_channel" @@ -4727,18 +4712,10 @@ "title": "Gaussian", "url": "/api/qiskit/0.25/qiskit.pulse.Gaussian" }, - { - "title": "Gaussian", - "url": "/api/qiskit/0.25/qiskit.pulse.library.Gaussian" - }, { "title": "GaussianSquare", "url": "/api/qiskit/0.25/qiskit.pulse.GaussianSquare" }, - { - "title": "GaussianSquare", - "url": "/api/qiskit/0.25/qiskit.pulse.library.GaussianSquare" - }, { "title": "inline", "url": "/api/qiskit/0.25/qiskit.pulse.builder.inline" @@ -4747,10 +4724,6 @@ "title": "Instruction", "url": "/api/qiskit/0.25/qiskit.pulse.Instruction" }, - { - "title": "Instruction", - "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Instruction" - }, { "title": "InstructionScheduleMap", "url": "/api/qiskit/0.25/qiskit.pulse.InstructionScheduleMap" @@ -4799,14 +4772,14 @@ "title": "play", "url": "/api/qiskit/0.25/qiskit.pulse.builder.play" }, - { - "title": "Play", - "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Play" - }, { "title": "PulseError", "url": "/api/qiskit/0.25/qiskit.pulse.PulseError" }, + { + "title": "qiskit.pulse.channels", + "url": "/api/qiskit/0.25/qiskit.pulse.channels" + }, { "title": "qubit_channels", "url": "/api/qiskit/0.25/qiskit.pulse.builder.qubit_channels" @@ -4843,18 +4816,10 @@ "title": "SetFrequency", "url": "/api/qiskit/0.25/qiskit.pulse.SetFrequency" }, - { - "title": "SetFrequency", - "url": "/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency" - }, { "title": "SetPhase", "url": "/api/qiskit/0.25/qiskit.pulse.SetPhase" }, - { - "title": "SetPhase", - "url": "/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase" - }, { "title": "shift_frequency", "url": "/api/qiskit/0.25/qiskit.pulse.builder.shift_frequency" @@ -4867,18 +4832,10 @@ "title": "ShiftFrequency", "url": "/api/qiskit/0.25/qiskit.pulse.ShiftFrequency" }, - { - "title": "ShiftFrequency", - "url": "/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency" - }, { "title": "ShiftPhase", "url": "/api/qiskit/0.25/qiskit.pulse.ShiftPhase" }, - { - "title": "ShiftPhase", - "url": "/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase" - }, { "title": "Snapshot", "url": "/api/qiskit/0.25/qiskit.pulse.Snapshot" @@ -4887,10 +4844,6 @@ "title": "snapshot", "url": "/api/qiskit/0.25/qiskit.pulse.builder.snapshot" }, - { - "title": "Snapshot", - "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot" - }, { "title": "transpiler_settings", "url": "/api/qiskit/0.25/qiskit.pulse.builder.transpiler_settings" @@ -4911,13 +4864,91 @@ "title": "Waveform", "url": "/api/qiskit/0.25/qiskit.pulse.Waveform" }, - { - "title": "Waveform", - "url": "/api/qiskit/0.25/qiskit.pulse.library.Waveform" - }, { "title": "x", "url": "/api/qiskit/0.25/qiskit.pulse.builder.x" + }, + { + "title": "qiskit.pulse.instructions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.25/qiskit.pulse.instructions" + }, + { + "title": "Acquire", + "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Acquire" + }, + { + "title": "Call", + "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Call" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Delay" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Instruction" + }, + { + "title": "Play", + "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Play" + }, + { + "title": "SetFrequency", + "url": "/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency" + }, + { + "title": "SetPhase", + "url": "/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase" + }, + { + "title": "ShiftFrequency", + "url": "/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency" + }, + { + "title": "ShiftPhase", + "url": "/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot" + } + ] + }, + { + "title": "qiskit.pulse.library", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.25/qiskit.pulse.library" + }, + { + "title": "Constant", + "url": "/api/qiskit/0.25/qiskit.pulse.library.Constant" + }, + { + "title": "Drag", + "url": "/api/qiskit/0.25/qiskit.pulse.library.Drag" + }, + { + "title": "Gaussian", + "url": "/api/qiskit/0.25/qiskit.pulse.library.Gaussian" + }, + { + "title": "GaussianSquare", + "url": "/api/qiskit/0.25/qiskit.pulse.library.GaussianSquare" + }, + { + "title": "qiskit.pulse.library.discrete", + "url": "/api/qiskit/0.25/qiskit.pulse.library.discrete" + }, + { + "title": "Waveform", + "url": "/api/qiskit/0.25/qiskit.pulse.library.Waveform" + } + ] } ] }, @@ -5253,11 +5284,11 @@ "url": "/api/qiskit/0.25/scheduler" }, { - "title": "as_late_as_possible", + "title": "qiskit.scheduler.methods.basic", "url": "/api/qiskit/0.25/qiskit.scheduler.methods.basic" }, { - "title": "schedule_circuit", + "title": "qiskit.scheduler.schedule_circuit", "url": "/api/qiskit/0.25/qiskit.scheduler.schedule_circuit" }, { diff --git a/docs/api/qiskit/0.25/circuit_library.md b/docs/api/qiskit/0.25/circuit_library.md index 9e5e72f573c..2c693769ddf 100644 --- a/docs/api/qiskit/0.25/circuit_library.md +++ b/docs/api/qiskit/0.25/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -265,3 +277,4 @@ | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.25/pulse.md b/docs/api/qiskit/0.25/pulse.md index 443566916c8..f79c4457cef 100644 --- a/docs/api/qiskit/0.25/pulse.md +++ b/docs/api/qiskit/0.25/pulse.md @@ -32,18 +32,18 @@ This is sufficient to allow the quantum physicist to explore and correct for noi `qiskit.pulse.instructions` -| | | -| ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | -| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Call`](qiskit.pulse.Call "qiskit.pulse.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | -| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftFrequency`](qiskit.pulse.ShiftFrequency "qiskit.pulse.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | -| [`SetPhase`](qiskit.pulse.SetPhase "qiskit.pulse.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | -| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | -| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | +| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Call`](qiskit.pulse.Call "qiskit.pulse.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | +| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftFrequency`](qiskit.pulse.ShiftFrequency "qiskit.pulse.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | +| [`SetPhase`](qiskit.pulse.SetPhase "qiskit.pulse.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | +| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). | +| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Pulse Library (waveforms ) @@ -274,11 +274,11 @@ with pulse.build(backend) as measure_sched: MemorySlot(0) ``` -| | | -| ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`measure`](qiskit.pulse.builder.measure "qiskit.pulse.builder.measure")(qubits\[, registers]) | Measure a qubit within the currently active builder context. | -| [`measure_all`](qiskit.pulse.builder.measure_all "qiskit.pulse.builder.measure_all")() | Measure all qubits within the currently active builder context. | -| [`delay_qubits`](qiskit.pulse.builder.delay_qubits "qiskit.pulse.builder.delay_qubits")(duration, \*qubits) | Insert delays on all of the [`channels.Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")s that correspond to the input `qubits` at the same time. | +| | | +| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`measure`](qiskit.pulse.builder.measure "qiskit.pulse.builder.measure")(qubits\[, registers]) | Measure a qubit within the currently active builder context. | +| [`measure_all`](qiskit.pulse.builder.measure_all "qiskit.pulse.builder.measure_all")() | Measure all qubits within the currently active builder context. | +| [`delay_qubits`](qiskit.pulse.builder.delay_qubits "qiskit.pulse.builder.delay_qubits")(duration, \*qubits) | Insert delays on all of the [`channels.Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")s that correspond to the input `qubits` at the same time. | ### Circuit Gates diff --git a/docs/api/qiskit/0.25/qiskit.compiler.assemble.md b/docs/api/qiskit/0.25/qiskit.compiler.assemble.md index e6429dd2655..fb20d988d7e 100644 --- a/docs/api/qiskit/0.25/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.25/qiskit.compiler.assemble.md @@ -42,7 +42,7 @@ This function serializes the payloads, which could be either circuits or schedul * **meas\_lo\_range** (`Optional`\[`List`\[`int`]]) – List of measurement LO ranges each of form `[range_min, range_max]` in Hz. Used to validate the supplied qubit frequencies. -* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. +* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. * **meas\_level** (`Union`\[`int`, `MeasLevel`]) – Set the appropriate level of the measurement output for pulse experiments. diff --git a/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio.md index 6ecac2fa438..82487c60134 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.finance.applications.ising.portfolio.get_operator +title: portfolio +description: API reference for qiskit.finance.applications.ising.portfolio in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.finance.applications.ising.portfolio.get_operator +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio --- diff --git a/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio_diversification.md index 4716f1a56b6..f91ddbb89e1 100644 --- a/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.25/qiskit.finance.applications.ising.portfolio_diversification.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.finance.applications.ising.portfolio_diversification.get_operator +title: portfolio_diversification +description: API reference for qiskit.finance.applications.ising.portfolio_diversification in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.finance.applications.ising.portfolio_diversification.get_operator +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio_diversification --- diff --git a/docs/api/qiskit/0.25/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.25/qiskit.ignis.verification.basis.md index e26610b6708..c7c0137e9f8 100644 --- a/docs/api/qiskit/0.25/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.25/qiskit.ignis.verification.basis.md @@ -1,5 +1,14 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # qiskit.ignis.verification.basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.clique.md index 940c74047fe..c0e4c528922 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.clique.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.clique.get_graph_solution +title: clique +description: API reference for qiskit.optimization.applications.ising.clique in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.clique.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.clique --- diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.common.md index 3392c7d4935..a80b94865a2 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.common.md @@ -1,9 +1,9 @@ --- -title: get_gset_result -description: API reference for qiskit.optimization.applications.ising.common.get_gset_result +title: common +description: API reference for qiskit.optimization.applications.ising.common in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.common.get_gset_result +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.common --- diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.docplex.md index 9ddbec3f2b1..343cc6b736b 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.docplex.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.docplex.get_operator +title: docplex +description: API reference for qiskit.optimization.applications.ising.docplex in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.docplex.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.docplex --- diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.exact_cover.md index 1e7745503a3..6eced2620c4 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.exact_cover.md @@ -1,9 +1,9 @@ --- -title: check_solution_satisfiability -description: API reference for qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability +title: exact_cover +description: API reference for qiskit.optimization.applications.ising.exact_cover in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.exact_cover --- diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.graph_partition.md index c9a4bfb5d3d..2d3f7e88296 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.graph_partition.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.graph_partition.get_graph_solution +title: graph_partition +description: API reference for qiskit.optimization.applications.ising.graph_partition in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.graph_partition.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.graph_partition --- @@ -50,11 +50,11 @@ Generate Hamiltonian for the graph partitioning **Notes** -## Goals: +**Goals:** 1 separate the vertices into two set of the same size 2 make sure the number of edges between the two set is minimized. -## Hamiltonian: +**Hamiltonian:** H = H\_A + H\_B H\_A = sum\_\{(i,j)in E}\{(1-ZiZj)/2} H\_B = (sum\_\{i}\{Zi})^2 = sum\_\{i}\{Zi^2}+sum\_\{i!=j}\{ZiZj} H\_A is for achieving goal 2 and H\_B is for achieving goal 1. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.knapsack.md index aa6c9e7c681..6f9306be50f 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.knapsack.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.knapsack.get_operator +title: knapsack +description: API reference for qiskit.optimization.applications.ising.knapsack in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.knapsack.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.knapsack --- diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.max_cut.md index 03838a55ff8..0f7cd5d4d0f 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.max_cut.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.max_cut.get_graph_solution +title: max_cut +description: API reference for qiskit.optimization.applications.ising.max_cut in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.max_cut.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.max_cut --- diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.partition.md index 2cc12770421..451c7de04e4 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.partition.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.partition.get_operator +title: partition +description: API reference for qiskit.optimization.applications.ising.partition in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.partition.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.partition --- diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.set_packing.md index 50a16bc2e93..6fe5f8562f4 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.set_packing.md @@ -1,9 +1,9 @@ --- -title: check_disjoint -description: API reference for qiskit.optimization.applications.ising.set_packing.check_disjoint +title: set_packing +description: API reference for qiskit.optimization.applications.ising.set_packing in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.set_packing.check_disjoint +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.set_packing --- diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.stable_set.md index e3ea779d063..2f6481bbfd8 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.stable_set.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.stable_set.get_graph_solution +title: stable_set +description: API reference for qiskit.optimization.applications.ising.stable_set in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.stable_set.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.stable_set --- diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.md index bbc3456ab5a..e5f3da7c799 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.md @@ -1,9 +1,9 @@ --- -title: TspData -description: API reference for qiskit.optimization.applications.ising.tsp.TspData +title: tsp +description: API reference for qiskit.optimization.applications.ising.tsp in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.optimization.applications.ising.tsp.TspData +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.tsp --- diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vehicle_routing.md index 41417b86a6a..cb9da8e8f25 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vehicle_routing.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.vehicle_routing.get_operator +title: vehicle_routing +description: API reference for qiskit.optimization.applications.ising.vehicle_routing in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.vehicle_routing.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vehicle_routing --- @@ -72,7 +72,7 @@ objective function value. `get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") -## Constructs auxiliary matrices from a vehicle routing instance, +**Constructs auxiliary matrices from a vehicle routing instance,** which represent the encoding into a binary quadratic program. This is used in the construction of the qubit ops and computation of the solution cost. @@ -96,7 +96,7 @@ a matrix defining the interactions between variables. a matrix defining the cont `get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") -## Tries to obtain a feasible solution (in vector form) of an instance +**Tries to obtain a feasible solution (in vector form) of an instance** of vehicle routing from the results dictionary. @@ -115,7 +115,7 @@ of vehicle routing from the results dictionary. a solution, i.e., a path, in its binary representation. -## #TODO: support statevector simulation, results should be a statevector or counts format, not +**#TODO: support statevector simulation, results should be a statevector or counts format, not** a result from algorithm run diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vertex_cover.md index 50658b90390..5ed46e10885 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.vertex_cover.md @@ -1,9 +1,9 @@ --- -title: check_full_edge_coverage -description: API reference for qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage +title: vertex_cover +description: API reference for qiskit.optimization.applications.ising.vertex_cover in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vertex_cover --- diff --git a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.md index 09d5818787d..6c7f191ac51 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.25/qiskit.providers.ibmq.IBMQBackend.md @@ -457,7 +457,7 @@ If a keyword specified here is also present in the `options` attribute/object, t * **meas\_lo\_freq** (`Optional`\[`List`\[`int`]]) – List of default measurement LO frequencies in Hz. Will be overridden by `schedule_los` if set. -* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. +* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. * **meas\_level** (`Union`\[`int`, `MeasLevel`, `None`]) – Set the appropriate level of the measurement output for pulse experiments. diff --git a/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.md index 33cf18195d9..cf2ea888aa3 100644 --- a/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.25/qiskit.providers.models.PulseBackendConfiguration.md @@ -144,7 +144,7 @@ Return the acquisition channel for the given qubit. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") **Returns** @@ -169,7 +169,7 @@ Return the secondary drive channel for the given qubit – typically utilized fo **Return type** -`List`\[[`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")] +`List`\[[`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")] **Returns** @@ -199,7 +199,7 @@ backend.configuration().describe(ControlChannel(1)) **Parameters** -**channel** ([`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe. +**channel** ([`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe. **Raises** @@ -207,7 +207,7 @@ backend.configuration().describe(ControlChannel(1)) **Return type** -`Dict`\[[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel"), `complex`] +`Dict`\[[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel"), `complex`] **Returns** @@ -227,7 +227,7 @@ Return the drive channel for the given qubit. **Return type** -[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") +[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel") **Returns** @@ -287,7 +287,7 @@ Return a list of channels which operate on the given `qubit`. **Return type** -`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] **Returns** @@ -307,7 +307,7 @@ Return the measure stimulus channel for the given qubit. **Return type** -[`MeasureChannel`](qiskit.pulse.channels#qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") +[`MeasureChannel`](qiskit.pulse.channels#measurechannel "qiskit.pulse.channels.MeasureChannel") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.25/qiskit.pulse.Acquire.md index 57757191057..72f12354374 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Acquire.md @@ -25,9 +25,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -47,9 +47,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -76,23 +76,23 @@ Create a new Acquire instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`acquire`](#qiskit.pulse.Acquire.acquire "qiskit.pulse.Acquire.acquire") | Acquire channel to acquire data. | -| [`channel`](#qiskit.pulse.Acquire.channel "qiskit.pulse.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Acquire.channels "qiskit.pulse.Acquire.channels") | Returns the channels that this schedule uses. | -| [`discriminator`](#qiskit.pulse.Acquire.discriminator "qiskit.pulse.Acquire.discriminator") | Return discrimination settings. | -| [`duration`](#qiskit.pulse.Acquire.duration "qiskit.pulse.Acquire.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Acquire.id "qiskit.pulse.Acquire.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Acquire.instructions "qiskit.pulse.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | -| [`kernel`](#qiskit.pulse.Acquire.kernel "qiskit.pulse.Acquire.kernel") | Return kernel settings. | -| [`mem_slot`](#qiskit.pulse.Acquire.mem_slot "qiskit.pulse.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | -| [`name`](#qiskit.pulse.Acquire.name "qiskit.pulse.Acquire.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Acquire.operands "qiskit.pulse.Acquire.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Acquire.parameters "qiskit.pulse.Acquire.parameters") | Parameters which determine the instruction behavior. | -| [`reg_slot`](#qiskit.pulse.Acquire.reg_slot "qiskit.pulse.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | -| [`start_time`](#qiskit.pulse.Acquire.start_time "qiskit.pulse.Acquire.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Acquire.stop_time "qiskit.pulse.Acquire.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`acquire`](#qiskit.pulse.Acquire.acquire "qiskit.pulse.Acquire.acquire") | Acquire channel to acquire data. | +| [`channel`](#qiskit.pulse.Acquire.channel "qiskit.pulse.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Acquire.channels "qiskit.pulse.Acquire.channels") | Returns the channels that this schedule uses. | +| [`discriminator`](#qiskit.pulse.Acquire.discriminator "qiskit.pulse.Acquire.discriminator") | Return discrimination settings. | +| [`duration`](#qiskit.pulse.Acquire.duration "qiskit.pulse.Acquire.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Acquire.id "qiskit.pulse.Acquire.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Acquire.instructions "qiskit.pulse.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | +| [`kernel`](#qiskit.pulse.Acquire.kernel "qiskit.pulse.Acquire.kernel") | Return kernel settings. | +| [`mem_slot`](#qiskit.pulse.Acquire.mem_slot "qiskit.pulse.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | +| [`name`](#qiskit.pulse.Acquire.name "qiskit.pulse.Acquire.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Acquire.operands "qiskit.pulse.Acquire.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Acquire.parameters "qiskit.pulse.Acquire.parameters") | Parameters which determine the instruction behavior. | +| [`reg_slot`](#qiskit.pulse.Acquire.reg_slot "qiskit.pulse.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | +| [`start_time`](#qiskit.pulse.Acquire.start_time "qiskit.pulse.Acquire.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Acquire.stop_time "qiskit.pulse.Acquire.stop_time") | Relative end time of this instruction. | ### acquire @@ -104,7 +104,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### append @@ -201,11 +201,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### channels @@ -217,7 +217,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]] +`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]] ### discriminator @@ -252,7 +252,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** @@ -366,7 +366,7 @@ The classical memory slot which will store the classified readout result. **Return type** -[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot") +[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot") ### name @@ -414,7 +414,7 @@ The fast-access register slot which will store the classified readout result for **Return type** -[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot") +[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot") ### shift diff --git a/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.md index a900ecc9ee0..7104f339ff5 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.AcquireChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Call.md b/docs/api/qiskit/0.25/qiskit.pulse.Call.md index a433311a9fc..bdb134c5aec 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Call.md @@ -221,7 +221,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -244,7 +244,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.md index e85fea470d2..5dea4fbfbd8 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.ControlChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Delay.md b/docs/api/qiskit/0.25/qiskit.pulse.Delay.md index 98cd332f9b9..a6331b59ac3 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Delay.md @@ -33,7 +33,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ### \_\_init\_\_ @@ -49,7 +49,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ## Methods @@ -70,18 +70,18 @@ No other instruction may be scheduled within a `Delay`. ## Attributes -| | | -| ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Delay.channel "qiskit.pulse.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Delay.channels "qiskit.pulse.Delay.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Delay.duration "qiskit.pulse.Delay.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Delay.id "qiskit.pulse.Delay.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Delay.instructions "qiskit.pulse.Delay.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.Delay.name "qiskit.pulse.Delay.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Delay.operands "qiskit.pulse.Delay.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Delay.parameters "qiskit.pulse.Delay.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.Delay.start_time "qiskit.pulse.Delay.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Delay.stop_time "qiskit.pulse.Delay.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.Delay.channel "qiskit.pulse.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Delay.channels "qiskit.pulse.Delay.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Delay.duration "qiskit.pulse.Delay.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Delay.id "qiskit.pulse.Delay.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Delay.instructions "qiskit.pulse.Delay.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.Delay.name "qiskit.pulse.Delay.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Delay.operands "qiskit.pulse.Delay.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Delay.parameters "qiskit.pulse.Delay.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.Delay.start_time "qiskit.pulse.Delay.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Delay.stop_time "qiskit.pulse.Delay.stop_time") | Relative end time of this instruction. | ### append @@ -178,11 +178,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") ### channels @@ -194,7 +194,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -217,7 +217,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.md index cdd0f40215b..6e0feba01f1 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.DriveChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.25/qiskit.pulse.Instruction.md index 1fddc089976..2c84e0a3425 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Instruction.md @@ -20,7 +20,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -40,7 +40,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -177,7 +177,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -200,7 +200,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.md index 877cea85d05..9d661b317d8 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.MeasureChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.md index e55293d4ec2..0ef342e2e8e 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.MemorySlot.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Play.md b/docs/api/qiskit/0.25/qiskit.pulse.Play.md index 33bb992a1f1..8291004209c 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Play.md @@ -21,7 +21,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -39,7 +39,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -64,19 +64,19 @@ Create a new pulse instruction. ## Attributes -| | | -| ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Play.channel "qiskit.pulse.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Play.channels "qiskit.pulse.Play.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Play.duration "qiskit.pulse.Play.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Play.id "qiskit.pulse.Play.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Play.instructions "qiskit.pulse.Play.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.Play.name "qiskit.pulse.Play.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Play.operands "qiskit.pulse.Play.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Play.parameters "qiskit.pulse.Play.parameters") | Parameters which determine the instruction behavior. | -| [`pulse`](#qiskit.pulse.Play.pulse "qiskit.pulse.Play.pulse") | A description of the samples that will be played. | -| [`start_time`](#qiskit.pulse.Play.start_time "qiskit.pulse.Play.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Play.stop_time "qiskit.pulse.Play.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.Play.channel "qiskit.pulse.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Play.channels "qiskit.pulse.Play.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Play.duration "qiskit.pulse.Play.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Play.id "qiskit.pulse.Play.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Play.instructions "qiskit.pulse.Play.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.Play.name "qiskit.pulse.Play.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Play.operands "qiskit.pulse.Play.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Play.parameters "qiskit.pulse.Play.parameters") | Parameters which determine the instruction behavior. | +| [`pulse`](#qiskit.pulse.Play.pulse "qiskit.pulse.Play.pulse") | A description of the samples that will be played. | +| [`start_time`](#qiskit.pulse.Play.start_time "qiskit.pulse.Play.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Play.stop_time "qiskit.pulse.Play.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.md index 1eb46da4a4f..7a8e1fca2fa 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.RegisterSlot.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.25/qiskit.pulse.Schedule.md index 9ea2dd3651f..9b92cfab1ab 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Schedule.md @@ -221,7 +221,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -241,7 +241,7 @@ Plot the schedule. * **time\_unit** (`str`) – The unit of specified time range either dt or ns. The unit of ns is available only when backend object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. @@ -324,7 +324,7 @@ self.filter(args) | self.exclude(args) == self **Parameters** * **filter\_funcs** (`Callable`) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -347,7 +347,7 @@ If no arguments are provided, `self` is returned. **Parameters** * **filter\_funcs** (`Callable`) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -585,5 +585,5 @@ Time keeping attribute. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.md index a22dd073c4a..5164eaef864 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.ScheduleBlock.md @@ -237,7 +237,7 @@ Returns channels that this schedule clock uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -257,7 +257,7 @@ Plot the schedule. * **time\_unit** (`str`) – The unit of specified time range either dt or ns. The unit of ns is available only when backend object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. @@ -344,7 +344,7 @@ self.filter(args) | self.exclude(args) == self **Parameters** * **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -375,7 +375,7 @@ If no arguments are provided, `self` is returned. **Parameters** * **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -586,5 +586,5 @@ Time keeping attribute. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] diff --git a/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.md index e0ebe7c915f..3df4a86fda5 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.SetFrequency.md @@ -27,7 +27,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -62,19 +62,19 @@ Creates a new set channel frequency instruction. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.SetFrequency.channel "qiskit.pulse.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.SetFrequency.channels "qiskit.pulse.SetFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.SetFrequency.duration "qiskit.pulse.SetFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.SetFrequency.frequency "qiskit.pulse.SetFrequency.frequency") | New frequency. | -| [`id`](#qiskit.pulse.SetFrequency.id "qiskit.pulse.SetFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.SetFrequency.instructions "qiskit.pulse.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.SetFrequency.name "qiskit.pulse.SetFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.SetFrequency.operands "qiskit.pulse.SetFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.SetFrequency.parameters "qiskit.pulse.SetFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.SetFrequency.start_time "qiskit.pulse.SetFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.SetFrequency.stop_time "qiskit.pulse.SetFrequency.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.SetFrequency.channel "qiskit.pulse.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.SetFrequency.channels "qiskit.pulse.SetFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.SetFrequency.duration "qiskit.pulse.SetFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.SetFrequency.frequency "qiskit.pulse.SetFrequency.frequency") | New frequency. | +| [`id`](#qiskit.pulse.SetFrequency.id "qiskit.pulse.SetFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.SetFrequency.instructions "qiskit.pulse.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.SetFrequency.name "qiskit.pulse.SetFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.SetFrequency.operands "qiskit.pulse.SetFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.SetFrequency.parameters "qiskit.pulse.SetFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.SetFrequency.start_time "qiskit.pulse.SetFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.SetFrequency.stop_time "qiskit.pulse.SetFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.md index 3803f04c4e7..1aceeec1749 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.SetPhase.md @@ -27,7 +27,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -62,19 +62,19 @@ Instantiate a set phase instruction, setting the output signal phase on `channel ## Attributes -| | | -| ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.SetPhase.channel "qiskit.pulse.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.SetPhase.channels "qiskit.pulse.SetPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.SetPhase.duration "qiskit.pulse.SetPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.SetPhase.id "qiskit.pulse.SetPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.SetPhase.instructions "qiskit.pulse.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.SetPhase.name "qiskit.pulse.SetPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.SetPhase.operands "qiskit.pulse.SetPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.SetPhase.parameters "qiskit.pulse.SetPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.SetPhase.phase "qiskit.pulse.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.SetPhase.start_time "qiskit.pulse.SetPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.SetPhase.stop_time "qiskit.pulse.SetPhase.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.SetPhase.channel "qiskit.pulse.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.SetPhase.channels "qiskit.pulse.SetPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.SetPhase.duration "qiskit.pulse.SetPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.SetPhase.id "qiskit.pulse.SetPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.SetPhase.instructions "qiskit.pulse.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.SetPhase.name "qiskit.pulse.SetPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.SetPhase.operands "qiskit.pulse.SetPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.SetPhase.parameters "qiskit.pulse.SetPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.SetPhase.phase "qiskit.pulse.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.SetPhase.start_time "qiskit.pulse.SetPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.SetPhase.stop_time "qiskit.pulse.SetPhase.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.md index 9ca7e8efe13..33c38b6d65b 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.ShiftFrequency.md @@ -19,7 +19,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -33,7 +33,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -54,19 +54,19 @@ Creates a new shift frequency instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.ShiftFrequency.channel "qiskit.pulse.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.ShiftFrequency.channels "qiskit.pulse.ShiftFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.ShiftFrequency.duration "qiskit.pulse.ShiftFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.ShiftFrequency.frequency "qiskit.pulse.ShiftFrequency.frequency") | Frequency shift from the set frequency. | -| [`id`](#qiskit.pulse.ShiftFrequency.id "qiskit.pulse.ShiftFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.ShiftFrequency.instructions "qiskit.pulse.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.ShiftFrequency.name "qiskit.pulse.ShiftFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.ShiftFrequency.operands "qiskit.pulse.ShiftFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.ShiftFrequency.parameters "qiskit.pulse.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.ShiftFrequency.start_time "qiskit.pulse.ShiftFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.ShiftFrequency.stop_time "qiskit.pulse.ShiftFrequency.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.ShiftFrequency.channel "qiskit.pulse.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.ShiftFrequency.channels "qiskit.pulse.ShiftFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.ShiftFrequency.duration "qiskit.pulse.ShiftFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.ShiftFrequency.frequency "qiskit.pulse.ShiftFrequency.frequency") | Frequency shift from the set frequency. | +| [`id`](#qiskit.pulse.ShiftFrequency.id "qiskit.pulse.ShiftFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.ShiftFrequency.instructions "qiskit.pulse.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.ShiftFrequency.name "qiskit.pulse.ShiftFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.ShiftFrequency.operands "qiskit.pulse.ShiftFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.ShiftFrequency.parameters "qiskit.pulse.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.ShiftFrequency.start_time "qiskit.pulse.ShiftFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.ShiftFrequency.stop_time "qiskit.pulse.ShiftFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -163,11 +163,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -179,7 +179,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -202,7 +202,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.md index 91fd767940e..8cb59125556 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.ShiftPhase `ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") -The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. +The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -29,7 +29,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -43,7 +43,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -64,19 +64,19 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch ## Attributes -| | | -| ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.ShiftPhase.channel "qiskit.pulse.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.ShiftPhase.channels "qiskit.pulse.ShiftPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.ShiftPhase.duration "qiskit.pulse.ShiftPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.ShiftPhase.id "qiskit.pulse.ShiftPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.ShiftPhase.instructions "qiskit.pulse.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.ShiftPhase.name "qiskit.pulse.ShiftPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.ShiftPhase.operands "qiskit.pulse.ShiftPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.ShiftPhase.parameters "qiskit.pulse.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.ShiftPhase.phase "qiskit.pulse.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.ShiftPhase.start_time "qiskit.pulse.ShiftPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.ShiftPhase.stop_time "qiskit.pulse.ShiftPhase.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.ShiftPhase.channel "qiskit.pulse.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.ShiftPhase.channels "qiskit.pulse.ShiftPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.ShiftPhase.duration "qiskit.pulse.ShiftPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.ShiftPhase.id "qiskit.pulse.ShiftPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.ShiftPhase.instructions "qiskit.pulse.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.ShiftPhase.name "qiskit.pulse.ShiftPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.ShiftPhase.operands "qiskit.pulse.ShiftPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.ShiftPhase.parameters "qiskit.pulse.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.ShiftPhase.phase "qiskit.pulse.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.ShiftPhase.start_time "qiskit.pulse.ShiftPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.ShiftPhase.stop_time "qiskit.pulse.ShiftPhase.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.md index 774df87cbeb..a94951dbe72 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.Snapshot.md @@ -62,20 +62,20 @@ Create new snapshot. ## Attributes -| | | -| ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Snapshot.channel "qiskit.pulse.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | -| [`channels`](#qiskit.pulse.Snapshot.channels "qiskit.pulse.Snapshot.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Snapshot.duration "qiskit.pulse.Snapshot.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Snapshot.id "qiskit.pulse.Snapshot.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Snapshot.instructions "qiskit.pulse.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | -| [`label`](#qiskit.pulse.Snapshot.label "qiskit.pulse.Snapshot.label") | Label of snapshot. | -| [`name`](#qiskit.pulse.Snapshot.name "qiskit.pulse.Snapshot.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Snapshot.operands "qiskit.pulse.Snapshot.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Snapshot.parameters "qiskit.pulse.Snapshot.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.Snapshot.start_time "qiskit.pulse.Snapshot.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Snapshot.stop_time "qiskit.pulse.Snapshot.stop_time") | Relative end time of this instruction. | -| [`type`](#qiskit.pulse.Snapshot.type "qiskit.pulse.Snapshot.type") | Type of snapshot. | +| | | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`channel`](#qiskit.pulse.Snapshot.channel "qiskit.pulse.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | +| [`channels`](#qiskit.pulse.Snapshot.channels "qiskit.pulse.Snapshot.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Snapshot.duration "qiskit.pulse.Snapshot.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Snapshot.id "qiskit.pulse.Snapshot.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Snapshot.instructions "qiskit.pulse.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | +| [`label`](#qiskit.pulse.Snapshot.label "qiskit.pulse.Snapshot.label") | Label of snapshot. | +| [`name`](#qiskit.pulse.Snapshot.name "qiskit.pulse.Snapshot.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Snapshot.operands "qiskit.pulse.Snapshot.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Snapshot.parameters "qiskit.pulse.Snapshot.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.Snapshot.start_time "qiskit.pulse.Snapshot.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Snapshot.stop_time "qiskit.pulse.Snapshot.stop_time") | Relative end time of this instruction. | +| [`type`](#qiskit.pulse.Snapshot.type "qiskit.pulse.Snapshot.type") | Type of snapshot. | ### append @@ -172,11 +172,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** -[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel") +[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel") ### channels @@ -188,7 +188,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel")] +`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel")] ### draw @@ -211,7 +211,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire.md index c29a43a028c..ba6fd3cb433 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire.md @@ -37,8 +37,8 @@ with pulse.build() as pulse_prog: **Parameters** * **duration** (`int`) – Duration to acquire data for -* **qubit\_or\_channel** (`Union`\[`int`, [`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")]) – Either the qubit to acquire data for or the specific [`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") to acquire on. -* **register** (`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])) – Location to store measured result. +* **qubit\_or\_channel** (`Union`\[`int`, [`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")]) – Either the qubit to acquire data for or the specific [`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") to acquire on. +* **register** (`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])) – Location to store measured result. * **metadata** (`Union`\[`Kernel`, `Discriminator`]) – Additional metadata for measurement. See [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire") for more information. **Raises** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire_channel.md index 9d89d34e805..d5543331cb8 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.acquire_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.barrier.md index d601ffe8ea5..3a7c88ca5df 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.barrier.md @@ -70,6 +70,6 @@ with pulse.build(backend) as pulse_prog: **Parameters** -* **channels\_or\_qubits** (`Union`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `int`]) – Channels or qubits to barrier. +* **channels\_or\_qubits** (`Union`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `int`]) – Channels or qubits to barrier. * **name** (`Optional`\[`str`]) – Name for the barrier diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.control_channels.md index 03fd5fd8895..fbe9d517782 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.control_channels.md @@ -37,7 +37,7 @@ with pulse.build(backend): **Return type** -`List`\[[`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")] +`List`\[[`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")] **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.delay.md index 5fc92f807ea..4f61e2869d0 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.delay.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **duration** (`int`) – Number of cycles to delay for on `channel`. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Channel to delay on. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – Channel to delay on. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.drive_channel.md index 5f9a92776f2..830b1f50e7a 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.drive_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") +[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel") diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.frequency_offset.md index e4baa1c0066..d3f825feb9f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.frequency_offset.md @@ -41,7 +41,7 @@ assert len(pulse_prog.instructions) == 4 **Parameters** * **frequency** (`float`) – Amount of frequency offset in Hz. -* **channels** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset frequency of. +* **channels** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset frequency of. * **compensate\_phase** (`bool`) – Compensate for accumulated phase accumulated with respect to the channels’ frame at its initial frequency. **Yields** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure.md index 91d347215d2..d172ff13c74 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure.md @@ -53,11 +53,11 @@ assert reg == mem0 **Parameters** * **qubits** (`Union`\[`List`\[`int`], `int`]) – Physical qubit to measure. -* **registers** (`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]), `None`]) – Register to store result in. If not selected the current behavior is to return the `MemorySlot` with the same index as `qubit`. This register will be returned. +* **registers** (`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]), `None`]) – Register to store result in. If not selected the current behavior is to return the `MemorySlot` with the same index as `qubit`. This register will be returned. **Return type** -`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])] +`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])] **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_all.md index d7bacde24b2..1d3bf31c2ad 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_all.md @@ -35,7 +35,7 @@ with pulse.build(backend) as pulse_prog: **Return type** -`List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")] +`List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")] **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_channel.md index 03feb981bff..3d2b1732509 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.measure_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`MeasureChannel`](qiskit.pulse.channels#qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") +[`MeasureChannel`](qiskit.pulse.channels#measurechannel "qiskit.pulse.channels.MeasureChannel") diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.pad.md index e7ff49c34b5..1a6ad5573bb 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.pad.md @@ -16,7 +16,7 @@ Pad all available timeslots with delays upon exiting context. **Parameters** -**chs** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Channels to pad with delays. Defaults to all channels in context if none are supplied. +**chs** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – Channels to pad with delays. Defaults to all channels in context if none are supplied. Examples: diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.phase_offset.md index 48b85c83ebc..772a71d232c 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.phase_offset.md @@ -33,7 +33,7 @@ assert len(pulse_prog.instructions) == 3 **Parameters** * **phase** (`float`) – Amount of phase offset in radians. -* **channels** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset phase of. +* **channels** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset phase of. **Yields** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.play.md index 94396e1bca5..a842a673bc8 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.play.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **pulse** (`Union`\[`Pulse`, `ndarray`]) – Pulse to play. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to play pulse on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to play pulse on. * **name** (`Optional`\[`str`]) – Name of the pulse. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.qubit_channels.md index a22d0750631..5ca23c2585a 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.qubit_channels.md @@ -40,5 +40,5 @@ with pulse.build(backend): **Return type** -`Set`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Set`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.set_frequency.md index 08dbcd50786..87e5b588b7b 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.set_frequency.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **frequency** (`float`) – Frequency in Hz to set channel to. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to set frequency of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to set frequency of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.set_phase.md index 924cc0ee7a9..c85e44c392f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.set_phase.md @@ -30,6 +30,6 @@ with pulse.build() as pulse_prog: **Parameters** * **phase** (`float`) – Phase in radians to set channel carrier signal to. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to set phase of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to set phase of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_frequency.md index b610ae51305..58142ca9fbb 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_frequency.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **frequency** (`float`) – Frequency in Hz to shift channel frequency by. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift frequency of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift frequency of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_phase.md index cb338fff15d..96eb4a67d7d 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.builder.shift_phase.md @@ -30,6 +30,6 @@ with pulse.build() as pulse_prog: **Parameters** * **phase** (`float`) – Phase in radians to shift channel carrier signal by. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift phase of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift phase of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.25/qiskit.pulse.channels.md b/docs/api/qiskit/0.25/qiskit.pulse.channels.md index 93f83d00605..e5222160a22 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.channels.md @@ -1,9 +1,9 @@ --- -title: AcquireChannel -description: API reference for qiskit.pulse.channels.AcquireChannel +title: channels +description: API reference for qiskit.pulse.channels in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.pulse.channels.AcquireChannel +python_api_type: module +python_api_name: qiskit.pulse.channels --- diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.md index ab1cc02b484..11fdb9167e5 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Acquire.md @@ -25,9 +25,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -47,9 +47,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -76,23 +76,23 @@ Create a new Acquire instruction. ## Attributes -| | | -| --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`acquire`](#qiskit.pulse.instructions.Acquire.acquire "qiskit.pulse.instructions.Acquire.acquire") | Acquire channel to acquire data. | -| [`channel`](#qiskit.pulse.instructions.Acquire.channel "qiskit.pulse.instructions.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Acquire.channels "qiskit.pulse.instructions.Acquire.channels") | Returns the channels that this schedule uses. | -| [`discriminator`](#qiskit.pulse.instructions.Acquire.discriminator "qiskit.pulse.instructions.Acquire.discriminator") | Return discrimination settings. | -| [`duration`](#qiskit.pulse.instructions.Acquire.duration "qiskit.pulse.instructions.Acquire.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Acquire.id "qiskit.pulse.instructions.Acquire.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Acquire.instructions "qiskit.pulse.instructions.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | -| [`kernel`](#qiskit.pulse.instructions.Acquire.kernel "qiskit.pulse.instructions.Acquire.kernel") | Return kernel settings. | -| [`mem_slot`](#qiskit.pulse.instructions.Acquire.mem_slot "qiskit.pulse.instructions.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | -| [`name`](#qiskit.pulse.instructions.Acquire.name "qiskit.pulse.instructions.Acquire.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Acquire.operands "qiskit.pulse.instructions.Acquire.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Acquire.parameters "qiskit.pulse.instructions.Acquire.parameters") | Parameters which determine the instruction behavior. | -| [`reg_slot`](#qiskit.pulse.instructions.Acquire.reg_slot "qiskit.pulse.instructions.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | -| [`start_time`](#qiskit.pulse.instructions.Acquire.start_time "qiskit.pulse.instructions.Acquire.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Acquire.stop_time "qiskit.pulse.instructions.Acquire.stop_time") | Relative end time of this instruction. | +| | | +| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`acquire`](#qiskit.pulse.instructions.Acquire.acquire "qiskit.pulse.instructions.Acquire.acquire") | Acquire channel to acquire data. | +| [`channel`](#qiskit.pulse.instructions.Acquire.channel "qiskit.pulse.instructions.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Acquire.channels "qiskit.pulse.instructions.Acquire.channels") | Returns the channels that this schedule uses. | +| [`discriminator`](#qiskit.pulse.instructions.Acquire.discriminator "qiskit.pulse.instructions.Acquire.discriminator") | Return discrimination settings. | +| [`duration`](#qiskit.pulse.instructions.Acquire.duration "qiskit.pulse.instructions.Acquire.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Acquire.id "qiskit.pulse.instructions.Acquire.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Acquire.instructions "qiskit.pulse.instructions.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | +| [`kernel`](#qiskit.pulse.instructions.Acquire.kernel "qiskit.pulse.instructions.Acquire.kernel") | Return kernel settings. | +| [`mem_slot`](#qiskit.pulse.instructions.Acquire.mem_slot "qiskit.pulse.instructions.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | +| [`name`](#qiskit.pulse.instructions.Acquire.name "qiskit.pulse.instructions.Acquire.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Acquire.operands "qiskit.pulse.instructions.Acquire.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Acquire.parameters "qiskit.pulse.instructions.Acquire.parameters") | Parameters which determine the instruction behavior. | +| [`reg_slot`](#qiskit.pulse.instructions.Acquire.reg_slot "qiskit.pulse.instructions.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | +| [`start_time`](#qiskit.pulse.instructions.Acquire.start_time "qiskit.pulse.instructions.Acquire.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Acquire.stop_time "qiskit.pulse.instructions.Acquire.stop_time") | Relative end time of this instruction. | ### acquire @@ -104,7 +104,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### append @@ -201,11 +201,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### channels @@ -217,7 +217,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]] +`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]] ### discriminator @@ -252,7 +252,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** @@ -366,7 +366,7 @@ The classical memory slot which will store the classified readout result. **Return type** -[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot") +[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot") ### name @@ -414,7 +414,7 @@ The fast-access register slot which will store the classified readout result for **Return type** -[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot") +[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot") ### shift diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.md index cdf733b6523..44d242dbb6f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Call.md @@ -221,7 +221,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -244,7 +244,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.md index 397c443c0d6..dabc5660778 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Delay.md @@ -33,7 +33,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ### \_\_init\_\_ @@ -49,7 +49,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ## Methods @@ -70,18 +70,18 @@ No other instruction may be scheduled within a `Delay`. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Delay.channel "qiskit.pulse.instructions.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Delay.channels "qiskit.pulse.instructions.Delay.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Delay.duration "qiskit.pulse.instructions.Delay.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Delay.id "qiskit.pulse.instructions.Delay.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Delay.instructions "qiskit.pulse.instructions.Delay.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.Delay.name "qiskit.pulse.instructions.Delay.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Delay.operands "qiskit.pulse.instructions.Delay.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Delay.parameters "qiskit.pulse.instructions.Delay.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.Delay.start_time "qiskit.pulse.instructions.Delay.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Delay.stop_time "qiskit.pulse.instructions.Delay.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.Delay.channel "qiskit.pulse.instructions.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Delay.channels "qiskit.pulse.instructions.Delay.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Delay.duration "qiskit.pulse.instructions.Delay.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Delay.id "qiskit.pulse.instructions.Delay.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Delay.instructions "qiskit.pulse.instructions.Delay.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.Delay.name "qiskit.pulse.instructions.Delay.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Delay.operands "qiskit.pulse.instructions.Delay.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Delay.parameters "qiskit.pulse.instructions.Delay.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.Delay.start_time "qiskit.pulse.instructions.Delay.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Delay.stop_time "qiskit.pulse.instructions.Delay.stop_time") | Relative end time of this instruction. | ### append @@ -178,11 +178,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") ### channels @@ -194,7 +194,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -217,7 +217,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.md index 988d6be55db..7cb7777c5d9 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Instruction.md @@ -20,7 +20,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -40,7 +40,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -177,7 +177,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -200,7 +200,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.md index 2b28e0252df..dd53254d1da 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Play.md @@ -21,7 +21,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -39,7 +39,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -64,19 +64,19 @@ Create a new pulse instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Play.channel "qiskit.pulse.instructions.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Play.channels "qiskit.pulse.instructions.Play.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Play.duration "qiskit.pulse.instructions.Play.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Play.id "qiskit.pulse.instructions.Play.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Play.instructions "qiskit.pulse.instructions.Play.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.Play.name "qiskit.pulse.instructions.Play.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Play.operands "qiskit.pulse.instructions.Play.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Play.parameters "qiskit.pulse.instructions.Play.parameters") | Parameters which determine the instruction behavior. | -| [`pulse`](#qiskit.pulse.instructions.Play.pulse "qiskit.pulse.instructions.Play.pulse") | A description of the samples that will be played. | -| [`start_time`](#qiskit.pulse.instructions.Play.start_time "qiskit.pulse.instructions.Play.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Play.stop_time "qiskit.pulse.instructions.Play.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.Play.channel "qiskit.pulse.instructions.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Play.channels "qiskit.pulse.instructions.Play.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Play.duration "qiskit.pulse.instructions.Play.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Play.id "qiskit.pulse.instructions.Play.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Play.instructions "qiskit.pulse.instructions.Play.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.Play.name "qiskit.pulse.instructions.Play.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Play.operands "qiskit.pulse.instructions.Play.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Play.parameters "qiskit.pulse.instructions.Play.parameters") | Parameters which determine the instruction behavior. | +| [`pulse`](#qiskit.pulse.instructions.Play.pulse "qiskit.pulse.instructions.Play.pulse") | A description of the samples that will be played. | +| [`start_time`](#qiskit.pulse.instructions.Play.start_time "qiskit.pulse.instructions.Play.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Play.stop_time "qiskit.pulse.instructions.Play.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.md index 3e8f871f787..fe562941083 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetFrequency.md @@ -27,7 +27,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -62,19 +62,19 @@ Creates a new set channel frequency instruction. ## Attributes -| | | -| ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.SetFrequency.channel "qiskit.pulse.instructions.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.SetFrequency.channels "qiskit.pulse.instructions.SetFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.SetFrequency.duration "qiskit.pulse.instructions.SetFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.instructions.SetFrequency.frequency "qiskit.pulse.instructions.SetFrequency.frequency") | New frequency. | -| [`id`](#qiskit.pulse.instructions.SetFrequency.id "qiskit.pulse.instructions.SetFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.SetFrequency.instructions "qiskit.pulse.instructions.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.SetFrequency.name "qiskit.pulse.instructions.SetFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.SetFrequency.operands "qiskit.pulse.instructions.SetFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.SetFrequency.parameters "qiskit.pulse.instructions.SetFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.SetFrequency.start_time "qiskit.pulse.instructions.SetFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.SetFrequency.stop_time "qiskit.pulse.instructions.SetFrequency.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.SetFrequency.channel "qiskit.pulse.instructions.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.SetFrequency.channels "qiskit.pulse.instructions.SetFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.SetFrequency.duration "qiskit.pulse.instructions.SetFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.instructions.SetFrequency.frequency "qiskit.pulse.instructions.SetFrequency.frequency") | New frequency. | +| [`id`](#qiskit.pulse.instructions.SetFrequency.id "qiskit.pulse.instructions.SetFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.SetFrequency.instructions "qiskit.pulse.instructions.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.SetFrequency.name "qiskit.pulse.instructions.SetFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.SetFrequency.operands "qiskit.pulse.instructions.SetFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.SetFrequency.parameters "qiskit.pulse.instructions.SetFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.SetFrequency.start_time "qiskit.pulse.instructions.SetFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.SetFrequency.stop_time "qiskit.pulse.instructions.SetFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.md index 17d4a27e86f..5a9fdb8ecc8 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.SetPhase.md @@ -27,7 +27,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -62,19 +62,19 @@ Instantiate a set phase instruction, setting the output signal phase on `channel ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.SetPhase.channel "qiskit.pulse.instructions.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.SetPhase.channels "qiskit.pulse.instructions.SetPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.SetPhase.duration "qiskit.pulse.instructions.SetPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.SetPhase.id "qiskit.pulse.instructions.SetPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.SetPhase.instructions "qiskit.pulse.instructions.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.SetPhase.name "qiskit.pulse.instructions.SetPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.SetPhase.operands "qiskit.pulse.instructions.SetPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.SetPhase.parameters "qiskit.pulse.instructions.SetPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.instructions.SetPhase.phase "qiskit.pulse.instructions.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.instructions.SetPhase.start_time "qiskit.pulse.instructions.SetPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.SetPhase.stop_time "qiskit.pulse.instructions.SetPhase.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.SetPhase.channel "qiskit.pulse.instructions.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.SetPhase.channels "qiskit.pulse.instructions.SetPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.SetPhase.duration "qiskit.pulse.instructions.SetPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.SetPhase.id "qiskit.pulse.instructions.SetPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.SetPhase.instructions "qiskit.pulse.instructions.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.SetPhase.name "qiskit.pulse.instructions.SetPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.SetPhase.operands "qiskit.pulse.instructions.SetPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.SetPhase.parameters "qiskit.pulse.instructions.SetPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.instructions.SetPhase.phase "qiskit.pulse.instructions.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.instructions.SetPhase.start_time "qiskit.pulse.instructions.SetPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.SetPhase.stop_time "qiskit.pulse.instructions.SetPhase.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.md index 33d44d93c0b..c1068485c86 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftFrequency.md @@ -19,7 +19,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -33,7 +33,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -54,19 +54,19 @@ Creates a new shift frequency instruction. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.ShiftFrequency.channel "qiskit.pulse.instructions.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.ShiftFrequency.channels "qiskit.pulse.instructions.ShiftFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.ShiftFrequency.duration "qiskit.pulse.instructions.ShiftFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.instructions.ShiftFrequency.frequency "qiskit.pulse.instructions.ShiftFrequency.frequency") | Frequency shift from the set frequency. | -| [`id`](#qiskit.pulse.instructions.ShiftFrequency.id "qiskit.pulse.instructions.ShiftFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.ShiftFrequency.instructions "qiskit.pulse.instructions.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.ShiftFrequency.name "qiskit.pulse.instructions.ShiftFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.ShiftFrequency.operands "qiskit.pulse.instructions.ShiftFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.ShiftFrequency.parameters "qiskit.pulse.instructions.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.ShiftFrequency.start_time "qiskit.pulse.instructions.ShiftFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.ShiftFrequency.stop_time "qiskit.pulse.instructions.ShiftFrequency.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.ShiftFrequency.channel "qiskit.pulse.instructions.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.ShiftFrequency.channels "qiskit.pulse.instructions.ShiftFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.ShiftFrequency.duration "qiskit.pulse.instructions.ShiftFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.instructions.ShiftFrequency.frequency "qiskit.pulse.instructions.ShiftFrequency.frequency") | Frequency shift from the set frequency. | +| [`id`](#qiskit.pulse.instructions.ShiftFrequency.id "qiskit.pulse.instructions.ShiftFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.ShiftFrequency.instructions "qiskit.pulse.instructions.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.ShiftFrequency.name "qiskit.pulse.instructions.ShiftFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.ShiftFrequency.operands "qiskit.pulse.instructions.ShiftFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.ShiftFrequency.parameters "qiskit.pulse.instructions.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.ShiftFrequency.start_time "qiskit.pulse.instructions.ShiftFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.ShiftFrequency.stop_time "qiskit.pulse.instructions.ShiftFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -163,11 +163,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -179,7 +179,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -202,7 +202,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.md index 13dd0abcc7e..b45bb0b93df 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase `ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") -The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. +The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -29,7 +29,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -43,7 +43,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -64,19 +64,19 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.ShiftPhase.channel "qiskit.pulse.instructions.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.ShiftPhase.channels "qiskit.pulse.instructions.ShiftPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.ShiftPhase.duration "qiskit.pulse.instructions.ShiftPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.ShiftPhase.id "qiskit.pulse.instructions.ShiftPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.ShiftPhase.instructions "qiskit.pulse.instructions.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.ShiftPhase.name "qiskit.pulse.instructions.ShiftPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.ShiftPhase.operands "qiskit.pulse.instructions.ShiftPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.ShiftPhase.parameters "qiskit.pulse.instructions.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.instructions.ShiftPhase.phase "qiskit.pulse.instructions.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.instructions.ShiftPhase.start_time "qiskit.pulse.instructions.ShiftPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.ShiftPhase.stop_time "qiskit.pulse.instructions.ShiftPhase.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.ShiftPhase.channel "qiskit.pulse.instructions.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.ShiftPhase.channels "qiskit.pulse.instructions.ShiftPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.ShiftPhase.duration "qiskit.pulse.instructions.ShiftPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.ShiftPhase.id "qiskit.pulse.instructions.ShiftPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.ShiftPhase.instructions "qiskit.pulse.instructions.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.ShiftPhase.name "qiskit.pulse.instructions.ShiftPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.ShiftPhase.operands "qiskit.pulse.instructions.ShiftPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.ShiftPhase.parameters "qiskit.pulse.instructions.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.instructions.ShiftPhase.phase "qiskit.pulse.instructions.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.instructions.ShiftPhase.start_time "qiskit.pulse.instructions.ShiftPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.ShiftPhase.stop_time "qiskit.pulse.instructions.ShiftPhase.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.md index 0ebe58c1869..12fd63f17a1 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.Snapshot.md @@ -62,20 +62,20 @@ Create new snapshot. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Snapshot.channel "qiskit.pulse.instructions.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | -| [`channels`](#qiskit.pulse.instructions.Snapshot.channels "qiskit.pulse.instructions.Snapshot.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Snapshot.duration "qiskit.pulse.instructions.Snapshot.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Snapshot.id "qiskit.pulse.instructions.Snapshot.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Snapshot.instructions "qiskit.pulse.instructions.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | -| [`label`](#qiskit.pulse.instructions.Snapshot.label "qiskit.pulse.instructions.Snapshot.label") | Label of snapshot. | -| [`name`](#qiskit.pulse.instructions.Snapshot.name "qiskit.pulse.instructions.Snapshot.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Snapshot.operands "qiskit.pulse.instructions.Snapshot.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Snapshot.parameters "qiskit.pulse.instructions.Snapshot.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.Snapshot.start_time "qiskit.pulse.instructions.Snapshot.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Snapshot.stop_time "qiskit.pulse.instructions.Snapshot.stop_time") | Relative end time of this instruction. | -| [`type`](#qiskit.pulse.instructions.Snapshot.type "qiskit.pulse.instructions.Snapshot.type") | Type of snapshot. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`channel`](#qiskit.pulse.instructions.Snapshot.channel "qiskit.pulse.instructions.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | +| [`channels`](#qiskit.pulse.instructions.Snapshot.channels "qiskit.pulse.instructions.Snapshot.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Snapshot.duration "qiskit.pulse.instructions.Snapshot.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Snapshot.id "qiskit.pulse.instructions.Snapshot.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Snapshot.instructions "qiskit.pulse.instructions.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | +| [`label`](#qiskit.pulse.instructions.Snapshot.label "qiskit.pulse.instructions.Snapshot.label") | Label of snapshot. | +| [`name`](#qiskit.pulse.instructions.Snapshot.name "qiskit.pulse.instructions.Snapshot.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Snapshot.operands "qiskit.pulse.instructions.Snapshot.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Snapshot.parameters "qiskit.pulse.instructions.Snapshot.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.Snapshot.start_time "qiskit.pulse.instructions.Snapshot.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Snapshot.stop_time "qiskit.pulse.instructions.Snapshot.stop_time") | Relative end time of this instruction. | +| [`type`](#qiskit.pulse.instructions.Snapshot.type "qiskit.pulse.instructions.Snapshot.type") | Type of snapshot. | ### append @@ -172,11 +172,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** -[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel") +[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel") ### channels @@ -188,7 +188,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel")] +`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel")] ### draw @@ -211,7 +211,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.25/qiskit.pulse.instructions.md b/docs/api/qiskit/0.25/qiskit.pulse.instructions.md index 02154d7c1ba..b3eda3b77e3 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.instructions.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.instructions.md @@ -1,10 +1,18 @@ +--- +title: instructions +description: API reference for qiskit.pulse.instructions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.instructions +--- + # qiskit.pulse.instructions -The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") specifying where the instruction will be applied. +The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") specifying where the instruction will be applied. -Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") `channel`: +Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") `channel`: ```python ShiftPhase(phase, channel) @@ -18,20 +26,21 @@ Delay(duration, channel) An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), which is a sequence of scheduled Pulse `Instruction` s over many channels. `Instruction` s and `Schedule` s implement the same interface. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | -| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | -| [`SetPhase`](qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | -| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | -| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | +| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | +| [`SetPhase`](qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | +| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). | +| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Abstract Classes | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`Instruction`](qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | + diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.25/qiskit.pulse.library.discrete.md index ba50a3e4b5c..0303f3540ad 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.discrete.md @@ -1,9 +1,9 @@ --- -title: constant -description: API reference for qiskit.pulse.library.discrete.constant +title: discrete +description: API reference for qiskit.pulse.library.discrete in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.pulse.library.discrete.constant +python_api_type: module +python_api_name: qiskit.pulse.library.discrete --- diff --git a/docs/api/qiskit/0.25/qiskit.pulse.library.md b/docs/api/qiskit/0.25/qiskit.pulse.library.md index 988f5119861..d449fa5d283 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.library.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.library.md @@ -1,3 +1,11 @@ +--- +title: library +description: API reference for qiskit.pulse.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library +--- + # qiskit.pulse.library @@ -18,3 +26,4 @@ The parametric pulses, [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse. | [`Drag`](qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | | [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | | [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma, width) | A square pulse with a Gaussian shaped risefall on either side: | + diff --git a/docs/api/qiskit/0.25/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.25/qiskit.pulse.transforms.pad.md index 9b7de703646..c895d5da79f 100644 --- a/docs/api/qiskit/0.25/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.25/qiskit.pulse.transforms.pad.md @@ -17,7 +17,7 @@ Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedu **Parameters** * **schedule** (`Schedule`) – Schedule to pad. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Channels to pad. Defaults to all channels in `schedule` if not provided. If the supplied channel is not a member of `schedule` it will be added. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Channels to pad. Defaults to all channels in `schedule` if not provided. If the supplied channel is not a member of `schedule` it will be added. * **until** (`Optional`\[`int`]) – Time to pad until. Defaults to `schedule.duration` if not provided. * **inplace** (`bool`) – Pad this schedule by mutating rather than returning a new schedule. diff --git a/docs/api/qiskit/0.25/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.25/qiskit.scheduler.methods.basic.md index c686aa04f3d..27cd8d0ce83 100644 --- a/docs/api/qiskit/0.25/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.25/qiskit.scheduler.methods.basic.md @@ -1,9 +1,9 @@ --- -title: as_late_as_possible -description: API reference for qiskit.scheduler.methods.basic.as_late_as_possible +title: basic +description: API reference for qiskit.scheduler.methods.basic in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.scheduler.methods.basic.as_late_as_possible +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic --- diff --git a/docs/api/qiskit/0.25/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.25/qiskit.scheduler.schedule_circuit.md index 5c0025e87b0..1b7bc625d39 100644 --- a/docs/api/qiskit/0.25/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.25/qiskit.scheduler.schedule_circuit.md @@ -1,9 +1,9 @@ --- title: schedule_circuit -description: API reference for qiskit.scheduler.schedule_circuit.schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.scheduler.schedule_circuit.schedule_circuit +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit --- diff --git a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.draw.md index c02d9cc714d..540c247eafb 100644 --- a/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.25/qiskit.visualization.pulse_v2.draw.md @@ -26,7 +26,7 @@ Generate visualization data for pulse programs. * **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list is not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list is not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. diff --git a/docs/api/qiskit/0.26/_toc.json b/docs/api/qiskit/0.26/_toc.json index 1120c5401c0..6a1b1c783c5 100644 --- a/docs/api/qiskit/0.26/_toc.json +++ b/docs/api/qiskit/0.26/_toc.json @@ -1740,34 +1740,6 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.26/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.26/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.26/qiskit.circuit.library.Barrier" - }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CCXGate" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.26/qiskit.circuit.ClassicalRegister" @@ -1776,214 +1748,22 @@ "title": "Clbit", "url": "/api/qiskit/0.26/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_8_3" - }, { "title": "ControlledGate", "url": "/api/qiskit/0.26/qiskit.circuit.ControlledGate" }, - { - "title": "CPhaseGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CSwapGate" - }, - { - "title": "CSXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CSXGate" - }, - { - "title": "CU1Gate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CU1Gate" - }, - { - "title": "CU3Gate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CU3Gate" - }, - { - "title": "CUGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CUGate" - }, - { - "title": "CXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CXGate" - }, - { - "title": "CYGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CYGate" - }, - { - "title": "CZGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.CZGate" - }, - { - "title": "DCXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.DCXGate" - }, { "title": "Delay", "url": "/api/qiskit/0.26/qiskit.circuit.Delay" }, - { - "title": "Diagonal", - "url": "/api/qiskit/0.26/qiskit.circuit.library.Diagonal" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.EfficientSU2" - }, { "title": "EquivalenceLibrary", "url": "/api/qiskit/0.26/qiskit.circuit.EquivalenceLibrary" }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.26/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.26/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.26/qiskit.circuit.library.FunctionalPauliRotations" - }, { "title": "Gate", "url": "/api/qiskit/0.26/qiskit.circuit.Gate" }, - { - "title": "GMS", - "url": "/api/qiskit/0.26/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.26/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.26/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.26/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.26/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.26/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.26/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.26/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.26/qiskit.circuit.library.InnerProduct" - }, { "title": "Instruction", "url": "/api/qiskit/0.26/qiskit.circuit.Instruction" @@ -1992,82 +1772,10 @@ "title": "InstructionSet", "url": "/api/qiskit/0.26/qiskit.circuit.InstructionSet" }, - { - "title": "IntegerComparator", - "url": "/api/qiskit/0.26/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.26/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.26/qiskit.circuit.library.LinearAmplitudeFunction" - }, - { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.26/qiskit.circuit.library.LinearPauliRotations" - }, - { - "title": "LogNormalDistribution", - "url": "/api/qiskit/0.26/qiskit.circuit.library.LogNormalDistribution" - }, - { - "title": "MCMT", - "url": "/api/qiskit/0.26/qiskit.circuit.library.MCMT" - }, - { - "title": "MCMTVChain", - "url": "/api/qiskit/0.26/qiskit.circuit.library.MCMTVChain" - }, - { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.MCPhaseGate" - }, - { - "title": "MCXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.MCXGate" - }, - { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.26/qiskit.circuit.library.MCXGrayCode" - }, - { - "title": "MCXRecursive", - "url": "/api/qiskit/0.26/qiskit.circuit.library.MCXRecursive" - }, - { - "title": "MCXVChain", - "url": "/api/qiskit/0.26/qiskit.circuit.library.MCXVChain" - }, { "title": "Measure", "url": "/api/qiskit/0.26/qiskit.circuit.Measure" }, - { - "title": "Measure", - "url": "/api/qiskit/0.26/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.26/qiskit.circuit.library.NLocal" - }, - { - "title": "NormalDistribution", - "url": "/api/qiskit/0.26/qiskit.circuit.library.NormalDistribution" - }, - { - "title": "OR", - "url": "/api/qiskit/0.26/qiskit.circuit.library.OR" - }, { "title": "Parameter", "url": "/api/qiskit/0.26/qiskit.circuit.Parameter" @@ -2080,58 +1788,6 @@ "title": "ParameterVector", "url": "/api/qiskit/0.26/qiskit.circuit.ParameterVector" }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.26/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.26/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.26/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.26/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.26/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.26/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.26/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.26/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.26/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.26/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.26/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.26/qiskit.circuit.library.QuadraticForm" - }, { "title": "QuantumCircuit", "url": "/api/qiskit/0.26/qiskit.circuit.QuantumCircuit" @@ -2140,10 +1796,6 @@ "title": "QuantumRegister", "url": "/api/qiskit/0.26/qiskit.circuit.QuantumRegister" }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.26/qiskit.circuit.library.QuantumVolume" - }, { "title": "Qubit", "url": "/api/qiskit/0.26/qiskit.circuit.Qubit" @@ -2152,376 +1804,733 @@ "title": "random_circuit", "url": "/api/qiskit/0.26/qiskit.circuit.random.random_circuit" }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RealAmplitudes" - }, { "title": "Reset", "url": "/api/qiskit/0.26/qiskit.circuit.Reset" }, { - "title": "Reset", - "url": "/api/qiskit/0.26/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RGate" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.SGate" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_1" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.26/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.26/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.26/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.UGate" - }, - { - "title": "UniformDistribution", - "url": "/api/qiskit/0.26/qiskit.circuit.library.UniformDistribution" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.26/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.26/qiskit.circuit.library.XOR" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.26/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.26/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.26/qiskit.circuit.library.ZZFeatureMap" - }, - { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.26/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.26/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.26/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.26/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CCXGate" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.26/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.26/qiskit.circuit.library.Diagonal" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.26/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.26/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.26/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.26/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.26/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.26/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.26/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.26/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.26/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.26/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.26/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.26/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.26/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.26/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.26/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.26/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "LogNormalDistribution", + "url": "/api/qiskit/0.26/qiskit.circuit.library.LogNormalDistribution" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.26/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.26/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.26/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.26/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.26/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.26/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.26/qiskit.circuit.library.NLocal" + }, + { + "title": "NormalDistribution", + "url": "/api/qiskit/0.26/qiskit.circuit.library.NormalDistribution" + }, + { + "title": "OR", + "url": "/api/qiskit/0.26/qiskit.circuit.library.OR" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.26/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.26/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.26/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.26/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.26/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.26/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.26/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.26/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.26/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.26/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.26/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.26/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.26/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.26/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RGate" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.26/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.SGate" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.26/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "SwapGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.SwapGate" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "SXdgGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.SXdgGate" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "SXGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.SXGate" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.26/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "TdgGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.26/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.26/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.U2Gate" + }, + { + "title": "U3Gate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.U3Gate" + }, + { + "title": "UGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.UGate" + }, + { + "title": "UniformDistribution", + "url": "/api/qiskit/0.26/qiskit.circuit.library.UniformDistribution" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.26/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.26/qiskit.circuit.library.XOR" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.26/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.26/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.26/qiskit.circuit.library.ZZFeatureMap" } ] } @@ -2681,11 +2690,11 @@ "url": "/api/qiskit/0.26/qiskit.finance.applications.ising" }, { - "title": "get_operator", + "title": "qiskit.finance.applications.ising.portfolio", "url": "/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio" }, { - "title": "get_operator", + "title": "qiskit.finance.applications.ising.portfolio_diversification", "url": "/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio_diversification" } ] @@ -3123,6 +3132,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.26/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.26/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.26/qiskit.ignis.verification.QOTP" @@ -3645,56 +3658,56 @@ "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising" }, { - "title": "check_disjoint", - "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.set_packing" + "title": "qiskit.optimization.applications.ising.clique", + "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.clique" }, { - "title": "check_full_edge_coverage", - "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.vertex_cover" + "title": "qiskit.optimization.applications.ising.common", + "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.common" }, { - "title": "check_solution_satisfiability", - "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.exact_cover" + "title": "qiskit.optimization.applications.ising.docplex", + "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.docplex" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.clique" + "title": "qiskit.optimization.applications.ising.exact_cover", + "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.exact_cover" }, { - "title": "get_graph_solution", + "title": "qiskit.optimization.applications.ising.graph_partition", "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.graph_partition" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.max_cut" + "title": "qiskit.optimization.applications.ising.knapsack", + "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.knapsack" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.stable_set" + "title": "qiskit.optimization.applications.ising.max_cut", + "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.max_cut" }, { - "title": "get_gset_result", - "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.common" + "title": "qiskit.optimization.applications.ising.partition", + "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.partition" }, { - "title": "get_operator", - "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.docplex" + "title": "qiskit.optimization.applications.ising.set_packing", + "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.set_packing" }, { - "title": "get_operator", - "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.knapsack" + "title": "qiskit.optimization.applications.ising.stable_set", + "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.stable_set" }, { - "title": "get_operator", - "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.partition" + "title": "qiskit.optimization.applications.ising.tsp", + "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp" }, { - "title": "get_operator", + "title": "qiskit.optimization.applications.ising.vehicle_routing", "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.vehicle_routing" }, { - "title": "TspData", - "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp" + "title": "qiskit.optimization.applications.ising.vertex_cover", + "url": "/api/qiskit/0.26/qiskit.optimization.applications.ising.vertex_cover" } ] } @@ -4620,10 +4633,6 @@ "title": "acquire", "url": "/api/qiskit/0.26/qiskit.pulse.builder.acquire" }, - { - "title": "Acquire", - "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Acquire" - }, { "title": "acquire_channel", "url": "/api/qiskit/0.26/qiskit.pulse.builder.acquire_channel" @@ -4632,10 +4641,6 @@ "title": "AcquireChannel", "url": "/api/qiskit/0.26/qiskit.pulse.AcquireChannel" }, - { - "title": "AcquireChannel", - "url": "/api/qiskit/0.26/qiskit.pulse.channels" - }, { "title": "active_backend", "url": "/api/qiskit/0.26/qiskit.pulse.builder.active_backend" @@ -4692,10 +4697,6 @@ "title": "call", "url": "/api/qiskit/0.26/qiskit.pulse.builder.call" }, - { - "title": "Call", - "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Call" - }, { "title": "circuit_scheduler_settings", "url": "/api/qiskit/0.26/qiskit.pulse.builder.circuit_scheduler_settings" @@ -4704,14 +4705,6 @@ "title": "Constant", "url": "/api/qiskit/0.26/qiskit.pulse.Constant" }, - { - "title": "Constant", - "url": "/api/qiskit/0.26/qiskit.pulse.library.Constant" - }, - { - "title": "constant", - "url": "/api/qiskit/0.26/qiskit.pulse.library.discrete" - }, { "title": "control_channels", "url": "/api/qiskit/0.26/qiskit.pulse.builder.control_channels" @@ -4732,10 +4725,6 @@ "title": "delay", "url": "/api/qiskit/0.26/qiskit.pulse.builder.delay" }, - { - "title": "Delay", - "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Delay" - }, { "title": "delay_qubits", "url": "/api/qiskit/0.26/qiskit.pulse.builder.delay_qubits" @@ -4744,10 +4733,6 @@ "title": "Drag", "url": "/api/qiskit/0.26/qiskit.pulse.Drag" }, - { - "title": "Drag", - "url": "/api/qiskit/0.26/qiskit.pulse.library.Drag" - }, { "title": "drive_channel", "url": "/api/qiskit/0.26/qiskit.pulse.builder.drive_channel" @@ -4764,18 +4749,10 @@ "title": "Gaussian", "url": "/api/qiskit/0.26/qiskit.pulse.Gaussian" }, - { - "title": "Gaussian", - "url": "/api/qiskit/0.26/qiskit.pulse.library.Gaussian" - }, { "title": "GaussianSquare", "url": "/api/qiskit/0.26/qiskit.pulse.GaussianSquare" }, - { - "title": "GaussianSquare", - "url": "/api/qiskit/0.26/qiskit.pulse.library.GaussianSquare" - }, { "title": "inline", "url": "/api/qiskit/0.26/qiskit.pulse.builder.inline" @@ -4784,10 +4761,6 @@ "title": "Instruction", "url": "/api/qiskit/0.26/qiskit.pulse.Instruction" }, - { - "title": "Instruction", - "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Instruction" - }, { "title": "InstructionScheduleMap", "url": "/api/qiskit/0.26/qiskit.pulse.InstructionScheduleMap" @@ -4836,14 +4809,14 @@ "title": "play", "url": "/api/qiskit/0.26/qiskit.pulse.builder.play" }, - { - "title": "Play", - "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Play" - }, { "title": "PulseError", "url": "/api/qiskit/0.26/qiskit.pulse.PulseError" }, + { + "title": "qiskit.pulse.channels", + "url": "/api/qiskit/0.26/qiskit.pulse.channels" + }, { "title": "qubit_channels", "url": "/api/qiskit/0.26/qiskit.pulse.builder.qubit_channels" @@ -4880,18 +4853,10 @@ "title": "SetFrequency", "url": "/api/qiskit/0.26/qiskit.pulse.SetFrequency" }, - { - "title": "SetFrequency", - "url": "/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency" - }, { "title": "SetPhase", "url": "/api/qiskit/0.26/qiskit.pulse.SetPhase" }, - { - "title": "SetPhase", - "url": "/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase" - }, { "title": "shift_frequency", "url": "/api/qiskit/0.26/qiskit.pulse.builder.shift_frequency" @@ -4904,18 +4869,10 @@ "title": "ShiftFrequency", "url": "/api/qiskit/0.26/qiskit.pulse.ShiftFrequency" }, - { - "title": "ShiftFrequency", - "url": "/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency" - }, { "title": "ShiftPhase", "url": "/api/qiskit/0.26/qiskit.pulse.ShiftPhase" }, - { - "title": "ShiftPhase", - "url": "/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase" - }, { "title": "Snapshot", "url": "/api/qiskit/0.26/qiskit.pulse.Snapshot" @@ -4924,10 +4881,6 @@ "title": "snapshot", "url": "/api/qiskit/0.26/qiskit.pulse.builder.snapshot" }, - { - "title": "Snapshot", - "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot" - }, { "title": "transpiler_settings", "url": "/api/qiskit/0.26/qiskit.pulse.builder.transpiler_settings" @@ -4948,13 +4901,91 @@ "title": "Waveform", "url": "/api/qiskit/0.26/qiskit.pulse.Waveform" }, - { - "title": "Waveform", - "url": "/api/qiskit/0.26/qiskit.pulse.library.Waveform" - }, { "title": "x", "url": "/api/qiskit/0.26/qiskit.pulse.builder.x" + }, + { + "title": "qiskit.pulse.instructions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.26/qiskit.pulse.instructions" + }, + { + "title": "Acquire", + "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Acquire" + }, + { + "title": "Call", + "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Call" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Delay" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Instruction" + }, + { + "title": "Play", + "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Play" + }, + { + "title": "SetFrequency", + "url": "/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency" + }, + { + "title": "SetPhase", + "url": "/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase" + }, + { + "title": "ShiftFrequency", + "url": "/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency" + }, + { + "title": "ShiftPhase", + "url": "/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot" + } + ] + }, + { + "title": "qiskit.pulse.library", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.26/qiskit.pulse.library" + }, + { + "title": "Constant", + "url": "/api/qiskit/0.26/qiskit.pulse.library.Constant" + }, + { + "title": "Drag", + "url": "/api/qiskit/0.26/qiskit.pulse.library.Drag" + }, + { + "title": "Gaussian", + "url": "/api/qiskit/0.26/qiskit.pulse.library.Gaussian" + }, + { + "title": "GaussianSquare", + "url": "/api/qiskit/0.26/qiskit.pulse.library.GaussianSquare" + }, + { + "title": "qiskit.pulse.library.discrete", + "url": "/api/qiskit/0.26/qiskit.pulse.library.discrete" + }, + { + "title": "Waveform", + "url": "/api/qiskit/0.26/qiskit.pulse.library.Waveform" + } + ] } ] }, @@ -5298,11 +5329,11 @@ "url": "/api/qiskit/0.26/scheduler" }, { - "title": "as_late_as_possible", + "title": "qiskit.scheduler.methods.basic", "url": "/api/qiskit/0.26/qiskit.scheduler.methods.basic" }, { - "title": "schedule_circuit", + "title": "qiskit.scheduler.schedule_circuit", "url": "/api/qiskit/0.26/qiskit.scheduler.schedule_circuit" }, { diff --git a/docs/api/qiskit/0.26/circuit_library.md b/docs/api/qiskit/0.26/circuit_library.md index 9e5e72f573c..2c693769ddf 100644 --- a/docs/api/qiskit/0.26/circuit_library.md +++ b/docs/api/qiskit/0.26/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -265,3 +277,4 @@ | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.26/pulse.md b/docs/api/qiskit/0.26/pulse.md index acea9ba1436..6c7874b1b00 100644 --- a/docs/api/qiskit/0.26/pulse.md +++ b/docs/api/qiskit/0.26/pulse.md @@ -32,18 +32,18 @@ This is sufficient to allow the quantum physicist to explore and correct for noi `qiskit.pulse.instructions` -| | | -| ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | -| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Call`](qiskit.pulse.Call "qiskit.pulse.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | -| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftFrequency`](qiskit.pulse.ShiftFrequency "qiskit.pulse.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | -| [`SetPhase`](qiskit.pulse.SetPhase "qiskit.pulse.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | -| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | -| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | +| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Call`](qiskit.pulse.Call "qiskit.pulse.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | +| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftFrequency`](qiskit.pulse.ShiftFrequency "qiskit.pulse.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | +| [`SetPhase`](qiskit.pulse.SetPhase "qiskit.pulse.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | +| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). | +| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Pulse Library (waveforms ) @@ -274,11 +274,11 @@ with pulse.build(backend) as measure_sched: MemorySlot(0) ``` -| | | -| ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`measure`](qiskit.pulse.builder.measure "qiskit.pulse.builder.measure")(qubits\[, registers]) | Measure a qubit within the currently active builder context. | -| [`measure_all`](qiskit.pulse.builder.measure_all "qiskit.pulse.builder.measure_all")() | Measure all qubits within the currently active builder context. | -| [`delay_qubits`](qiskit.pulse.builder.delay_qubits "qiskit.pulse.builder.delay_qubits")(duration, \*qubits) | Insert delays on all of the [`channels.Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")s that correspond to the input `qubits` at the same time. | +| | | +| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`measure`](qiskit.pulse.builder.measure "qiskit.pulse.builder.measure")(qubits\[, registers]) | Measure a qubit within the currently active builder context. | +| [`measure_all`](qiskit.pulse.builder.measure_all "qiskit.pulse.builder.measure_all")() | Measure all qubits within the currently active builder context. | +| [`delay_qubits`](qiskit.pulse.builder.delay_qubits "qiskit.pulse.builder.delay_qubits")(duration, \*qubits) | Insert delays on all of the [`channels.Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")s that correspond to the input `qubits` at the same time. | ### Circuit Gates diff --git a/docs/api/qiskit/0.26/qiskit.compiler.assemble.md b/docs/api/qiskit/0.26/qiskit.compiler.assemble.md index e6429dd2655..fb20d988d7e 100644 --- a/docs/api/qiskit/0.26/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.26/qiskit.compiler.assemble.md @@ -42,7 +42,7 @@ This function serializes the payloads, which could be either circuits or schedul * **meas\_lo\_range** (`Optional`\[`List`\[`int`]]) – List of measurement LO ranges each of form `[range_min, range_max]` in Hz. Used to validate the supplied qubit frequencies. -* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. +* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. * **meas\_level** (`Union`\[`int`, `MeasLevel`]) – Set the appropriate level of the measurement output for pulse experiments. diff --git a/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio.md index 6ecac2fa438..82487c60134 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.finance.applications.ising.portfolio.get_operator +title: portfolio +description: API reference for qiskit.finance.applications.ising.portfolio in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.finance.applications.ising.portfolio.get_operator +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio --- diff --git a/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio_diversification.md index 4716f1a56b6..f91ddbb89e1 100644 --- a/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.26/qiskit.finance.applications.ising.portfolio_diversification.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.finance.applications.ising.portfolio_diversification.get_operator +title: portfolio_diversification +description: API reference for qiskit.finance.applications.ising.portfolio_diversification in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.finance.applications.ising.portfolio_diversification.get_operator +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio_diversification --- diff --git a/docs/api/qiskit/0.26/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.26/qiskit.ignis.verification.basis.md index e26610b6708..c7c0137e9f8 100644 --- a/docs/api/qiskit/0.26/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.26/qiskit.ignis.verification.basis.md @@ -1,5 +1,14 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # qiskit.ignis.verification.basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.clique.md index 940c74047fe..c0e4c528922 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.clique.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.clique.get_graph_solution +title: clique +description: API reference for qiskit.optimization.applications.ising.clique in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.clique.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.clique --- diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.common.md index 3392c7d4935..a80b94865a2 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.common.md @@ -1,9 +1,9 @@ --- -title: get_gset_result -description: API reference for qiskit.optimization.applications.ising.common.get_gset_result +title: common +description: API reference for qiskit.optimization.applications.ising.common in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.common.get_gset_result +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.common --- diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.docplex.md index 9ddbec3f2b1..343cc6b736b 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.docplex.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.docplex.get_operator +title: docplex +description: API reference for qiskit.optimization.applications.ising.docplex in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.docplex.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.docplex --- diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.exact_cover.md index 1e7745503a3..6eced2620c4 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.exact_cover.md @@ -1,9 +1,9 @@ --- -title: check_solution_satisfiability -description: API reference for qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability +title: exact_cover +description: API reference for qiskit.optimization.applications.ising.exact_cover in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.exact_cover --- diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.graph_partition.md index c9a4bfb5d3d..2d3f7e88296 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.graph_partition.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.graph_partition.get_graph_solution +title: graph_partition +description: API reference for qiskit.optimization.applications.ising.graph_partition in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.graph_partition.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.graph_partition --- @@ -50,11 +50,11 @@ Generate Hamiltonian for the graph partitioning **Notes** -## Goals: +**Goals:** 1 separate the vertices into two set of the same size 2 make sure the number of edges between the two set is minimized. -## Hamiltonian: +**Hamiltonian:** H = H\_A + H\_B H\_A = sum\_\{(i,j)in E}\{(1-ZiZj)/2} H\_B = (sum\_\{i}\{Zi})^2 = sum\_\{i}\{Zi^2}+sum\_\{i!=j}\{ZiZj} H\_A is for achieving goal 2 and H\_B is for achieving goal 1. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.knapsack.md index aa6c9e7c681..6f9306be50f 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.knapsack.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.knapsack.get_operator +title: knapsack +description: API reference for qiskit.optimization.applications.ising.knapsack in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.knapsack.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.knapsack --- diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.max_cut.md index 03838a55ff8..0f7cd5d4d0f 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.max_cut.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.max_cut.get_graph_solution +title: max_cut +description: API reference for qiskit.optimization.applications.ising.max_cut in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.max_cut.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.max_cut --- diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.partition.md index 2cc12770421..451c7de04e4 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.partition.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.partition.get_operator +title: partition +description: API reference for qiskit.optimization.applications.ising.partition in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.partition.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.partition --- diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.set_packing.md index 50a16bc2e93..6fe5f8562f4 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.set_packing.md @@ -1,9 +1,9 @@ --- -title: check_disjoint -description: API reference for qiskit.optimization.applications.ising.set_packing.check_disjoint +title: set_packing +description: API reference for qiskit.optimization.applications.ising.set_packing in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.set_packing.check_disjoint +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.set_packing --- diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.stable_set.md index e3ea779d063..2f6481bbfd8 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.stable_set.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.stable_set.get_graph_solution +title: stable_set +description: API reference for qiskit.optimization.applications.ising.stable_set in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.stable_set.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.stable_set --- diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.md index bbc3456ab5a..e5f3da7c799 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.md @@ -1,9 +1,9 @@ --- -title: TspData -description: API reference for qiskit.optimization.applications.ising.tsp.TspData +title: tsp +description: API reference for qiskit.optimization.applications.ising.tsp in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.optimization.applications.ising.tsp.TspData +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.tsp --- diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vehicle_routing.md index 41417b86a6a..cb9da8e8f25 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vehicle_routing.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.vehicle_routing.get_operator +title: vehicle_routing +description: API reference for qiskit.optimization.applications.ising.vehicle_routing in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.vehicle_routing.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vehicle_routing --- @@ -72,7 +72,7 @@ objective function value. `get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") -## Constructs auxiliary matrices from a vehicle routing instance, +**Constructs auxiliary matrices from a vehicle routing instance,** which represent the encoding into a binary quadratic program. This is used in the construction of the qubit ops and computation of the solution cost. @@ -96,7 +96,7 @@ a matrix defining the interactions between variables. a matrix defining the cont `get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") -## Tries to obtain a feasible solution (in vector form) of an instance +**Tries to obtain a feasible solution (in vector form) of an instance** of vehicle routing from the results dictionary. @@ -115,7 +115,7 @@ of vehicle routing from the results dictionary. a solution, i.e., a path, in its binary representation. -## #TODO: support statevector simulation, results should be a statevector or counts format, not +**#TODO: support statevector simulation, results should be a statevector or counts format, not** a result from algorithm run diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vertex_cover.md index 50658b90390..5ed46e10885 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.vertex_cover.md @@ -1,9 +1,9 @@ --- -title: check_full_edge_coverage -description: API reference for qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage +title: vertex_cover +description: API reference for qiskit.optimization.applications.ising.vertex_cover in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vertex_cover --- diff --git a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.md index 1f21c59eff4..67be68ad63a 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.26/qiskit.providers.ibmq.IBMQBackend.md @@ -457,7 +457,7 @@ If a keyword specified here is also present in the `options` attribute/object, t * **meas\_lo\_freq** (`Optional`\[`List`\[`int`]]) – List of default measurement LO frequencies in Hz. Will be overridden by `schedule_los` if set. -* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. +* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. * **meas\_level** (`Union`\[`int`, `MeasLevel`, `None`]) – Set the appropriate level of the measurement output for pulse experiments. diff --git a/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.md index 33cf18195d9..cf2ea888aa3 100644 --- a/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.26/qiskit.providers.models.PulseBackendConfiguration.md @@ -144,7 +144,7 @@ Return the acquisition channel for the given qubit. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") **Returns** @@ -169,7 +169,7 @@ Return the secondary drive channel for the given qubit – typically utilized fo **Return type** -`List`\[[`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")] +`List`\[[`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")] **Returns** @@ -199,7 +199,7 @@ backend.configuration().describe(ControlChannel(1)) **Parameters** -**channel** ([`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe. +**channel** ([`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe. **Raises** @@ -207,7 +207,7 @@ backend.configuration().describe(ControlChannel(1)) **Return type** -`Dict`\[[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel"), `complex`] +`Dict`\[[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel"), `complex`] **Returns** @@ -227,7 +227,7 @@ Return the drive channel for the given qubit. **Return type** -[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") +[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel") **Returns** @@ -287,7 +287,7 @@ Return a list of channels which operate on the given `qubit`. **Return type** -`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] **Returns** @@ -307,7 +307,7 @@ Return the measure stimulus channel for the given qubit. **Return type** -[`MeasureChannel`](qiskit.pulse.channels#qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") +[`MeasureChannel`](qiskit.pulse.channels#measurechannel "qiskit.pulse.channels.MeasureChannel") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.26/qiskit.pulse.Acquire.md index 57757191057..72f12354374 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Acquire.md @@ -25,9 +25,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -47,9 +47,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -76,23 +76,23 @@ Create a new Acquire instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`acquire`](#qiskit.pulse.Acquire.acquire "qiskit.pulse.Acquire.acquire") | Acquire channel to acquire data. | -| [`channel`](#qiskit.pulse.Acquire.channel "qiskit.pulse.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Acquire.channels "qiskit.pulse.Acquire.channels") | Returns the channels that this schedule uses. | -| [`discriminator`](#qiskit.pulse.Acquire.discriminator "qiskit.pulse.Acquire.discriminator") | Return discrimination settings. | -| [`duration`](#qiskit.pulse.Acquire.duration "qiskit.pulse.Acquire.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Acquire.id "qiskit.pulse.Acquire.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Acquire.instructions "qiskit.pulse.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | -| [`kernel`](#qiskit.pulse.Acquire.kernel "qiskit.pulse.Acquire.kernel") | Return kernel settings. | -| [`mem_slot`](#qiskit.pulse.Acquire.mem_slot "qiskit.pulse.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | -| [`name`](#qiskit.pulse.Acquire.name "qiskit.pulse.Acquire.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Acquire.operands "qiskit.pulse.Acquire.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Acquire.parameters "qiskit.pulse.Acquire.parameters") | Parameters which determine the instruction behavior. | -| [`reg_slot`](#qiskit.pulse.Acquire.reg_slot "qiskit.pulse.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | -| [`start_time`](#qiskit.pulse.Acquire.start_time "qiskit.pulse.Acquire.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Acquire.stop_time "qiskit.pulse.Acquire.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`acquire`](#qiskit.pulse.Acquire.acquire "qiskit.pulse.Acquire.acquire") | Acquire channel to acquire data. | +| [`channel`](#qiskit.pulse.Acquire.channel "qiskit.pulse.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Acquire.channels "qiskit.pulse.Acquire.channels") | Returns the channels that this schedule uses. | +| [`discriminator`](#qiskit.pulse.Acquire.discriminator "qiskit.pulse.Acquire.discriminator") | Return discrimination settings. | +| [`duration`](#qiskit.pulse.Acquire.duration "qiskit.pulse.Acquire.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Acquire.id "qiskit.pulse.Acquire.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Acquire.instructions "qiskit.pulse.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | +| [`kernel`](#qiskit.pulse.Acquire.kernel "qiskit.pulse.Acquire.kernel") | Return kernel settings. | +| [`mem_slot`](#qiskit.pulse.Acquire.mem_slot "qiskit.pulse.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | +| [`name`](#qiskit.pulse.Acquire.name "qiskit.pulse.Acquire.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Acquire.operands "qiskit.pulse.Acquire.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Acquire.parameters "qiskit.pulse.Acquire.parameters") | Parameters which determine the instruction behavior. | +| [`reg_slot`](#qiskit.pulse.Acquire.reg_slot "qiskit.pulse.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | +| [`start_time`](#qiskit.pulse.Acquire.start_time "qiskit.pulse.Acquire.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Acquire.stop_time "qiskit.pulse.Acquire.stop_time") | Relative end time of this instruction. | ### acquire @@ -104,7 +104,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### append @@ -201,11 +201,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### channels @@ -217,7 +217,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]] +`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]] ### discriminator @@ -252,7 +252,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** @@ -366,7 +366,7 @@ The classical memory slot which will store the classified readout result. **Return type** -[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot") +[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot") ### name @@ -414,7 +414,7 @@ The fast-access register slot which will store the classified readout result for **Return type** -[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot") +[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot") ### shift diff --git a/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.md index a900ecc9ee0..7104f339ff5 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.AcquireChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Call.md b/docs/api/qiskit/0.26/qiskit.pulse.Call.md index a433311a9fc..bdb134c5aec 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Call.md @@ -221,7 +221,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -244,7 +244,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.md index e85fea470d2..5dea4fbfbd8 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.ControlChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Delay.md b/docs/api/qiskit/0.26/qiskit.pulse.Delay.md index 98cd332f9b9..a6331b59ac3 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Delay.md @@ -33,7 +33,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ### \_\_init\_\_ @@ -49,7 +49,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ## Methods @@ -70,18 +70,18 @@ No other instruction may be scheduled within a `Delay`. ## Attributes -| | | -| ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Delay.channel "qiskit.pulse.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Delay.channels "qiskit.pulse.Delay.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Delay.duration "qiskit.pulse.Delay.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Delay.id "qiskit.pulse.Delay.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Delay.instructions "qiskit.pulse.Delay.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.Delay.name "qiskit.pulse.Delay.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Delay.operands "qiskit.pulse.Delay.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Delay.parameters "qiskit.pulse.Delay.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.Delay.start_time "qiskit.pulse.Delay.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Delay.stop_time "qiskit.pulse.Delay.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.Delay.channel "qiskit.pulse.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Delay.channels "qiskit.pulse.Delay.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Delay.duration "qiskit.pulse.Delay.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Delay.id "qiskit.pulse.Delay.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Delay.instructions "qiskit.pulse.Delay.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.Delay.name "qiskit.pulse.Delay.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Delay.operands "qiskit.pulse.Delay.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Delay.parameters "qiskit.pulse.Delay.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.Delay.start_time "qiskit.pulse.Delay.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Delay.stop_time "qiskit.pulse.Delay.stop_time") | Relative end time of this instruction. | ### append @@ -178,11 +178,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") ### channels @@ -194,7 +194,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -217,7 +217,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.md index cdd0f40215b..6e0feba01f1 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.DriveChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.26/qiskit.pulse.Instruction.md index 1fddc089976..2c84e0a3425 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Instruction.md @@ -20,7 +20,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -40,7 +40,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -177,7 +177,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -200,7 +200,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.md index 877cea85d05..9d661b317d8 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.MeasureChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.md index e55293d4ec2..0ef342e2e8e 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.MemorySlot.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Play.md b/docs/api/qiskit/0.26/qiskit.pulse.Play.md index 33bb992a1f1..8291004209c 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Play.md @@ -21,7 +21,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -39,7 +39,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -64,19 +64,19 @@ Create a new pulse instruction. ## Attributes -| | | -| ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Play.channel "qiskit.pulse.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Play.channels "qiskit.pulse.Play.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Play.duration "qiskit.pulse.Play.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Play.id "qiskit.pulse.Play.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Play.instructions "qiskit.pulse.Play.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.Play.name "qiskit.pulse.Play.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Play.operands "qiskit.pulse.Play.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Play.parameters "qiskit.pulse.Play.parameters") | Parameters which determine the instruction behavior. | -| [`pulse`](#qiskit.pulse.Play.pulse "qiskit.pulse.Play.pulse") | A description of the samples that will be played. | -| [`start_time`](#qiskit.pulse.Play.start_time "qiskit.pulse.Play.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Play.stop_time "qiskit.pulse.Play.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.Play.channel "qiskit.pulse.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Play.channels "qiskit.pulse.Play.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Play.duration "qiskit.pulse.Play.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Play.id "qiskit.pulse.Play.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Play.instructions "qiskit.pulse.Play.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.Play.name "qiskit.pulse.Play.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Play.operands "qiskit.pulse.Play.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Play.parameters "qiskit.pulse.Play.parameters") | Parameters which determine the instruction behavior. | +| [`pulse`](#qiskit.pulse.Play.pulse "qiskit.pulse.Play.pulse") | A description of the samples that will be played. | +| [`start_time`](#qiskit.pulse.Play.start_time "qiskit.pulse.Play.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Play.stop_time "qiskit.pulse.Play.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.md index 1eb46da4a4f..7a8e1fca2fa 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.RegisterSlot.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.26/qiskit.pulse.Schedule.md index 9ea2dd3651f..9b92cfab1ab 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Schedule.md @@ -221,7 +221,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -241,7 +241,7 @@ Plot the schedule. * **time\_unit** (`str`) – The unit of specified time range either dt or ns. The unit of ns is available only when backend object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. @@ -324,7 +324,7 @@ self.filter(args) | self.exclude(args) == self **Parameters** * **filter\_funcs** (`Callable`) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -347,7 +347,7 @@ If no arguments are provided, `self` is returned. **Parameters** * **filter\_funcs** (`Callable`) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -585,5 +585,5 @@ Time keeping attribute. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.md index a22dd073c4a..5164eaef864 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.ScheduleBlock.md @@ -237,7 +237,7 @@ Returns channels that this schedule clock uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -257,7 +257,7 @@ Plot the schedule. * **time\_unit** (`str`) – The unit of specified time range either dt or ns. The unit of ns is available only when backend object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. @@ -344,7 +344,7 @@ self.filter(args) | self.exclude(args) == self **Parameters** * **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -375,7 +375,7 @@ If no arguments are provided, `self` is returned. **Parameters** * **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -586,5 +586,5 @@ Time keeping attribute. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] diff --git a/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.md index e0ebe7c915f..3df4a86fda5 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.SetFrequency.md @@ -27,7 +27,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -62,19 +62,19 @@ Creates a new set channel frequency instruction. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.SetFrequency.channel "qiskit.pulse.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.SetFrequency.channels "qiskit.pulse.SetFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.SetFrequency.duration "qiskit.pulse.SetFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.SetFrequency.frequency "qiskit.pulse.SetFrequency.frequency") | New frequency. | -| [`id`](#qiskit.pulse.SetFrequency.id "qiskit.pulse.SetFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.SetFrequency.instructions "qiskit.pulse.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.SetFrequency.name "qiskit.pulse.SetFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.SetFrequency.operands "qiskit.pulse.SetFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.SetFrequency.parameters "qiskit.pulse.SetFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.SetFrequency.start_time "qiskit.pulse.SetFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.SetFrequency.stop_time "qiskit.pulse.SetFrequency.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.SetFrequency.channel "qiskit.pulse.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.SetFrequency.channels "qiskit.pulse.SetFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.SetFrequency.duration "qiskit.pulse.SetFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.SetFrequency.frequency "qiskit.pulse.SetFrequency.frequency") | New frequency. | +| [`id`](#qiskit.pulse.SetFrequency.id "qiskit.pulse.SetFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.SetFrequency.instructions "qiskit.pulse.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.SetFrequency.name "qiskit.pulse.SetFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.SetFrequency.operands "qiskit.pulse.SetFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.SetFrequency.parameters "qiskit.pulse.SetFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.SetFrequency.start_time "qiskit.pulse.SetFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.SetFrequency.stop_time "qiskit.pulse.SetFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.md index 3803f04c4e7..1aceeec1749 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.SetPhase.md @@ -27,7 +27,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -62,19 +62,19 @@ Instantiate a set phase instruction, setting the output signal phase on `channel ## Attributes -| | | -| ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.SetPhase.channel "qiskit.pulse.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.SetPhase.channels "qiskit.pulse.SetPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.SetPhase.duration "qiskit.pulse.SetPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.SetPhase.id "qiskit.pulse.SetPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.SetPhase.instructions "qiskit.pulse.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.SetPhase.name "qiskit.pulse.SetPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.SetPhase.operands "qiskit.pulse.SetPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.SetPhase.parameters "qiskit.pulse.SetPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.SetPhase.phase "qiskit.pulse.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.SetPhase.start_time "qiskit.pulse.SetPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.SetPhase.stop_time "qiskit.pulse.SetPhase.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.SetPhase.channel "qiskit.pulse.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.SetPhase.channels "qiskit.pulse.SetPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.SetPhase.duration "qiskit.pulse.SetPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.SetPhase.id "qiskit.pulse.SetPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.SetPhase.instructions "qiskit.pulse.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.SetPhase.name "qiskit.pulse.SetPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.SetPhase.operands "qiskit.pulse.SetPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.SetPhase.parameters "qiskit.pulse.SetPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.SetPhase.phase "qiskit.pulse.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.SetPhase.start_time "qiskit.pulse.SetPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.SetPhase.stop_time "qiskit.pulse.SetPhase.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.md index 9ca7e8efe13..33c38b6d65b 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.ShiftFrequency.md @@ -19,7 +19,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -33,7 +33,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -54,19 +54,19 @@ Creates a new shift frequency instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.ShiftFrequency.channel "qiskit.pulse.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.ShiftFrequency.channels "qiskit.pulse.ShiftFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.ShiftFrequency.duration "qiskit.pulse.ShiftFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.ShiftFrequency.frequency "qiskit.pulse.ShiftFrequency.frequency") | Frequency shift from the set frequency. | -| [`id`](#qiskit.pulse.ShiftFrequency.id "qiskit.pulse.ShiftFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.ShiftFrequency.instructions "qiskit.pulse.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.ShiftFrequency.name "qiskit.pulse.ShiftFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.ShiftFrequency.operands "qiskit.pulse.ShiftFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.ShiftFrequency.parameters "qiskit.pulse.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.ShiftFrequency.start_time "qiskit.pulse.ShiftFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.ShiftFrequency.stop_time "qiskit.pulse.ShiftFrequency.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.ShiftFrequency.channel "qiskit.pulse.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.ShiftFrequency.channels "qiskit.pulse.ShiftFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.ShiftFrequency.duration "qiskit.pulse.ShiftFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.ShiftFrequency.frequency "qiskit.pulse.ShiftFrequency.frequency") | Frequency shift from the set frequency. | +| [`id`](#qiskit.pulse.ShiftFrequency.id "qiskit.pulse.ShiftFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.ShiftFrequency.instructions "qiskit.pulse.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.ShiftFrequency.name "qiskit.pulse.ShiftFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.ShiftFrequency.operands "qiskit.pulse.ShiftFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.ShiftFrequency.parameters "qiskit.pulse.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.ShiftFrequency.start_time "qiskit.pulse.ShiftFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.ShiftFrequency.stop_time "qiskit.pulse.ShiftFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -163,11 +163,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -179,7 +179,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -202,7 +202,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.md index 91fd767940e..8cb59125556 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.ShiftPhase `ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") -The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. +The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -29,7 +29,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -43,7 +43,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -64,19 +64,19 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch ## Attributes -| | | -| ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.ShiftPhase.channel "qiskit.pulse.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.ShiftPhase.channels "qiskit.pulse.ShiftPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.ShiftPhase.duration "qiskit.pulse.ShiftPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.ShiftPhase.id "qiskit.pulse.ShiftPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.ShiftPhase.instructions "qiskit.pulse.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.ShiftPhase.name "qiskit.pulse.ShiftPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.ShiftPhase.operands "qiskit.pulse.ShiftPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.ShiftPhase.parameters "qiskit.pulse.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.ShiftPhase.phase "qiskit.pulse.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.ShiftPhase.start_time "qiskit.pulse.ShiftPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.ShiftPhase.stop_time "qiskit.pulse.ShiftPhase.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.ShiftPhase.channel "qiskit.pulse.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.ShiftPhase.channels "qiskit.pulse.ShiftPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.ShiftPhase.duration "qiskit.pulse.ShiftPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.ShiftPhase.id "qiskit.pulse.ShiftPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.ShiftPhase.instructions "qiskit.pulse.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.ShiftPhase.name "qiskit.pulse.ShiftPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.ShiftPhase.operands "qiskit.pulse.ShiftPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.ShiftPhase.parameters "qiskit.pulse.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.ShiftPhase.phase "qiskit.pulse.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.ShiftPhase.start_time "qiskit.pulse.ShiftPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.ShiftPhase.stop_time "qiskit.pulse.ShiftPhase.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.md index 774df87cbeb..a94951dbe72 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.Snapshot.md @@ -62,20 +62,20 @@ Create new snapshot. ## Attributes -| | | -| ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Snapshot.channel "qiskit.pulse.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | -| [`channels`](#qiskit.pulse.Snapshot.channels "qiskit.pulse.Snapshot.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Snapshot.duration "qiskit.pulse.Snapshot.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Snapshot.id "qiskit.pulse.Snapshot.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Snapshot.instructions "qiskit.pulse.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | -| [`label`](#qiskit.pulse.Snapshot.label "qiskit.pulse.Snapshot.label") | Label of snapshot. | -| [`name`](#qiskit.pulse.Snapshot.name "qiskit.pulse.Snapshot.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Snapshot.operands "qiskit.pulse.Snapshot.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Snapshot.parameters "qiskit.pulse.Snapshot.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.Snapshot.start_time "qiskit.pulse.Snapshot.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Snapshot.stop_time "qiskit.pulse.Snapshot.stop_time") | Relative end time of this instruction. | -| [`type`](#qiskit.pulse.Snapshot.type "qiskit.pulse.Snapshot.type") | Type of snapshot. | +| | | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`channel`](#qiskit.pulse.Snapshot.channel "qiskit.pulse.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | +| [`channels`](#qiskit.pulse.Snapshot.channels "qiskit.pulse.Snapshot.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Snapshot.duration "qiskit.pulse.Snapshot.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Snapshot.id "qiskit.pulse.Snapshot.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Snapshot.instructions "qiskit.pulse.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | +| [`label`](#qiskit.pulse.Snapshot.label "qiskit.pulse.Snapshot.label") | Label of snapshot. | +| [`name`](#qiskit.pulse.Snapshot.name "qiskit.pulse.Snapshot.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Snapshot.operands "qiskit.pulse.Snapshot.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Snapshot.parameters "qiskit.pulse.Snapshot.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.Snapshot.start_time "qiskit.pulse.Snapshot.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Snapshot.stop_time "qiskit.pulse.Snapshot.stop_time") | Relative end time of this instruction. | +| [`type`](#qiskit.pulse.Snapshot.type "qiskit.pulse.Snapshot.type") | Type of snapshot. | ### append @@ -172,11 +172,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** -[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel") +[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel") ### channels @@ -188,7 +188,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel")] +`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel")] ### draw @@ -211,7 +211,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire.md index c29a43a028c..ba6fd3cb433 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire.md @@ -37,8 +37,8 @@ with pulse.build() as pulse_prog: **Parameters** * **duration** (`int`) – Duration to acquire data for -* **qubit\_or\_channel** (`Union`\[`int`, [`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")]) – Either the qubit to acquire data for or the specific [`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") to acquire on. -* **register** (`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])) – Location to store measured result. +* **qubit\_or\_channel** (`Union`\[`int`, [`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")]) – Either the qubit to acquire data for or the specific [`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") to acquire on. +* **register** (`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])) – Location to store measured result. * **metadata** (`Union`\[`Kernel`, `Discriminator`]) – Additional metadata for measurement. See [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire") for more information. **Raises** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire_channel.md index 9d89d34e805..d5543331cb8 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.acquire_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.barrier.md index d601ffe8ea5..3a7c88ca5df 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.barrier.md @@ -70,6 +70,6 @@ with pulse.build(backend) as pulse_prog: **Parameters** -* **channels\_or\_qubits** (`Union`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `int`]) – Channels or qubits to barrier. +* **channels\_or\_qubits** (`Union`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `int`]) – Channels or qubits to barrier. * **name** (`Optional`\[`str`]) – Name for the barrier diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.control_channels.md index 03fd5fd8895..fbe9d517782 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.control_channels.md @@ -37,7 +37,7 @@ with pulse.build(backend): **Return type** -`List`\[[`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")] +`List`\[[`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")] **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.delay.md index 5fc92f807ea..4f61e2869d0 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.delay.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **duration** (`int`) – Number of cycles to delay for on `channel`. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Channel to delay on. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – Channel to delay on. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.drive_channel.md index 5f9a92776f2..830b1f50e7a 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.drive_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") +[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel") diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.frequency_offset.md index e4baa1c0066..d3f825feb9f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.frequency_offset.md @@ -41,7 +41,7 @@ assert len(pulse_prog.instructions) == 4 **Parameters** * **frequency** (`float`) – Amount of frequency offset in Hz. -* **channels** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset frequency of. +* **channels** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset frequency of. * **compensate\_phase** (`bool`) – Compensate for accumulated phase accumulated with respect to the channels’ frame at its initial frequency. **Yields** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure.md index 91d347215d2..d172ff13c74 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure.md @@ -53,11 +53,11 @@ assert reg == mem0 **Parameters** * **qubits** (`Union`\[`List`\[`int`], `int`]) – Physical qubit to measure. -* **registers** (`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]), `None`]) – Register to store result in. If not selected the current behavior is to return the `MemorySlot` with the same index as `qubit`. This register will be returned. +* **registers** (`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]), `None`]) – Register to store result in. If not selected the current behavior is to return the `MemorySlot` with the same index as `qubit`. This register will be returned. **Return type** -`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])] +`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])] **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_all.md index d7bacde24b2..1d3bf31c2ad 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_all.md @@ -35,7 +35,7 @@ with pulse.build(backend) as pulse_prog: **Return type** -`List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")] +`List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")] **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_channel.md index 03feb981bff..3d2b1732509 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.measure_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`MeasureChannel`](qiskit.pulse.channels#qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") +[`MeasureChannel`](qiskit.pulse.channels#measurechannel "qiskit.pulse.channels.MeasureChannel") diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.pad.md index e7ff49c34b5..1a6ad5573bb 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.pad.md @@ -16,7 +16,7 @@ Pad all available timeslots with delays upon exiting context. **Parameters** -**chs** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Channels to pad with delays. Defaults to all channels in context if none are supplied. +**chs** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – Channels to pad with delays. Defaults to all channels in context if none are supplied. Examples: diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.phase_offset.md index 48b85c83ebc..772a71d232c 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.phase_offset.md @@ -33,7 +33,7 @@ assert len(pulse_prog.instructions) == 3 **Parameters** * **phase** (`float`) – Amount of phase offset in radians. -* **channels** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset phase of. +* **channels** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset phase of. **Yields** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.play.md index 94396e1bca5..a842a673bc8 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.play.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **pulse** (`Union`\[`Pulse`, `ndarray`]) – Pulse to play. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to play pulse on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to play pulse on. * **name** (`Optional`\[`str`]) – Name of the pulse. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.qubit_channels.md index 12bdbe84672..f996b975818 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.qubit_channels.md @@ -40,5 +40,5 @@ with pulse.build(backend): **Return type** -`Set`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Set`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.set_frequency.md index 08dbcd50786..87e5b588b7b 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.set_frequency.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **frequency** (`float`) – Frequency in Hz to set channel to. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to set frequency of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to set frequency of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.set_phase.md index 924cc0ee7a9..c85e44c392f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.set_phase.md @@ -30,6 +30,6 @@ with pulse.build() as pulse_prog: **Parameters** * **phase** (`float`) – Phase in radians to set channel carrier signal to. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to set phase of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to set phase of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_frequency.md index b610ae51305..58142ca9fbb 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_frequency.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **frequency** (`float`) – Frequency in Hz to shift channel frequency by. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift frequency of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift frequency of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_phase.md index cb338fff15d..96eb4a67d7d 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.builder.shift_phase.md @@ -30,6 +30,6 @@ with pulse.build() as pulse_prog: **Parameters** * **phase** (`float`) – Phase in radians to shift channel carrier signal by. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift phase of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift phase of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.26/qiskit.pulse.channels.md b/docs/api/qiskit/0.26/qiskit.pulse.channels.md index 93f83d00605..e5222160a22 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.channels.md @@ -1,9 +1,9 @@ --- -title: AcquireChannel -description: API reference for qiskit.pulse.channels.AcquireChannel +title: channels +description: API reference for qiskit.pulse.channels in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.pulse.channels.AcquireChannel +python_api_type: module +python_api_name: qiskit.pulse.channels --- diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.md index ab1cc02b484..11fdb9167e5 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Acquire.md @@ -25,9 +25,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -47,9 +47,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -76,23 +76,23 @@ Create a new Acquire instruction. ## Attributes -| | | -| --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`acquire`](#qiskit.pulse.instructions.Acquire.acquire "qiskit.pulse.instructions.Acquire.acquire") | Acquire channel to acquire data. | -| [`channel`](#qiskit.pulse.instructions.Acquire.channel "qiskit.pulse.instructions.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Acquire.channels "qiskit.pulse.instructions.Acquire.channels") | Returns the channels that this schedule uses. | -| [`discriminator`](#qiskit.pulse.instructions.Acquire.discriminator "qiskit.pulse.instructions.Acquire.discriminator") | Return discrimination settings. | -| [`duration`](#qiskit.pulse.instructions.Acquire.duration "qiskit.pulse.instructions.Acquire.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Acquire.id "qiskit.pulse.instructions.Acquire.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Acquire.instructions "qiskit.pulse.instructions.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | -| [`kernel`](#qiskit.pulse.instructions.Acquire.kernel "qiskit.pulse.instructions.Acquire.kernel") | Return kernel settings. | -| [`mem_slot`](#qiskit.pulse.instructions.Acquire.mem_slot "qiskit.pulse.instructions.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | -| [`name`](#qiskit.pulse.instructions.Acquire.name "qiskit.pulse.instructions.Acquire.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Acquire.operands "qiskit.pulse.instructions.Acquire.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Acquire.parameters "qiskit.pulse.instructions.Acquire.parameters") | Parameters which determine the instruction behavior. | -| [`reg_slot`](#qiskit.pulse.instructions.Acquire.reg_slot "qiskit.pulse.instructions.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | -| [`start_time`](#qiskit.pulse.instructions.Acquire.start_time "qiskit.pulse.instructions.Acquire.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Acquire.stop_time "qiskit.pulse.instructions.Acquire.stop_time") | Relative end time of this instruction. | +| | | +| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`acquire`](#qiskit.pulse.instructions.Acquire.acquire "qiskit.pulse.instructions.Acquire.acquire") | Acquire channel to acquire data. | +| [`channel`](#qiskit.pulse.instructions.Acquire.channel "qiskit.pulse.instructions.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Acquire.channels "qiskit.pulse.instructions.Acquire.channels") | Returns the channels that this schedule uses. | +| [`discriminator`](#qiskit.pulse.instructions.Acquire.discriminator "qiskit.pulse.instructions.Acquire.discriminator") | Return discrimination settings. | +| [`duration`](#qiskit.pulse.instructions.Acquire.duration "qiskit.pulse.instructions.Acquire.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Acquire.id "qiskit.pulse.instructions.Acquire.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Acquire.instructions "qiskit.pulse.instructions.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | +| [`kernel`](#qiskit.pulse.instructions.Acquire.kernel "qiskit.pulse.instructions.Acquire.kernel") | Return kernel settings. | +| [`mem_slot`](#qiskit.pulse.instructions.Acquire.mem_slot "qiskit.pulse.instructions.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | +| [`name`](#qiskit.pulse.instructions.Acquire.name "qiskit.pulse.instructions.Acquire.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Acquire.operands "qiskit.pulse.instructions.Acquire.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Acquire.parameters "qiskit.pulse.instructions.Acquire.parameters") | Parameters which determine the instruction behavior. | +| [`reg_slot`](#qiskit.pulse.instructions.Acquire.reg_slot "qiskit.pulse.instructions.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | +| [`start_time`](#qiskit.pulse.instructions.Acquire.start_time "qiskit.pulse.instructions.Acquire.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Acquire.stop_time "qiskit.pulse.instructions.Acquire.stop_time") | Relative end time of this instruction. | ### acquire @@ -104,7 +104,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### append @@ -201,11 +201,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### channels @@ -217,7 +217,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]] +`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]] ### discriminator @@ -252,7 +252,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** @@ -366,7 +366,7 @@ The classical memory slot which will store the classified readout result. **Return type** -[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot") +[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot") ### name @@ -414,7 +414,7 @@ The fast-access register slot which will store the classified readout result for **Return type** -[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot") +[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot") ### shift diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.md index cdf733b6523..44d242dbb6f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Call.md @@ -221,7 +221,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -244,7 +244,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.md index 397c443c0d6..dabc5660778 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Delay.md @@ -33,7 +33,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ### \_\_init\_\_ @@ -49,7 +49,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ## Methods @@ -70,18 +70,18 @@ No other instruction may be scheduled within a `Delay`. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Delay.channel "qiskit.pulse.instructions.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Delay.channels "qiskit.pulse.instructions.Delay.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Delay.duration "qiskit.pulse.instructions.Delay.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Delay.id "qiskit.pulse.instructions.Delay.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Delay.instructions "qiskit.pulse.instructions.Delay.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.Delay.name "qiskit.pulse.instructions.Delay.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Delay.operands "qiskit.pulse.instructions.Delay.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Delay.parameters "qiskit.pulse.instructions.Delay.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.Delay.start_time "qiskit.pulse.instructions.Delay.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Delay.stop_time "qiskit.pulse.instructions.Delay.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.Delay.channel "qiskit.pulse.instructions.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Delay.channels "qiskit.pulse.instructions.Delay.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Delay.duration "qiskit.pulse.instructions.Delay.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Delay.id "qiskit.pulse.instructions.Delay.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Delay.instructions "qiskit.pulse.instructions.Delay.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.Delay.name "qiskit.pulse.instructions.Delay.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Delay.operands "qiskit.pulse.instructions.Delay.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Delay.parameters "qiskit.pulse.instructions.Delay.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.Delay.start_time "qiskit.pulse.instructions.Delay.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Delay.stop_time "qiskit.pulse.instructions.Delay.stop_time") | Relative end time of this instruction. | ### append @@ -178,11 +178,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") ### channels @@ -194,7 +194,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -217,7 +217,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.md index 988d6be55db..7cb7777c5d9 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Instruction.md @@ -20,7 +20,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -40,7 +40,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -177,7 +177,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -200,7 +200,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.md index 2b28e0252df..dd53254d1da 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Play.md @@ -21,7 +21,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -39,7 +39,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -64,19 +64,19 @@ Create a new pulse instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Play.channel "qiskit.pulse.instructions.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Play.channels "qiskit.pulse.instructions.Play.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Play.duration "qiskit.pulse.instructions.Play.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Play.id "qiskit.pulse.instructions.Play.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Play.instructions "qiskit.pulse.instructions.Play.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.Play.name "qiskit.pulse.instructions.Play.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Play.operands "qiskit.pulse.instructions.Play.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Play.parameters "qiskit.pulse.instructions.Play.parameters") | Parameters which determine the instruction behavior. | -| [`pulse`](#qiskit.pulse.instructions.Play.pulse "qiskit.pulse.instructions.Play.pulse") | A description of the samples that will be played. | -| [`start_time`](#qiskit.pulse.instructions.Play.start_time "qiskit.pulse.instructions.Play.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Play.stop_time "qiskit.pulse.instructions.Play.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.Play.channel "qiskit.pulse.instructions.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Play.channels "qiskit.pulse.instructions.Play.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Play.duration "qiskit.pulse.instructions.Play.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Play.id "qiskit.pulse.instructions.Play.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Play.instructions "qiskit.pulse.instructions.Play.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.Play.name "qiskit.pulse.instructions.Play.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Play.operands "qiskit.pulse.instructions.Play.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Play.parameters "qiskit.pulse.instructions.Play.parameters") | Parameters which determine the instruction behavior. | +| [`pulse`](#qiskit.pulse.instructions.Play.pulse "qiskit.pulse.instructions.Play.pulse") | A description of the samples that will be played. | +| [`start_time`](#qiskit.pulse.instructions.Play.start_time "qiskit.pulse.instructions.Play.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Play.stop_time "qiskit.pulse.instructions.Play.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.md index 3e8f871f787..fe562941083 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetFrequency.md @@ -27,7 +27,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -62,19 +62,19 @@ Creates a new set channel frequency instruction. ## Attributes -| | | -| ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.SetFrequency.channel "qiskit.pulse.instructions.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.SetFrequency.channels "qiskit.pulse.instructions.SetFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.SetFrequency.duration "qiskit.pulse.instructions.SetFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.instructions.SetFrequency.frequency "qiskit.pulse.instructions.SetFrequency.frequency") | New frequency. | -| [`id`](#qiskit.pulse.instructions.SetFrequency.id "qiskit.pulse.instructions.SetFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.SetFrequency.instructions "qiskit.pulse.instructions.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.SetFrequency.name "qiskit.pulse.instructions.SetFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.SetFrequency.operands "qiskit.pulse.instructions.SetFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.SetFrequency.parameters "qiskit.pulse.instructions.SetFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.SetFrequency.start_time "qiskit.pulse.instructions.SetFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.SetFrequency.stop_time "qiskit.pulse.instructions.SetFrequency.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.SetFrequency.channel "qiskit.pulse.instructions.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.SetFrequency.channels "qiskit.pulse.instructions.SetFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.SetFrequency.duration "qiskit.pulse.instructions.SetFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.instructions.SetFrequency.frequency "qiskit.pulse.instructions.SetFrequency.frequency") | New frequency. | +| [`id`](#qiskit.pulse.instructions.SetFrequency.id "qiskit.pulse.instructions.SetFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.SetFrequency.instructions "qiskit.pulse.instructions.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.SetFrequency.name "qiskit.pulse.instructions.SetFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.SetFrequency.operands "qiskit.pulse.instructions.SetFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.SetFrequency.parameters "qiskit.pulse.instructions.SetFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.SetFrequency.start_time "qiskit.pulse.instructions.SetFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.SetFrequency.stop_time "qiskit.pulse.instructions.SetFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.md index 17d4a27e86f..5a9fdb8ecc8 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.SetPhase.md @@ -27,7 +27,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -62,19 +62,19 @@ Instantiate a set phase instruction, setting the output signal phase on `channel ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.SetPhase.channel "qiskit.pulse.instructions.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.SetPhase.channels "qiskit.pulse.instructions.SetPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.SetPhase.duration "qiskit.pulse.instructions.SetPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.SetPhase.id "qiskit.pulse.instructions.SetPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.SetPhase.instructions "qiskit.pulse.instructions.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.SetPhase.name "qiskit.pulse.instructions.SetPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.SetPhase.operands "qiskit.pulse.instructions.SetPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.SetPhase.parameters "qiskit.pulse.instructions.SetPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.instructions.SetPhase.phase "qiskit.pulse.instructions.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.instructions.SetPhase.start_time "qiskit.pulse.instructions.SetPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.SetPhase.stop_time "qiskit.pulse.instructions.SetPhase.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.SetPhase.channel "qiskit.pulse.instructions.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.SetPhase.channels "qiskit.pulse.instructions.SetPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.SetPhase.duration "qiskit.pulse.instructions.SetPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.SetPhase.id "qiskit.pulse.instructions.SetPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.SetPhase.instructions "qiskit.pulse.instructions.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.SetPhase.name "qiskit.pulse.instructions.SetPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.SetPhase.operands "qiskit.pulse.instructions.SetPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.SetPhase.parameters "qiskit.pulse.instructions.SetPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.instructions.SetPhase.phase "qiskit.pulse.instructions.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.instructions.SetPhase.start_time "qiskit.pulse.instructions.SetPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.SetPhase.stop_time "qiskit.pulse.instructions.SetPhase.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.md index 33d44d93c0b..c1068485c86 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftFrequency.md @@ -19,7 +19,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -33,7 +33,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -54,19 +54,19 @@ Creates a new shift frequency instruction. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.ShiftFrequency.channel "qiskit.pulse.instructions.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.ShiftFrequency.channels "qiskit.pulse.instructions.ShiftFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.ShiftFrequency.duration "qiskit.pulse.instructions.ShiftFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.instructions.ShiftFrequency.frequency "qiskit.pulse.instructions.ShiftFrequency.frequency") | Frequency shift from the set frequency. | -| [`id`](#qiskit.pulse.instructions.ShiftFrequency.id "qiskit.pulse.instructions.ShiftFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.ShiftFrequency.instructions "qiskit.pulse.instructions.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.ShiftFrequency.name "qiskit.pulse.instructions.ShiftFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.ShiftFrequency.operands "qiskit.pulse.instructions.ShiftFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.ShiftFrequency.parameters "qiskit.pulse.instructions.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.ShiftFrequency.start_time "qiskit.pulse.instructions.ShiftFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.ShiftFrequency.stop_time "qiskit.pulse.instructions.ShiftFrequency.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.ShiftFrequency.channel "qiskit.pulse.instructions.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.ShiftFrequency.channels "qiskit.pulse.instructions.ShiftFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.ShiftFrequency.duration "qiskit.pulse.instructions.ShiftFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.instructions.ShiftFrequency.frequency "qiskit.pulse.instructions.ShiftFrequency.frequency") | Frequency shift from the set frequency. | +| [`id`](#qiskit.pulse.instructions.ShiftFrequency.id "qiskit.pulse.instructions.ShiftFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.ShiftFrequency.instructions "qiskit.pulse.instructions.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.ShiftFrequency.name "qiskit.pulse.instructions.ShiftFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.ShiftFrequency.operands "qiskit.pulse.instructions.ShiftFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.ShiftFrequency.parameters "qiskit.pulse.instructions.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.ShiftFrequency.start_time "qiskit.pulse.instructions.ShiftFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.ShiftFrequency.stop_time "qiskit.pulse.instructions.ShiftFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -163,11 +163,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -179,7 +179,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -202,7 +202,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.md index 13dd0abcc7e..b45bb0b93df 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase `ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") -The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. +The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -29,7 +29,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -43,7 +43,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -64,19 +64,19 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.ShiftPhase.channel "qiskit.pulse.instructions.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.ShiftPhase.channels "qiskit.pulse.instructions.ShiftPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.ShiftPhase.duration "qiskit.pulse.instructions.ShiftPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.ShiftPhase.id "qiskit.pulse.instructions.ShiftPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.ShiftPhase.instructions "qiskit.pulse.instructions.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.ShiftPhase.name "qiskit.pulse.instructions.ShiftPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.ShiftPhase.operands "qiskit.pulse.instructions.ShiftPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.ShiftPhase.parameters "qiskit.pulse.instructions.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.instructions.ShiftPhase.phase "qiskit.pulse.instructions.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.instructions.ShiftPhase.start_time "qiskit.pulse.instructions.ShiftPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.ShiftPhase.stop_time "qiskit.pulse.instructions.ShiftPhase.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.ShiftPhase.channel "qiskit.pulse.instructions.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.ShiftPhase.channels "qiskit.pulse.instructions.ShiftPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.ShiftPhase.duration "qiskit.pulse.instructions.ShiftPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.ShiftPhase.id "qiskit.pulse.instructions.ShiftPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.ShiftPhase.instructions "qiskit.pulse.instructions.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.ShiftPhase.name "qiskit.pulse.instructions.ShiftPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.ShiftPhase.operands "qiskit.pulse.instructions.ShiftPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.ShiftPhase.parameters "qiskit.pulse.instructions.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.instructions.ShiftPhase.phase "qiskit.pulse.instructions.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.instructions.ShiftPhase.start_time "qiskit.pulse.instructions.ShiftPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.ShiftPhase.stop_time "qiskit.pulse.instructions.ShiftPhase.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.md index 0ebe58c1869..12fd63f17a1 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.Snapshot.md @@ -62,20 +62,20 @@ Create new snapshot. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Snapshot.channel "qiskit.pulse.instructions.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | -| [`channels`](#qiskit.pulse.instructions.Snapshot.channels "qiskit.pulse.instructions.Snapshot.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Snapshot.duration "qiskit.pulse.instructions.Snapshot.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Snapshot.id "qiskit.pulse.instructions.Snapshot.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Snapshot.instructions "qiskit.pulse.instructions.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | -| [`label`](#qiskit.pulse.instructions.Snapshot.label "qiskit.pulse.instructions.Snapshot.label") | Label of snapshot. | -| [`name`](#qiskit.pulse.instructions.Snapshot.name "qiskit.pulse.instructions.Snapshot.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Snapshot.operands "qiskit.pulse.instructions.Snapshot.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Snapshot.parameters "qiskit.pulse.instructions.Snapshot.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.Snapshot.start_time "qiskit.pulse.instructions.Snapshot.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Snapshot.stop_time "qiskit.pulse.instructions.Snapshot.stop_time") | Relative end time of this instruction. | -| [`type`](#qiskit.pulse.instructions.Snapshot.type "qiskit.pulse.instructions.Snapshot.type") | Type of snapshot. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`channel`](#qiskit.pulse.instructions.Snapshot.channel "qiskit.pulse.instructions.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | +| [`channels`](#qiskit.pulse.instructions.Snapshot.channels "qiskit.pulse.instructions.Snapshot.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Snapshot.duration "qiskit.pulse.instructions.Snapshot.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Snapshot.id "qiskit.pulse.instructions.Snapshot.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Snapshot.instructions "qiskit.pulse.instructions.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | +| [`label`](#qiskit.pulse.instructions.Snapshot.label "qiskit.pulse.instructions.Snapshot.label") | Label of snapshot. | +| [`name`](#qiskit.pulse.instructions.Snapshot.name "qiskit.pulse.instructions.Snapshot.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Snapshot.operands "qiskit.pulse.instructions.Snapshot.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Snapshot.parameters "qiskit.pulse.instructions.Snapshot.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.Snapshot.start_time "qiskit.pulse.instructions.Snapshot.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Snapshot.stop_time "qiskit.pulse.instructions.Snapshot.stop_time") | Relative end time of this instruction. | +| [`type`](#qiskit.pulse.instructions.Snapshot.type "qiskit.pulse.instructions.Snapshot.type") | Type of snapshot. | ### append @@ -172,11 +172,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** -[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel") +[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel") ### channels @@ -188,7 +188,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel")] +`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel")] ### draw @@ -211,7 +211,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.26/qiskit.pulse.instructions.md b/docs/api/qiskit/0.26/qiskit.pulse.instructions.md index 02154d7c1ba..b3eda3b77e3 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.instructions.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.instructions.md @@ -1,10 +1,18 @@ +--- +title: instructions +description: API reference for qiskit.pulse.instructions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.instructions +--- + # qiskit.pulse.instructions -The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") specifying where the instruction will be applied. +The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") specifying where the instruction will be applied. -Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") `channel`: +Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") `channel`: ```python ShiftPhase(phase, channel) @@ -18,20 +26,21 @@ Delay(duration, channel) An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), which is a sequence of scheduled Pulse `Instruction` s over many channels. `Instruction` s and `Schedule` s implement the same interface. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | -| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | -| [`SetPhase`](qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | -| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | -| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | +| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | +| [`SetPhase`](qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | +| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). | +| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Abstract Classes | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`Instruction`](qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | + diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.26/qiskit.pulse.library.discrete.md index 568035037a8..4d8938de123 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.discrete.md @@ -1,9 +1,9 @@ --- -title: constant -description: API reference for qiskit.pulse.library.discrete.constant +title: discrete +description: API reference for qiskit.pulse.library.discrete in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.pulse.library.discrete.constant +python_api_type: module +python_api_name: qiskit.pulse.library.discrete --- diff --git a/docs/api/qiskit/0.26/qiskit.pulse.library.md b/docs/api/qiskit/0.26/qiskit.pulse.library.md index 988f5119861..d449fa5d283 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.library.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.library.md @@ -1,3 +1,11 @@ +--- +title: library +description: API reference for qiskit.pulse.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library +--- + # qiskit.pulse.library @@ -18,3 +26,4 @@ The parametric pulses, [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse. | [`Drag`](qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | | [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | | [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma, width) | A square pulse with a Gaussian shaped risefall on either side: | + diff --git a/docs/api/qiskit/0.26/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.26/qiskit.pulse.transforms.pad.md index 9b7de703646..c895d5da79f 100644 --- a/docs/api/qiskit/0.26/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.26/qiskit.pulse.transforms.pad.md @@ -17,7 +17,7 @@ Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedu **Parameters** * **schedule** (`Schedule`) – Schedule to pad. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Channels to pad. Defaults to all channels in `schedule` if not provided. If the supplied channel is not a member of `schedule` it will be added. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Channels to pad. Defaults to all channels in `schedule` if not provided. If the supplied channel is not a member of `schedule` it will be added. * **until** (`Optional`\[`int`]) – Time to pad until. Defaults to `schedule.duration` if not provided. * **inplace** (`bool`) – Pad this schedule by mutating rather than returning a new schedule. diff --git a/docs/api/qiskit/0.26/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.26/qiskit.scheduler.methods.basic.md index c686aa04f3d..27cd8d0ce83 100644 --- a/docs/api/qiskit/0.26/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.26/qiskit.scheduler.methods.basic.md @@ -1,9 +1,9 @@ --- -title: as_late_as_possible -description: API reference for qiskit.scheduler.methods.basic.as_late_as_possible +title: basic +description: API reference for qiskit.scheduler.methods.basic in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.scheduler.methods.basic.as_late_as_possible +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic --- diff --git a/docs/api/qiskit/0.26/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.26/qiskit.scheduler.schedule_circuit.md index 5c0025e87b0..1b7bc625d39 100644 --- a/docs/api/qiskit/0.26/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.26/qiskit.scheduler.schedule_circuit.md @@ -1,9 +1,9 @@ --- title: schedule_circuit -description: API reference for qiskit.scheduler.schedule_circuit.schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.scheduler.schedule_circuit.schedule_circuit +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit --- diff --git a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.draw.md index bc500f963dc..b4e9777903d 100644 --- a/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.26/qiskit.visualization.pulse_v2.draw.md @@ -26,7 +26,7 @@ Generate visualization data for pulse programs. * **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list is not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list is not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. diff --git a/docs/api/qiskit/0.27/_toc.json b/docs/api/qiskit/0.27/_toc.json index 4f98a90e411..908282406be 100644 --- a/docs/api/qiskit/0.27/_toc.json +++ b/docs/api/qiskit/0.27/_toc.json @@ -1740,34 +1740,6 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.27/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.27/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.27/qiskit.circuit.library.Barrier" - }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CCXGate" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.27/qiskit.circuit.ClassicalRegister" @@ -1776,214 +1748,22 @@ "title": "Clbit", "url": "/api/qiskit/0.27/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_8_3" - }, { "title": "ControlledGate", "url": "/api/qiskit/0.27/qiskit.circuit.ControlledGate" }, - { - "title": "CPhaseGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CSwapGate" - }, - { - "title": "CSXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CSXGate" - }, - { - "title": "CU1Gate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CU1Gate" - }, - { - "title": "CU3Gate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CU3Gate" - }, - { - "title": "CUGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CUGate" - }, - { - "title": "CXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CXGate" - }, - { - "title": "CYGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CYGate" - }, - { - "title": "CZGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.CZGate" - }, - { - "title": "DCXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.DCXGate" - }, { "title": "Delay", "url": "/api/qiskit/0.27/qiskit.circuit.Delay" }, - { - "title": "Diagonal", - "url": "/api/qiskit/0.27/qiskit.circuit.library.Diagonal" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.EfficientSU2" - }, { "title": "EquivalenceLibrary", "url": "/api/qiskit/0.27/qiskit.circuit.EquivalenceLibrary" }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.27/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.27/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.27/qiskit.circuit.library.FunctionalPauliRotations" - }, { "title": "Gate", "url": "/api/qiskit/0.27/qiskit.circuit.Gate" }, - { - "title": "GMS", - "url": "/api/qiskit/0.27/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.27/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.27/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.27/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.27/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.27/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.27/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.27/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.27/qiskit.circuit.library.InnerProduct" - }, { "title": "Instruction", "url": "/api/qiskit/0.27/qiskit.circuit.Instruction" @@ -1992,82 +1772,10 @@ "title": "InstructionSet", "url": "/api/qiskit/0.27/qiskit.circuit.InstructionSet" }, - { - "title": "IntegerComparator", - "url": "/api/qiskit/0.27/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.27/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.27/qiskit.circuit.library.LinearAmplitudeFunction" - }, - { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.27/qiskit.circuit.library.LinearPauliRotations" - }, - { - "title": "LogNormalDistribution", - "url": "/api/qiskit/0.27/qiskit.circuit.library.LogNormalDistribution" - }, - { - "title": "MCMT", - "url": "/api/qiskit/0.27/qiskit.circuit.library.MCMT" - }, - { - "title": "MCMTVChain", - "url": "/api/qiskit/0.27/qiskit.circuit.library.MCMTVChain" - }, - { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.MCPhaseGate" - }, - { - "title": "MCXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.MCXGate" - }, - { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.27/qiskit.circuit.library.MCXGrayCode" - }, - { - "title": "MCXRecursive", - "url": "/api/qiskit/0.27/qiskit.circuit.library.MCXRecursive" - }, - { - "title": "MCXVChain", - "url": "/api/qiskit/0.27/qiskit.circuit.library.MCXVChain" - }, { "title": "Measure", "url": "/api/qiskit/0.27/qiskit.circuit.Measure" }, - { - "title": "Measure", - "url": "/api/qiskit/0.27/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.27/qiskit.circuit.library.NLocal" - }, - { - "title": "NormalDistribution", - "url": "/api/qiskit/0.27/qiskit.circuit.library.NormalDistribution" - }, - { - "title": "OR", - "url": "/api/qiskit/0.27/qiskit.circuit.library.OR" - }, { "title": "Parameter", "url": "/api/qiskit/0.27/qiskit.circuit.Parameter" @@ -2080,58 +1788,6 @@ "title": "ParameterVector", "url": "/api/qiskit/0.27/qiskit.circuit.ParameterVector" }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.27/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.27/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.27/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.27/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.27/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.27/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.27/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.27/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.27/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.27/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.27/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.27/qiskit.circuit.library.QuadraticForm" - }, { "title": "QuantumCircuit", "url": "/api/qiskit/0.27/qiskit.circuit.QuantumCircuit" @@ -2140,10 +1796,6 @@ "title": "QuantumRegister", "url": "/api/qiskit/0.27/qiskit.circuit.QuantumRegister" }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.27/qiskit.circuit.library.QuantumVolume" - }, { "title": "Qubit", "url": "/api/qiskit/0.27/qiskit.circuit.Qubit" @@ -2152,376 +1804,733 @@ "title": "random_circuit", "url": "/api/qiskit/0.27/qiskit.circuit.random.random_circuit" }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RealAmplitudes" - }, { "title": "Reset", "url": "/api/qiskit/0.27/qiskit.circuit.Reset" }, { - "title": "Reset", - "url": "/api/qiskit/0.27/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RGate" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.SGate" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_1" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.27/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.27/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.27/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.UGate" - }, - { - "title": "UniformDistribution", - "url": "/api/qiskit/0.27/qiskit.circuit.library.UniformDistribution" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.27/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.27/qiskit.circuit.library.XOR" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.27/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.27/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.27/qiskit.circuit.library.ZZFeatureMap" - }, - { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.27/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.27/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.27/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.27/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CCXGate" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.27/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.27/qiskit.circuit.library.Diagonal" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.27/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.27/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.27/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.27/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.27/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.27/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.27/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.27/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.27/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.27/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.27/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.27/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.27/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.27/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.27/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.27/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "LogNormalDistribution", + "url": "/api/qiskit/0.27/qiskit.circuit.library.LogNormalDistribution" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.27/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.27/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.27/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.27/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.27/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.27/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.27/qiskit.circuit.library.NLocal" + }, + { + "title": "NormalDistribution", + "url": "/api/qiskit/0.27/qiskit.circuit.library.NormalDistribution" + }, + { + "title": "OR", + "url": "/api/qiskit/0.27/qiskit.circuit.library.OR" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.27/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.27/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.27/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.27/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.27/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.27/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.27/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.27/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.27/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.27/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.27/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.27/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.27/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.27/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RGate" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.27/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.SGate" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.27/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "SwapGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.SwapGate" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "SXdgGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.SXdgGate" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "SXGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.SXGate" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.27/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "TdgGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.27/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.27/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.U2Gate" + }, + { + "title": "U3Gate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.U3Gate" + }, + { + "title": "UGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.UGate" + }, + { + "title": "UniformDistribution", + "url": "/api/qiskit/0.27/qiskit.circuit.library.UniformDistribution" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.27/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.27/qiskit.circuit.library.XOR" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.27/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.27/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.27/qiskit.circuit.library.ZZFeatureMap" } ] } @@ -2681,11 +2690,11 @@ "url": "/api/qiskit/0.27/qiskit.finance.applications.ising" }, { - "title": "get_operator", + "title": "qiskit.finance.applications.ising.portfolio", "url": "/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio" }, { - "title": "get_operator", + "title": "qiskit.finance.applications.ising.portfolio_diversification", "url": "/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio_diversification" } ] @@ -3123,6 +3132,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.27/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.27/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.27/qiskit.ignis.verification.QOTP" @@ -3645,56 +3658,56 @@ "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising" }, { - "title": "check_disjoint", - "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.set_packing" + "title": "qiskit.optimization.applications.ising.clique", + "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.clique" }, { - "title": "check_full_edge_coverage", - "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.vertex_cover" + "title": "qiskit.optimization.applications.ising.common", + "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.common" }, { - "title": "check_solution_satisfiability", - "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.exact_cover" + "title": "qiskit.optimization.applications.ising.docplex", + "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.docplex" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.clique" + "title": "qiskit.optimization.applications.ising.exact_cover", + "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.exact_cover" }, { - "title": "get_graph_solution", + "title": "qiskit.optimization.applications.ising.graph_partition", "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.graph_partition" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.max_cut" + "title": "qiskit.optimization.applications.ising.knapsack", + "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.knapsack" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.stable_set" + "title": "qiskit.optimization.applications.ising.max_cut", + "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.max_cut" }, { - "title": "get_gset_result", - "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.common" + "title": "qiskit.optimization.applications.ising.partition", + "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.partition" }, { - "title": "get_operator", - "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.docplex" + "title": "qiskit.optimization.applications.ising.set_packing", + "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.set_packing" }, { - "title": "get_operator", - "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.knapsack" + "title": "qiskit.optimization.applications.ising.stable_set", + "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.stable_set" }, { - "title": "get_operator", - "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.partition" + "title": "qiskit.optimization.applications.ising.tsp", + "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp" }, { - "title": "get_operator", + "title": "qiskit.optimization.applications.ising.vehicle_routing", "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.vehicle_routing" }, { - "title": "TspData", - "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp" + "title": "qiskit.optimization.applications.ising.vertex_cover", + "url": "/api/qiskit/0.27/qiskit.optimization.applications.ising.vertex_cover" } ] } @@ -4620,10 +4633,6 @@ "title": "acquire", "url": "/api/qiskit/0.27/qiskit.pulse.builder.acquire" }, - { - "title": "Acquire", - "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Acquire" - }, { "title": "acquire_channel", "url": "/api/qiskit/0.27/qiskit.pulse.builder.acquire_channel" @@ -4632,10 +4641,6 @@ "title": "AcquireChannel", "url": "/api/qiskit/0.27/qiskit.pulse.AcquireChannel" }, - { - "title": "AcquireChannel", - "url": "/api/qiskit/0.27/qiskit.pulse.channels" - }, { "title": "active_backend", "url": "/api/qiskit/0.27/qiskit.pulse.builder.active_backend" @@ -4692,10 +4697,6 @@ "title": "call", "url": "/api/qiskit/0.27/qiskit.pulse.builder.call" }, - { - "title": "Call", - "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Call" - }, { "title": "circuit_scheduler_settings", "url": "/api/qiskit/0.27/qiskit.pulse.builder.circuit_scheduler_settings" @@ -4704,14 +4705,6 @@ "title": "Constant", "url": "/api/qiskit/0.27/qiskit.pulse.Constant" }, - { - "title": "Constant", - "url": "/api/qiskit/0.27/qiskit.pulse.library.Constant" - }, - { - "title": "constant", - "url": "/api/qiskit/0.27/qiskit.pulse.library.discrete" - }, { "title": "control_channels", "url": "/api/qiskit/0.27/qiskit.pulse.builder.control_channels" @@ -4732,10 +4725,6 @@ "title": "delay", "url": "/api/qiskit/0.27/qiskit.pulse.builder.delay" }, - { - "title": "Delay", - "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Delay" - }, { "title": "delay_qubits", "url": "/api/qiskit/0.27/qiskit.pulse.builder.delay_qubits" @@ -4744,10 +4733,6 @@ "title": "Drag", "url": "/api/qiskit/0.27/qiskit.pulse.Drag" }, - { - "title": "Drag", - "url": "/api/qiskit/0.27/qiskit.pulse.library.Drag" - }, { "title": "drive_channel", "url": "/api/qiskit/0.27/qiskit.pulse.builder.drive_channel" @@ -4764,18 +4749,10 @@ "title": "Gaussian", "url": "/api/qiskit/0.27/qiskit.pulse.Gaussian" }, - { - "title": "Gaussian", - "url": "/api/qiskit/0.27/qiskit.pulse.library.Gaussian" - }, { "title": "GaussianSquare", "url": "/api/qiskit/0.27/qiskit.pulse.GaussianSquare" }, - { - "title": "GaussianSquare", - "url": "/api/qiskit/0.27/qiskit.pulse.library.GaussianSquare" - }, { "title": "inline", "url": "/api/qiskit/0.27/qiskit.pulse.builder.inline" @@ -4784,10 +4761,6 @@ "title": "Instruction", "url": "/api/qiskit/0.27/qiskit.pulse.Instruction" }, - { - "title": "Instruction", - "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Instruction" - }, { "title": "InstructionScheduleMap", "url": "/api/qiskit/0.27/qiskit.pulse.InstructionScheduleMap" @@ -4836,14 +4809,14 @@ "title": "play", "url": "/api/qiskit/0.27/qiskit.pulse.builder.play" }, - { - "title": "Play", - "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Play" - }, { "title": "PulseError", "url": "/api/qiskit/0.27/qiskit.pulse.PulseError" }, + { + "title": "qiskit.pulse.channels", + "url": "/api/qiskit/0.27/qiskit.pulse.channels" + }, { "title": "qubit_channels", "url": "/api/qiskit/0.27/qiskit.pulse.builder.qubit_channels" @@ -4880,18 +4853,10 @@ "title": "SetFrequency", "url": "/api/qiskit/0.27/qiskit.pulse.SetFrequency" }, - { - "title": "SetFrequency", - "url": "/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency" - }, { "title": "SetPhase", "url": "/api/qiskit/0.27/qiskit.pulse.SetPhase" }, - { - "title": "SetPhase", - "url": "/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase" - }, { "title": "shift_frequency", "url": "/api/qiskit/0.27/qiskit.pulse.builder.shift_frequency" @@ -4904,18 +4869,10 @@ "title": "ShiftFrequency", "url": "/api/qiskit/0.27/qiskit.pulse.ShiftFrequency" }, - { - "title": "ShiftFrequency", - "url": "/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency" - }, { "title": "ShiftPhase", "url": "/api/qiskit/0.27/qiskit.pulse.ShiftPhase" }, - { - "title": "ShiftPhase", - "url": "/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase" - }, { "title": "Snapshot", "url": "/api/qiskit/0.27/qiskit.pulse.Snapshot" @@ -4924,10 +4881,6 @@ "title": "snapshot", "url": "/api/qiskit/0.27/qiskit.pulse.builder.snapshot" }, - { - "title": "Snapshot", - "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot" - }, { "title": "transpiler_settings", "url": "/api/qiskit/0.27/qiskit.pulse.builder.transpiler_settings" @@ -4948,13 +4901,91 @@ "title": "Waveform", "url": "/api/qiskit/0.27/qiskit.pulse.Waveform" }, - { - "title": "Waveform", - "url": "/api/qiskit/0.27/qiskit.pulse.library.Waveform" - }, { "title": "x", "url": "/api/qiskit/0.27/qiskit.pulse.builder.x" + }, + { + "title": "qiskit.pulse.instructions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.27/qiskit.pulse.instructions" + }, + { + "title": "Acquire", + "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Acquire" + }, + { + "title": "Call", + "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Call" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Delay" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Instruction" + }, + { + "title": "Play", + "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Play" + }, + { + "title": "SetFrequency", + "url": "/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency" + }, + { + "title": "SetPhase", + "url": "/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase" + }, + { + "title": "ShiftFrequency", + "url": "/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency" + }, + { + "title": "ShiftPhase", + "url": "/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot" + } + ] + }, + { + "title": "qiskit.pulse.library", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.27/qiskit.pulse.library" + }, + { + "title": "Constant", + "url": "/api/qiskit/0.27/qiskit.pulse.library.Constant" + }, + { + "title": "Drag", + "url": "/api/qiskit/0.27/qiskit.pulse.library.Drag" + }, + { + "title": "Gaussian", + "url": "/api/qiskit/0.27/qiskit.pulse.library.Gaussian" + }, + { + "title": "GaussianSquare", + "url": "/api/qiskit/0.27/qiskit.pulse.library.GaussianSquare" + }, + { + "title": "qiskit.pulse.library.discrete", + "url": "/api/qiskit/0.27/qiskit.pulse.library.discrete" + }, + { + "title": "Waveform", + "url": "/api/qiskit/0.27/qiskit.pulse.library.Waveform" + } + ] } ] }, @@ -5298,11 +5329,11 @@ "url": "/api/qiskit/0.27/scheduler" }, { - "title": "as_late_as_possible", + "title": "qiskit.scheduler.methods.basic", "url": "/api/qiskit/0.27/qiskit.scheduler.methods.basic" }, { - "title": "schedule_circuit", + "title": "qiskit.scheduler.schedule_circuit", "url": "/api/qiskit/0.27/qiskit.scheduler.schedule_circuit" }, { diff --git a/docs/api/qiskit/0.27/circuit_library.md b/docs/api/qiskit/0.27/circuit_library.md index 9e5e72f573c..2c693769ddf 100644 --- a/docs/api/qiskit/0.27/circuit_library.md +++ b/docs/api/qiskit/0.27/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -265,3 +277,4 @@ | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.27/pulse.md b/docs/api/qiskit/0.27/pulse.md index 48d27940612..78ad23b5ec2 100644 --- a/docs/api/qiskit/0.27/pulse.md +++ b/docs/api/qiskit/0.27/pulse.md @@ -32,18 +32,18 @@ This is sufficient to allow the quantum physicist to explore and correct for noi `qiskit.pulse.instructions` -| | | -| ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | -| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Call`](qiskit.pulse.Call "qiskit.pulse.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | -| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftFrequency`](qiskit.pulse.ShiftFrequency "qiskit.pulse.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | -| [`SetPhase`](qiskit.pulse.SetPhase "qiskit.pulse.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | -| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | -| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | +| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Call`](qiskit.pulse.Call "qiskit.pulse.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | +| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftFrequency`](qiskit.pulse.ShiftFrequency "qiskit.pulse.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | +| [`SetPhase`](qiskit.pulse.SetPhase "qiskit.pulse.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | +| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). | +| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Pulse Library (waveforms ) @@ -274,11 +274,11 @@ with pulse.build(backend) as measure_sched: MemorySlot(0) ``` -| | | -| ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`measure`](qiskit.pulse.builder.measure "qiskit.pulse.builder.measure")(qubits\[, registers]) | Measure a qubit within the currently active builder context. | -| [`measure_all`](qiskit.pulse.builder.measure_all "qiskit.pulse.builder.measure_all")() | Measure all qubits within the currently active builder context. | -| [`delay_qubits`](qiskit.pulse.builder.delay_qubits "qiskit.pulse.builder.delay_qubits")(duration, \*qubits) | Insert delays on all of the [`channels.Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")s that correspond to the input `qubits` at the same time. | +| | | +| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`measure`](qiskit.pulse.builder.measure "qiskit.pulse.builder.measure")(qubits\[, registers]) | Measure a qubit within the currently active builder context. | +| [`measure_all`](qiskit.pulse.builder.measure_all "qiskit.pulse.builder.measure_all")() | Measure all qubits within the currently active builder context. | +| [`delay_qubits`](qiskit.pulse.builder.delay_qubits "qiskit.pulse.builder.delay_qubits")(duration, \*qubits) | Insert delays on all of the [`channels.Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")s that correspond to the input `qubits` at the same time. | ### Circuit Gates diff --git a/docs/api/qiskit/0.27/qiskit.compiler.assemble.md b/docs/api/qiskit/0.27/qiskit.compiler.assemble.md index e6429dd2655..fb20d988d7e 100644 --- a/docs/api/qiskit/0.27/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.27/qiskit.compiler.assemble.md @@ -42,7 +42,7 @@ This function serializes the payloads, which could be either circuits or schedul * **meas\_lo\_range** (`Optional`\[`List`\[`int`]]) – List of measurement LO ranges each of form `[range_min, range_max]` in Hz. Used to validate the supplied qubit frequencies. -* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. +* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. * **meas\_level** (`Union`\[`int`, `MeasLevel`]) – Set the appropriate level of the measurement output for pulse experiments. diff --git a/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio.md index 6ecac2fa438..82487c60134 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.finance.applications.ising.portfolio.get_operator +title: portfolio +description: API reference for qiskit.finance.applications.ising.portfolio in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.finance.applications.ising.portfolio.get_operator +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio --- diff --git a/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio_diversification.md index 4716f1a56b6..f91ddbb89e1 100644 --- a/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.27/qiskit.finance.applications.ising.portfolio_diversification.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.finance.applications.ising.portfolio_diversification.get_operator +title: portfolio_diversification +description: API reference for qiskit.finance.applications.ising.portfolio_diversification in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.finance.applications.ising.portfolio_diversification.get_operator +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio_diversification --- diff --git a/docs/api/qiskit/0.27/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.27/qiskit.ignis.verification.basis.md index e26610b6708..c7c0137e9f8 100644 --- a/docs/api/qiskit/0.27/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.27/qiskit.ignis.verification.basis.md @@ -1,5 +1,14 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # qiskit.ignis.verification.basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.clique.md index 940c74047fe..c0e4c528922 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.clique.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.clique.get_graph_solution +title: clique +description: API reference for qiskit.optimization.applications.ising.clique in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.clique.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.clique --- diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.common.md index 3392c7d4935..a80b94865a2 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.common.md @@ -1,9 +1,9 @@ --- -title: get_gset_result -description: API reference for qiskit.optimization.applications.ising.common.get_gset_result +title: common +description: API reference for qiskit.optimization.applications.ising.common in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.common.get_gset_result +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.common --- diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.docplex.md index 9ddbec3f2b1..343cc6b736b 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.docplex.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.docplex.get_operator +title: docplex +description: API reference for qiskit.optimization.applications.ising.docplex in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.docplex.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.docplex --- diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.exact_cover.md index 1e7745503a3..6eced2620c4 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.exact_cover.md @@ -1,9 +1,9 @@ --- -title: check_solution_satisfiability -description: API reference for qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability +title: exact_cover +description: API reference for qiskit.optimization.applications.ising.exact_cover in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.exact_cover --- diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.graph_partition.md index c9a4bfb5d3d..2d3f7e88296 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.graph_partition.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.graph_partition.get_graph_solution +title: graph_partition +description: API reference for qiskit.optimization.applications.ising.graph_partition in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.graph_partition.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.graph_partition --- @@ -50,11 +50,11 @@ Generate Hamiltonian for the graph partitioning **Notes** -## Goals: +**Goals:** 1 separate the vertices into two set of the same size 2 make sure the number of edges between the two set is minimized. -## Hamiltonian: +**Hamiltonian:** H = H\_A + H\_B H\_A = sum\_\{(i,j)in E}\{(1-ZiZj)/2} H\_B = (sum\_\{i}\{Zi})^2 = sum\_\{i}\{Zi^2}+sum\_\{i!=j}\{ZiZj} H\_A is for achieving goal 2 and H\_B is for achieving goal 1. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.knapsack.md index aa6c9e7c681..6f9306be50f 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.knapsack.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.knapsack.get_operator +title: knapsack +description: API reference for qiskit.optimization.applications.ising.knapsack in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.knapsack.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.knapsack --- diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.max_cut.md index 03838a55ff8..0f7cd5d4d0f 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.max_cut.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.max_cut.get_graph_solution +title: max_cut +description: API reference for qiskit.optimization.applications.ising.max_cut in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.max_cut.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.max_cut --- diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.partition.md index 2cc12770421..451c7de04e4 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.partition.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.partition.get_operator +title: partition +description: API reference for qiskit.optimization.applications.ising.partition in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.partition.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.partition --- diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.set_packing.md index 50a16bc2e93..6fe5f8562f4 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.set_packing.md @@ -1,9 +1,9 @@ --- -title: check_disjoint -description: API reference for qiskit.optimization.applications.ising.set_packing.check_disjoint +title: set_packing +description: API reference for qiskit.optimization.applications.ising.set_packing in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.set_packing.check_disjoint +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.set_packing --- diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.stable_set.md index e3ea779d063..2f6481bbfd8 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.stable_set.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.stable_set.get_graph_solution +title: stable_set +description: API reference for qiskit.optimization.applications.ising.stable_set in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.stable_set.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.stable_set --- diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.md index bbc3456ab5a..e5f3da7c799 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.md @@ -1,9 +1,9 @@ --- -title: TspData -description: API reference for qiskit.optimization.applications.ising.tsp.TspData +title: tsp +description: API reference for qiskit.optimization.applications.ising.tsp in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.optimization.applications.ising.tsp.TspData +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.tsp --- diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vehicle_routing.md index 41417b86a6a..cb9da8e8f25 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vehicle_routing.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.vehicle_routing.get_operator +title: vehicle_routing +description: API reference for qiskit.optimization.applications.ising.vehicle_routing in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.vehicle_routing.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vehicle_routing --- @@ -72,7 +72,7 @@ objective function value. `get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") -## Constructs auxiliary matrices from a vehicle routing instance, +**Constructs auxiliary matrices from a vehicle routing instance,** which represent the encoding into a binary quadratic program. This is used in the construction of the qubit ops and computation of the solution cost. @@ -96,7 +96,7 @@ a matrix defining the interactions between variables. a matrix defining the cont `get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") -## Tries to obtain a feasible solution (in vector form) of an instance +**Tries to obtain a feasible solution (in vector form) of an instance** of vehicle routing from the results dictionary. @@ -115,7 +115,7 @@ of vehicle routing from the results dictionary. a solution, i.e., a path, in its binary representation. -## #TODO: support statevector simulation, results should be a statevector or counts format, not +**#TODO: support statevector simulation, results should be a statevector or counts format, not** a result from algorithm run diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vertex_cover.md index 50658b90390..5ed46e10885 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.vertex_cover.md @@ -1,9 +1,9 @@ --- -title: check_full_edge_coverage -description: API reference for qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage +title: vertex_cover +description: API reference for qiskit.optimization.applications.ising.vertex_cover in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vertex_cover --- diff --git a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.md index 0699950a1b6..60087735631 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.27/qiskit.providers.ibmq.IBMQBackend.md @@ -457,7 +457,7 @@ If a keyword specified here is also present in the `options` attribute/object, t * **meas\_lo\_freq** (`Optional`\[`List`\[`int`]]) – List of default measurement LO frequencies in Hz. Will be overridden by `schedule_los` if set. -* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. +* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. * **meas\_level** (`Union`\[`int`, `MeasLevel`, `None`]) – Set the appropriate level of the measurement output for pulse experiments. diff --git a/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.md index 33cf18195d9..cf2ea888aa3 100644 --- a/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.27/qiskit.providers.models.PulseBackendConfiguration.md @@ -144,7 +144,7 @@ Return the acquisition channel for the given qubit. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") **Returns** @@ -169,7 +169,7 @@ Return the secondary drive channel for the given qubit – typically utilized fo **Return type** -`List`\[[`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")] +`List`\[[`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")] **Returns** @@ -199,7 +199,7 @@ backend.configuration().describe(ControlChannel(1)) **Parameters** -**channel** ([`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe. +**channel** ([`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe. **Raises** @@ -207,7 +207,7 @@ backend.configuration().describe(ControlChannel(1)) **Return type** -`Dict`\[[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel"), `complex`] +`Dict`\[[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel"), `complex`] **Returns** @@ -227,7 +227,7 @@ Return the drive channel for the given qubit. **Return type** -[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") +[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel") **Returns** @@ -287,7 +287,7 @@ Return a list of channels which operate on the given `qubit`. **Return type** -`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] **Returns** @@ -307,7 +307,7 @@ Return the measure stimulus channel for the given qubit. **Return type** -[`MeasureChannel`](qiskit.pulse.channels#qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") +[`MeasureChannel`](qiskit.pulse.channels#measurechannel "qiskit.pulse.channels.MeasureChannel") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.27/qiskit.pulse.Acquire.md index 57757191057..72f12354374 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Acquire.md @@ -25,9 +25,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -47,9 +47,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -76,23 +76,23 @@ Create a new Acquire instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`acquire`](#qiskit.pulse.Acquire.acquire "qiskit.pulse.Acquire.acquire") | Acquire channel to acquire data. | -| [`channel`](#qiskit.pulse.Acquire.channel "qiskit.pulse.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Acquire.channels "qiskit.pulse.Acquire.channels") | Returns the channels that this schedule uses. | -| [`discriminator`](#qiskit.pulse.Acquire.discriminator "qiskit.pulse.Acquire.discriminator") | Return discrimination settings. | -| [`duration`](#qiskit.pulse.Acquire.duration "qiskit.pulse.Acquire.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Acquire.id "qiskit.pulse.Acquire.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Acquire.instructions "qiskit.pulse.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | -| [`kernel`](#qiskit.pulse.Acquire.kernel "qiskit.pulse.Acquire.kernel") | Return kernel settings. | -| [`mem_slot`](#qiskit.pulse.Acquire.mem_slot "qiskit.pulse.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | -| [`name`](#qiskit.pulse.Acquire.name "qiskit.pulse.Acquire.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Acquire.operands "qiskit.pulse.Acquire.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Acquire.parameters "qiskit.pulse.Acquire.parameters") | Parameters which determine the instruction behavior. | -| [`reg_slot`](#qiskit.pulse.Acquire.reg_slot "qiskit.pulse.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | -| [`start_time`](#qiskit.pulse.Acquire.start_time "qiskit.pulse.Acquire.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Acquire.stop_time "qiskit.pulse.Acquire.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`acquire`](#qiskit.pulse.Acquire.acquire "qiskit.pulse.Acquire.acquire") | Acquire channel to acquire data. | +| [`channel`](#qiskit.pulse.Acquire.channel "qiskit.pulse.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Acquire.channels "qiskit.pulse.Acquire.channels") | Returns the channels that this schedule uses. | +| [`discriminator`](#qiskit.pulse.Acquire.discriminator "qiskit.pulse.Acquire.discriminator") | Return discrimination settings. | +| [`duration`](#qiskit.pulse.Acquire.duration "qiskit.pulse.Acquire.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Acquire.id "qiskit.pulse.Acquire.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Acquire.instructions "qiskit.pulse.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | +| [`kernel`](#qiskit.pulse.Acquire.kernel "qiskit.pulse.Acquire.kernel") | Return kernel settings. | +| [`mem_slot`](#qiskit.pulse.Acquire.mem_slot "qiskit.pulse.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | +| [`name`](#qiskit.pulse.Acquire.name "qiskit.pulse.Acquire.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Acquire.operands "qiskit.pulse.Acquire.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Acquire.parameters "qiskit.pulse.Acquire.parameters") | Parameters which determine the instruction behavior. | +| [`reg_slot`](#qiskit.pulse.Acquire.reg_slot "qiskit.pulse.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | +| [`start_time`](#qiskit.pulse.Acquire.start_time "qiskit.pulse.Acquire.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Acquire.stop_time "qiskit.pulse.Acquire.stop_time") | Relative end time of this instruction. | ### acquire @@ -104,7 +104,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### append @@ -201,11 +201,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### channels @@ -217,7 +217,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]] +`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]] ### discriminator @@ -252,7 +252,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** @@ -366,7 +366,7 @@ The classical memory slot which will store the classified readout result. **Return type** -[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot") +[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot") ### name @@ -414,7 +414,7 @@ The fast-access register slot which will store the classified readout result for **Return type** -[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot") +[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot") ### shift diff --git a/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.md index a900ecc9ee0..7104f339ff5 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.AcquireChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Call.md b/docs/api/qiskit/0.27/qiskit.pulse.Call.md index a433311a9fc..bdb134c5aec 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Call.md @@ -221,7 +221,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -244,7 +244,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.md index e85fea470d2..5dea4fbfbd8 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.ControlChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Delay.md b/docs/api/qiskit/0.27/qiskit.pulse.Delay.md index 98cd332f9b9..a6331b59ac3 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Delay.md @@ -33,7 +33,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ### \_\_init\_\_ @@ -49,7 +49,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ## Methods @@ -70,18 +70,18 @@ No other instruction may be scheduled within a `Delay`. ## Attributes -| | | -| ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Delay.channel "qiskit.pulse.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Delay.channels "qiskit.pulse.Delay.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Delay.duration "qiskit.pulse.Delay.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Delay.id "qiskit.pulse.Delay.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Delay.instructions "qiskit.pulse.Delay.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.Delay.name "qiskit.pulse.Delay.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Delay.operands "qiskit.pulse.Delay.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Delay.parameters "qiskit.pulse.Delay.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.Delay.start_time "qiskit.pulse.Delay.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Delay.stop_time "qiskit.pulse.Delay.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.Delay.channel "qiskit.pulse.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Delay.channels "qiskit.pulse.Delay.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Delay.duration "qiskit.pulse.Delay.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Delay.id "qiskit.pulse.Delay.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Delay.instructions "qiskit.pulse.Delay.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.Delay.name "qiskit.pulse.Delay.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Delay.operands "qiskit.pulse.Delay.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Delay.parameters "qiskit.pulse.Delay.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.Delay.start_time "qiskit.pulse.Delay.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Delay.stop_time "qiskit.pulse.Delay.stop_time") | Relative end time of this instruction. | ### append @@ -178,11 +178,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") ### channels @@ -194,7 +194,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -217,7 +217,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.md index cdd0f40215b..6e0feba01f1 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.DriveChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.27/qiskit.pulse.Instruction.md index 1fddc089976..2c84e0a3425 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Instruction.md @@ -20,7 +20,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -40,7 +40,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -177,7 +177,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -200,7 +200,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.md index 877cea85d05..9d661b317d8 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.MeasureChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.md index e55293d4ec2..0ef342e2e8e 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.MemorySlot.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Play.md b/docs/api/qiskit/0.27/qiskit.pulse.Play.md index 33bb992a1f1..8291004209c 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Play.md @@ -21,7 +21,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -39,7 +39,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -64,19 +64,19 @@ Create a new pulse instruction. ## Attributes -| | | -| ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Play.channel "qiskit.pulse.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Play.channels "qiskit.pulse.Play.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Play.duration "qiskit.pulse.Play.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Play.id "qiskit.pulse.Play.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Play.instructions "qiskit.pulse.Play.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.Play.name "qiskit.pulse.Play.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Play.operands "qiskit.pulse.Play.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Play.parameters "qiskit.pulse.Play.parameters") | Parameters which determine the instruction behavior. | -| [`pulse`](#qiskit.pulse.Play.pulse "qiskit.pulse.Play.pulse") | A description of the samples that will be played. | -| [`start_time`](#qiskit.pulse.Play.start_time "qiskit.pulse.Play.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Play.stop_time "qiskit.pulse.Play.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.Play.channel "qiskit.pulse.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Play.channels "qiskit.pulse.Play.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Play.duration "qiskit.pulse.Play.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Play.id "qiskit.pulse.Play.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Play.instructions "qiskit.pulse.Play.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.Play.name "qiskit.pulse.Play.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Play.operands "qiskit.pulse.Play.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Play.parameters "qiskit.pulse.Play.parameters") | Parameters which determine the instruction behavior. | +| [`pulse`](#qiskit.pulse.Play.pulse "qiskit.pulse.Play.pulse") | A description of the samples that will be played. | +| [`start_time`](#qiskit.pulse.Play.start_time "qiskit.pulse.Play.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Play.stop_time "qiskit.pulse.Play.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.md index 1eb46da4a4f..7a8e1fca2fa 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.RegisterSlot.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.27/qiskit.pulse.Schedule.md index 9ea2dd3651f..9b92cfab1ab 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Schedule.md @@ -221,7 +221,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -241,7 +241,7 @@ Plot the schedule. * **time\_unit** (`str`) – The unit of specified time range either dt or ns. The unit of ns is available only when backend object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. @@ -324,7 +324,7 @@ self.filter(args) | self.exclude(args) == self **Parameters** * **filter\_funcs** (`Callable`) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -347,7 +347,7 @@ If no arguments are provided, `self` is returned. **Parameters** * **filter\_funcs** (`Callable`) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -585,5 +585,5 @@ Time keeping attribute. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.md index a22dd073c4a..5164eaef864 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.ScheduleBlock.md @@ -237,7 +237,7 @@ Returns channels that this schedule clock uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -257,7 +257,7 @@ Plot the schedule. * **time\_unit** (`str`) – The unit of specified time range either dt or ns. The unit of ns is available only when backend object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. @@ -344,7 +344,7 @@ self.filter(args) | self.exclude(args) == self **Parameters** * **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -375,7 +375,7 @@ If no arguments are provided, `self` is returned. **Parameters** * **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -586,5 +586,5 @@ Time keeping attribute. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] diff --git a/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.md index e0ebe7c915f..3df4a86fda5 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.SetFrequency.md @@ -27,7 +27,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -62,19 +62,19 @@ Creates a new set channel frequency instruction. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.SetFrequency.channel "qiskit.pulse.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.SetFrequency.channels "qiskit.pulse.SetFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.SetFrequency.duration "qiskit.pulse.SetFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.SetFrequency.frequency "qiskit.pulse.SetFrequency.frequency") | New frequency. | -| [`id`](#qiskit.pulse.SetFrequency.id "qiskit.pulse.SetFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.SetFrequency.instructions "qiskit.pulse.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.SetFrequency.name "qiskit.pulse.SetFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.SetFrequency.operands "qiskit.pulse.SetFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.SetFrequency.parameters "qiskit.pulse.SetFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.SetFrequency.start_time "qiskit.pulse.SetFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.SetFrequency.stop_time "qiskit.pulse.SetFrequency.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.SetFrequency.channel "qiskit.pulse.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.SetFrequency.channels "qiskit.pulse.SetFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.SetFrequency.duration "qiskit.pulse.SetFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.SetFrequency.frequency "qiskit.pulse.SetFrequency.frequency") | New frequency. | +| [`id`](#qiskit.pulse.SetFrequency.id "qiskit.pulse.SetFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.SetFrequency.instructions "qiskit.pulse.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.SetFrequency.name "qiskit.pulse.SetFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.SetFrequency.operands "qiskit.pulse.SetFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.SetFrequency.parameters "qiskit.pulse.SetFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.SetFrequency.start_time "qiskit.pulse.SetFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.SetFrequency.stop_time "qiskit.pulse.SetFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.md index 3803f04c4e7..1aceeec1749 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.SetPhase.md @@ -27,7 +27,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -62,19 +62,19 @@ Instantiate a set phase instruction, setting the output signal phase on `channel ## Attributes -| | | -| ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.SetPhase.channel "qiskit.pulse.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.SetPhase.channels "qiskit.pulse.SetPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.SetPhase.duration "qiskit.pulse.SetPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.SetPhase.id "qiskit.pulse.SetPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.SetPhase.instructions "qiskit.pulse.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.SetPhase.name "qiskit.pulse.SetPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.SetPhase.operands "qiskit.pulse.SetPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.SetPhase.parameters "qiskit.pulse.SetPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.SetPhase.phase "qiskit.pulse.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.SetPhase.start_time "qiskit.pulse.SetPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.SetPhase.stop_time "qiskit.pulse.SetPhase.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.SetPhase.channel "qiskit.pulse.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.SetPhase.channels "qiskit.pulse.SetPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.SetPhase.duration "qiskit.pulse.SetPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.SetPhase.id "qiskit.pulse.SetPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.SetPhase.instructions "qiskit.pulse.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.SetPhase.name "qiskit.pulse.SetPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.SetPhase.operands "qiskit.pulse.SetPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.SetPhase.parameters "qiskit.pulse.SetPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.SetPhase.phase "qiskit.pulse.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.SetPhase.start_time "qiskit.pulse.SetPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.SetPhase.stop_time "qiskit.pulse.SetPhase.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.md index 9ca7e8efe13..33c38b6d65b 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.ShiftFrequency.md @@ -19,7 +19,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -33,7 +33,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -54,19 +54,19 @@ Creates a new shift frequency instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.ShiftFrequency.channel "qiskit.pulse.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.ShiftFrequency.channels "qiskit.pulse.ShiftFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.ShiftFrequency.duration "qiskit.pulse.ShiftFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.ShiftFrequency.frequency "qiskit.pulse.ShiftFrequency.frequency") | Frequency shift from the set frequency. | -| [`id`](#qiskit.pulse.ShiftFrequency.id "qiskit.pulse.ShiftFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.ShiftFrequency.instructions "qiskit.pulse.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.ShiftFrequency.name "qiskit.pulse.ShiftFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.ShiftFrequency.operands "qiskit.pulse.ShiftFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.ShiftFrequency.parameters "qiskit.pulse.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.ShiftFrequency.start_time "qiskit.pulse.ShiftFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.ShiftFrequency.stop_time "qiskit.pulse.ShiftFrequency.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.ShiftFrequency.channel "qiskit.pulse.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.ShiftFrequency.channels "qiskit.pulse.ShiftFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.ShiftFrequency.duration "qiskit.pulse.ShiftFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.ShiftFrequency.frequency "qiskit.pulse.ShiftFrequency.frequency") | Frequency shift from the set frequency. | +| [`id`](#qiskit.pulse.ShiftFrequency.id "qiskit.pulse.ShiftFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.ShiftFrequency.instructions "qiskit.pulse.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.ShiftFrequency.name "qiskit.pulse.ShiftFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.ShiftFrequency.operands "qiskit.pulse.ShiftFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.ShiftFrequency.parameters "qiskit.pulse.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.ShiftFrequency.start_time "qiskit.pulse.ShiftFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.ShiftFrequency.stop_time "qiskit.pulse.ShiftFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -163,11 +163,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -179,7 +179,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -202,7 +202,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.md index 91fd767940e..8cb59125556 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.ShiftPhase `ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") -The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. +The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -29,7 +29,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -43,7 +43,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -64,19 +64,19 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch ## Attributes -| | | -| ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.ShiftPhase.channel "qiskit.pulse.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.ShiftPhase.channels "qiskit.pulse.ShiftPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.ShiftPhase.duration "qiskit.pulse.ShiftPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.ShiftPhase.id "qiskit.pulse.ShiftPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.ShiftPhase.instructions "qiskit.pulse.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.ShiftPhase.name "qiskit.pulse.ShiftPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.ShiftPhase.operands "qiskit.pulse.ShiftPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.ShiftPhase.parameters "qiskit.pulse.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.ShiftPhase.phase "qiskit.pulse.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.ShiftPhase.start_time "qiskit.pulse.ShiftPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.ShiftPhase.stop_time "qiskit.pulse.ShiftPhase.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.ShiftPhase.channel "qiskit.pulse.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.ShiftPhase.channels "qiskit.pulse.ShiftPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.ShiftPhase.duration "qiskit.pulse.ShiftPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.ShiftPhase.id "qiskit.pulse.ShiftPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.ShiftPhase.instructions "qiskit.pulse.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.ShiftPhase.name "qiskit.pulse.ShiftPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.ShiftPhase.operands "qiskit.pulse.ShiftPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.ShiftPhase.parameters "qiskit.pulse.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.ShiftPhase.phase "qiskit.pulse.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.ShiftPhase.start_time "qiskit.pulse.ShiftPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.ShiftPhase.stop_time "qiskit.pulse.ShiftPhase.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.md index 774df87cbeb..a94951dbe72 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.Snapshot.md @@ -62,20 +62,20 @@ Create new snapshot. ## Attributes -| | | -| ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Snapshot.channel "qiskit.pulse.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | -| [`channels`](#qiskit.pulse.Snapshot.channels "qiskit.pulse.Snapshot.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Snapshot.duration "qiskit.pulse.Snapshot.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Snapshot.id "qiskit.pulse.Snapshot.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Snapshot.instructions "qiskit.pulse.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | -| [`label`](#qiskit.pulse.Snapshot.label "qiskit.pulse.Snapshot.label") | Label of snapshot. | -| [`name`](#qiskit.pulse.Snapshot.name "qiskit.pulse.Snapshot.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Snapshot.operands "qiskit.pulse.Snapshot.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Snapshot.parameters "qiskit.pulse.Snapshot.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.Snapshot.start_time "qiskit.pulse.Snapshot.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Snapshot.stop_time "qiskit.pulse.Snapshot.stop_time") | Relative end time of this instruction. | -| [`type`](#qiskit.pulse.Snapshot.type "qiskit.pulse.Snapshot.type") | Type of snapshot. | +| | | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`channel`](#qiskit.pulse.Snapshot.channel "qiskit.pulse.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | +| [`channels`](#qiskit.pulse.Snapshot.channels "qiskit.pulse.Snapshot.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Snapshot.duration "qiskit.pulse.Snapshot.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Snapshot.id "qiskit.pulse.Snapshot.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Snapshot.instructions "qiskit.pulse.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | +| [`label`](#qiskit.pulse.Snapshot.label "qiskit.pulse.Snapshot.label") | Label of snapshot. | +| [`name`](#qiskit.pulse.Snapshot.name "qiskit.pulse.Snapshot.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Snapshot.operands "qiskit.pulse.Snapshot.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Snapshot.parameters "qiskit.pulse.Snapshot.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.Snapshot.start_time "qiskit.pulse.Snapshot.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Snapshot.stop_time "qiskit.pulse.Snapshot.stop_time") | Relative end time of this instruction. | +| [`type`](#qiskit.pulse.Snapshot.type "qiskit.pulse.Snapshot.type") | Type of snapshot. | ### append @@ -172,11 +172,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** -[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel") +[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel") ### channels @@ -188,7 +188,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel")] +`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel")] ### draw @@ -211,7 +211,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire.md index c29a43a028c..ba6fd3cb433 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire.md @@ -37,8 +37,8 @@ with pulse.build() as pulse_prog: **Parameters** * **duration** (`int`) – Duration to acquire data for -* **qubit\_or\_channel** (`Union`\[`int`, [`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")]) – Either the qubit to acquire data for or the specific [`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") to acquire on. -* **register** (`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])) – Location to store measured result. +* **qubit\_or\_channel** (`Union`\[`int`, [`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")]) – Either the qubit to acquire data for or the specific [`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") to acquire on. +* **register** (`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])) – Location to store measured result. * **metadata** (`Union`\[`Kernel`, `Discriminator`]) – Additional metadata for measurement. See [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire") for more information. **Raises** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire_channel.md index 9d89d34e805..d5543331cb8 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.acquire_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.barrier.md index d601ffe8ea5..3a7c88ca5df 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.barrier.md @@ -70,6 +70,6 @@ with pulse.build(backend) as pulse_prog: **Parameters** -* **channels\_or\_qubits** (`Union`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `int`]) – Channels or qubits to barrier. +* **channels\_or\_qubits** (`Union`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `int`]) – Channels or qubits to barrier. * **name** (`Optional`\[`str`]) – Name for the barrier diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.control_channels.md index 03fd5fd8895..fbe9d517782 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.control_channels.md @@ -37,7 +37,7 @@ with pulse.build(backend): **Return type** -`List`\[[`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")] +`List`\[[`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")] **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.delay.md index 5fc92f807ea..4f61e2869d0 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.delay.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **duration** (`int`) – Number of cycles to delay for on `channel`. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Channel to delay on. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – Channel to delay on. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.drive_channel.md index 5f9a92776f2..830b1f50e7a 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.drive_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") +[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel") diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.frequency_offset.md index e4baa1c0066..d3f825feb9f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.frequency_offset.md @@ -41,7 +41,7 @@ assert len(pulse_prog.instructions) == 4 **Parameters** * **frequency** (`float`) – Amount of frequency offset in Hz. -* **channels** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset frequency of. +* **channels** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset frequency of. * **compensate\_phase** (`bool`) – Compensate for accumulated phase accumulated with respect to the channels’ frame at its initial frequency. **Yields** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure.md index 91d347215d2..d172ff13c74 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure.md @@ -53,11 +53,11 @@ assert reg == mem0 **Parameters** * **qubits** (`Union`\[`List`\[`int`], `int`]) – Physical qubit to measure. -* **registers** (`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]), `None`]) – Register to store result in. If not selected the current behavior is to return the `MemorySlot` with the same index as `qubit`. This register will be returned. +* **registers** (`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]), `None`]) – Register to store result in. If not selected the current behavior is to return the `MemorySlot` with the same index as `qubit`. This register will be returned. **Return type** -`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])] +`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])] **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_all.md index d7bacde24b2..1d3bf31c2ad 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_all.md @@ -35,7 +35,7 @@ with pulse.build(backend) as pulse_prog: **Return type** -`List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")] +`List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")] **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_channel.md index 03feb981bff..3d2b1732509 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.measure_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`MeasureChannel`](qiskit.pulse.channels#qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") +[`MeasureChannel`](qiskit.pulse.channels#measurechannel "qiskit.pulse.channels.MeasureChannel") diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.pad.md index e7ff49c34b5..1a6ad5573bb 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.pad.md @@ -16,7 +16,7 @@ Pad all available timeslots with delays upon exiting context. **Parameters** -**chs** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Channels to pad with delays. Defaults to all channels in context if none are supplied. +**chs** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – Channels to pad with delays. Defaults to all channels in context if none are supplied. Examples: diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.phase_offset.md index 48b85c83ebc..772a71d232c 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.phase_offset.md @@ -33,7 +33,7 @@ assert len(pulse_prog.instructions) == 3 **Parameters** * **phase** (`float`) – Amount of phase offset in radians. -* **channels** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset phase of. +* **channels** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset phase of. **Yields** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.play.md index 94396e1bca5..a842a673bc8 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.play.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **pulse** (`Union`\[`Pulse`, `ndarray`]) – Pulse to play. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to play pulse on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to play pulse on. * **name** (`Optional`\[`str`]) – Name of the pulse. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.qubit_channels.md index c4366d1692e..7cec574e84b 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.qubit_channels.md @@ -40,5 +40,5 @@ with pulse.build(backend): **Return type** -`Set`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Set`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.set_frequency.md index 08dbcd50786..87e5b588b7b 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.set_frequency.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **frequency** (`float`) – Frequency in Hz to set channel to. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to set frequency of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to set frequency of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.set_phase.md index 924cc0ee7a9..c85e44c392f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.set_phase.md @@ -30,6 +30,6 @@ with pulse.build() as pulse_prog: **Parameters** * **phase** (`float`) – Phase in radians to set channel carrier signal to. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to set phase of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to set phase of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_frequency.md index b610ae51305..58142ca9fbb 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_frequency.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **frequency** (`float`) – Frequency in Hz to shift channel frequency by. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift frequency of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift frequency of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_phase.md index cb338fff15d..96eb4a67d7d 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.builder.shift_phase.md @@ -30,6 +30,6 @@ with pulse.build() as pulse_prog: **Parameters** * **phase** (`float`) – Phase in radians to shift channel carrier signal by. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift phase of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift phase of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.27/qiskit.pulse.channels.md b/docs/api/qiskit/0.27/qiskit.pulse.channels.md index 93f83d00605..e5222160a22 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.channels.md @@ -1,9 +1,9 @@ --- -title: AcquireChannel -description: API reference for qiskit.pulse.channels.AcquireChannel +title: channels +description: API reference for qiskit.pulse.channels in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.pulse.channels.AcquireChannel +python_api_type: module +python_api_name: qiskit.pulse.channels --- diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.md index ab1cc02b484..11fdb9167e5 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Acquire.md @@ -25,9 +25,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -47,9 +47,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -76,23 +76,23 @@ Create a new Acquire instruction. ## Attributes -| | | -| --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`acquire`](#qiskit.pulse.instructions.Acquire.acquire "qiskit.pulse.instructions.Acquire.acquire") | Acquire channel to acquire data. | -| [`channel`](#qiskit.pulse.instructions.Acquire.channel "qiskit.pulse.instructions.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Acquire.channels "qiskit.pulse.instructions.Acquire.channels") | Returns the channels that this schedule uses. | -| [`discriminator`](#qiskit.pulse.instructions.Acquire.discriminator "qiskit.pulse.instructions.Acquire.discriminator") | Return discrimination settings. | -| [`duration`](#qiskit.pulse.instructions.Acquire.duration "qiskit.pulse.instructions.Acquire.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Acquire.id "qiskit.pulse.instructions.Acquire.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Acquire.instructions "qiskit.pulse.instructions.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | -| [`kernel`](#qiskit.pulse.instructions.Acquire.kernel "qiskit.pulse.instructions.Acquire.kernel") | Return kernel settings. | -| [`mem_slot`](#qiskit.pulse.instructions.Acquire.mem_slot "qiskit.pulse.instructions.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | -| [`name`](#qiskit.pulse.instructions.Acquire.name "qiskit.pulse.instructions.Acquire.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Acquire.operands "qiskit.pulse.instructions.Acquire.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Acquire.parameters "qiskit.pulse.instructions.Acquire.parameters") | Parameters which determine the instruction behavior. | -| [`reg_slot`](#qiskit.pulse.instructions.Acquire.reg_slot "qiskit.pulse.instructions.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | -| [`start_time`](#qiskit.pulse.instructions.Acquire.start_time "qiskit.pulse.instructions.Acquire.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Acquire.stop_time "qiskit.pulse.instructions.Acquire.stop_time") | Relative end time of this instruction. | +| | | +| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`acquire`](#qiskit.pulse.instructions.Acquire.acquire "qiskit.pulse.instructions.Acquire.acquire") | Acquire channel to acquire data. | +| [`channel`](#qiskit.pulse.instructions.Acquire.channel "qiskit.pulse.instructions.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Acquire.channels "qiskit.pulse.instructions.Acquire.channels") | Returns the channels that this schedule uses. | +| [`discriminator`](#qiskit.pulse.instructions.Acquire.discriminator "qiskit.pulse.instructions.Acquire.discriminator") | Return discrimination settings. | +| [`duration`](#qiskit.pulse.instructions.Acquire.duration "qiskit.pulse.instructions.Acquire.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Acquire.id "qiskit.pulse.instructions.Acquire.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Acquire.instructions "qiskit.pulse.instructions.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | +| [`kernel`](#qiskit.pulse.instructions.Acquire.kernel "qiskit.pulse.instructions.Acquire.kernel") | Return kernel settings. | +| [`mem_slot`](#qiskit.pulse.instructions.Acquire.mem_slot "qiskit.pulse.instructions.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | +| [`name`](#qiskit.pulse.instructions.Acquire.name "qiskit.pulse.instructions.Acquire.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Acquire.operands "qiskit.pulse.instructions.Acquire.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Acquire.parameters "qiskit.pulse.instructions.Acquire.parameters") | Parameters which determine the instruction behavior. | +| [`reg_slot`](#qiskit.pulse.instructions.Acquire.reg_slot "qiskit.pulse.instructions.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | +| [`start_time`](#qiskit.pulse.instructions.Acquire.start_time "qiskit.pulse.instructions.Acquire.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Acquire.stop_time "qiskit.pulse.instructions.Acquire.stop_time") | Relative end time of this instruction. | ### acquire @@ -104,7 +104,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### append @@ -201,11 +201,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### channels @@ -217,7 +217,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]] +`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]] ### discriminator @@ -252,7 +252,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** @@ -366,7 +366,7 @@ The classical memory slot which will store the classified readout result. **Return type** -[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot") +[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot") ### name @@ -414,7 +414,7 @@ The fast-access register slot which will store the classified readout result for **Return type** -[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot") +[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot") ### shift diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.md index cdf733b6523..44d242dbb6f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Call.md @@ -221,7 +221,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -244,7 +244,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.md index 397c443c0d6..dabc5660778 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Delay.md @@ -33,7 +33,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ### \_\_init\_\_ @@ -49,7 +49,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ## Methods @@ -70,18 +70,18 @@ No other instruction may be scheduled within a `Delay`. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Delay.channel "qiskit.pulse.instructions.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Delay.channels "qiskit.pulse.instructions.Delay.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Delay.duration "qiskit.pulse.instructions.Delay.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Delay.id "qiskit.pulse.instructions.Delay.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Delay.instructions "qiskit.pulse.instructions.Delay.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.Delay.name "qiskit.pulse.instructions.Delay.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Delay.operands "qiskit.pulse.instructions.Delay.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Delay.parameters "qiskit.pulse.instructions.Delay.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.Delay.start_time "qiskit.pulse.instructions.Delay.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Delay.stop_time "qiskit.pulse.instructions.Delay.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.Delay.channel "qiskit.pulse.instructions.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Delay.channels "qiskit.pulse.instructions.Delay.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Delay.duration "qiskit.pulse.instructions.Delay.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Delay.id "qiskit.pulse.instructions.Delay.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Delay.instructions "qiskit.pulse.instructions.Delay.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.Delay.name "qiskit.pulse.instructions.Delay.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Delay.operands "qiskit.pulse.instructions.Delay.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Delay.parameters "qiskit.pulse.instructions.Delay.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.Delay.start_time "qiskit.pulse.instructions.Delay.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Delay.stop_time "qiskit.pulse.instructions.Delay.stop_time") | Relative end time of this instruction. | ### append @@ -178,11 +178,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") ### channels @@ -194,7 +194,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -217,7 +217,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.md index 988d6be55db..7cb7777c5d9 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Instruction.md @@ -20,7 +20,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -40,7 +40,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -177,7 +177,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -200,7 +200,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.md index 2b28e0252df..dd53254d1da 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Play.md @@ -21,7 +21,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -39,7 +39,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -64,19 +64,19 @@ Create a new pulse instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Play.channel "qiskit.pulse.instructions.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Play.channels "qiskit.pulse.instructions.Play.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Play.duration "qiskit.pulse.instructions.Play.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Play.id "qiskit.pulse.instructions.Play.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Play.instructions "qiskit.pulse.instructions.Play.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.Play.name "qiskit.pulse.instructions.Play.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Play.operands "qiskit.pulse.instructions.Play.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Play.parameters "qiskit.pulse.instructions.Play.parameters") | Parameters which determine the instruction behavior. | -| [`pulse`](#qiskit.pulse.instructions.Play.pulse "qiskit.pulse.instructions.Play.pulse") | A description of the samples that will be played. | -| [`start_time`](#qiskit.pulse.instructions.Play.start_time "qiskit.pulse.instructions.Play.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Play.stop_time "qiskit.pulse.instructions.Play.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.Play.channel "qiskit.pulse.instructions.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Play.channels "qiskit.pulse.instructions.Play.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Play.duration "qiskit.pulse.instructions.Play.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Play.id "qiskit.pulse.instructions.Play.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Play.instructions "qiskit.pulse.instructions.Play.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.Play.name "qiskit.pulse.instructions.Play.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Play.operands "qiskit.pulse.instructions.Play.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Play.parameters "qiskit.pulse.instructions.Play.parameters") | Parameters which determine the instruction behavior. | +| [`pulse`](#qiskit.pulse.instructions.Play.pulse "qiskit.pulse.instructions.Play.pulse") | A description of the samples that will be played. | +| [`start_time`](#qiskit.pulse.instructions.Play.start_time "qiskit.pulse.instructions.Play.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Play.stop_time "qiskit.pulse.instructions.Play.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.md index 3e8f871f787..fe562941083 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetFrequency.md @@ -27,7 +27,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -62,19 +62,19 @@ Creates a new set channel frequency instruction. ## Attributes -| | | -| ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.SetFrequency.channel "qiskit.pulse.instructions.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.SetFrequency.channels "qiskit.pulse.instructions.SetFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.SetFrequency.duration "qiskit.pulse.instructions.SetFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.instructions.SetFrequency.frequency "qiskit.pulse.instructions.SetFrequency.frequency") | New frequency. | -| [`id`](#qiskit.pulse.instructions.SetFrequency.id "qiskit.pulse.instructions.SetFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.SetFrequency.instructions "qiskit.pulse.instructions.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.SetFrequency.name "qiskit.pulse.instructions.SetFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.SetFrequency.operands "qiskit.pulse.instructions.SetFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.SetFrequency.parameters "qiskit.pulse.instructions.SetFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.SetFrequency.start_time "qiskit.pulse.instructions.SetFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.SetFrequency.stop_time "qiskit.pulse.instructions.SetFrequency.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.SetFrequency.channel "qiskit.pulse.instructions.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.SetFrequency.channels "qiskit.pulse.instructions.SetFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.SetFrequency.duration "qiskit.pulse.instructions.SetFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.instructions.SetFrequency.frequency "qiskit.pulse.instructions.SetFrequency.frequency") | New frequency. | +| [`id`](#qiskit.pulse.instructions.SetFrequency.id "qiskit.pulse.instructions.SetFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.SetFrequency.instructions "qiskit.pulse.instructions.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.SetFrequency.name "qiskit.pulse.instructions.SetFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.SetFrequency.operands "qiskit.pulse.instructions.SetFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.SetFrequency.parameters "qiskit.pulse.instructions.SetFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.SetFrequency.start_time "qiskit.pulse.instructions.SetFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.SetFrequency.stop_time "qiskit.pulse.instructions.SetFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.md index 17d4a27e86f..5a9fdb8ecc8 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.SetPhase.md @@ -27,7 +27,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -62,19 +62,19 @@ Instantiate a set phase instruction, setting the output signal phase on `channel ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.SetPhase.channel "qiskit.pulse.instructions.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.SetPhase.channels "qiskit.pulse.instructions.SetPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.SetPhase.duration "qiskit.pulse.instructions.SetPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.SetPhase.id "qiskit.pulse.instructions.SetPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.SetPhase.instructions "qiskit.pulse.instructions.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.SetPhase.name "qiskit.pulse.instructions.SetPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.SetPhase.operands "qiskit.pulse.instructions.SetPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.SetPhase.parameters "qiskit.pulse.instructions.SetPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.instructions.SetPhase.phase "qiskit.pulse.instructions.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.instructions.SetPhase.start_time "qiskit.pulse.instructions.SetPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.SetPhase.stop_time "qiskit.pulse.instructions.SetPhase.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.SetPhase.channel "qiskit.pulse.instructions.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.SetPhase.channels "qiskit.pulse.instructions.SetPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.SetPhase.duration "qiskit.pulse.instructions.SetPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.SetPhase.id "qiskit.pulse.instructions.SetPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.SetPhase.instructions "qiskit.pulse.instructions.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.SetPhase.name "qiskit.pulse.instructions.SetPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.SetPhase.operands "qiskit.pulse.instructions.SetPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.SetPhase.parameters "qiskit.pulse.instructions.SetPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.instructions.SetPhase.phase "qiskit.pulse.instructions.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.instructions.SetPhase.start_time "qiskit.pulse.instructions.SetPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.SetPhase.stop_time "qiskit.pulse.instructions.SetPhase.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.md index 33d44d93c0b..c1068485c86 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftFrequency.md @@ -19,7 +19,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -33,7 +33,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -54,19 +54,19 @@ Creates a new shift frequency instruction. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.ShiftFrequency.channel "qiskit.pulse.instructions.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.ShiftFrequency.channels "qiskit.pulse.instructions.ShiftFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.ShiftFrequency.duration "qiskit.pulse.instructions.ShiftFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.instructions.ShiftFrequency.frequency "qiskit.pulse.instructions.ShiftFrequency.frequency") | Frequency shift from the set frequency. | -| [`id`](#qiskit.pulse.instructions.ShiftFrequency.id "qiskit.pulse.instructions.ShiftFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.ShiftFrequency.instructions "qiskit.pulse.instructions.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.ShiftFrequency.name "qiskit.pulse.instructions.ShiftFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.ShiftFrequency.operands "qiskit.pulse.instructions.ShiftFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.ShiftFrequency.parameters "qiskit.pulse.instructions.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.ShiftFrequency.start_time "qiskit.pulse.instructions.ShiftFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.ShiftFrequency.stop_time "qiskit.pulse.instructions.ShiftFrequency.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.ShiftFrequency.channel "qiskit.pulse.instructions.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.ShiftFrequency.channels "qiskit.pulse.instructions.ShiftFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.ShiftFrequency.duration "qiskit.pulse.instructions.ShiftFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.instructions.ShiftFrequency.frequency "qiskit.pulse.instructions.ShiftFrequency.frequency") | Frequency shift from the set frequency. | +| [`id`](#qiskit.pulse.instructions.ShiftFrequency.id "qiskit.pulse.instructions.ShiftFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.ShiftFrequency.instructions "qiskit.pulse.instructions.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.ShiftFrequency.name "qiskit.pulse.instructions.ShiftFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.ShiftFrequency.operands "qiskit.pulse.instructions.ShiftFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.ShiftFrequency.parameters "qiskit.pulse.instructions.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.ShiftFrequency.start_time "qiskit.pulse.instructions.ShiftFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.ShiftFrequency.stop_time "qiskit.pulse.instructions.ShiftFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -163,11 +163,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -179,7 +179,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -202,7 +202,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.md index 13dd0abcc7e..b45bb0b93df 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase `ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/pulse/instructions/phase.py "view source code") -The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. +The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -29,7 +29,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -43,7 +43,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -64,19 +64,19 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.ShiftPhase.channel "qiskit.pulse.instructions.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.ShiftPhase.channels "qiskit.pulse.instructions.ShiftPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.ShiftPhase.duration "qiskit.pulse.instructions.ShiftPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.ShiftPhase.id "qiskit.pulse.instructions.ShiftPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.ShiftPhase.instructions "qiskit.pulse.instructions.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.ShiftPhase.name "qiskit.pulse.instructions.ShiftPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.ShiftPhase.operands "qiskit.pulse.instructions.ShiftPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.ShiftPhase.parameters "qiskit.pulse.instructions.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.instructions.ShiftPhase.phase "qiskit.pulse.instructions.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.instructions.ShiftPhase.start_time "qiskit.pulse.instructions.ShiftPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.ShiftPhase.stop_time "qiskit.pulse.instructions.ShiftPhase.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.ShiftPhase.channel "qiskit.pulse.instructions.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.ShiftPhase.channels "qiskit.pulse.instructions.ShiftPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.ShiftPhase.duration "qiskit.pulse.instructions.ShiftPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.ShiftPhase.id "qiskit.pulse.instructions.ShiftPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.ShiftPhase.instructions "qiskit.pulse.instructions.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.ShiftPhase.name "qiskit.pulse.instructions.ShiftPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.ShiftPhase.operands "qiskit.pulse.instructions.ShiftPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.ShiftPhase.parameters "qiskit.pulse.instructions.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.instructions.ShiftPhase.phase "qiskit.pulse.instructions.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.instructions.ShiftPhase.start_time "qiskit.pulse.instructions.ShiftPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.ShiftPhase.stop_time "qiskit.pulse.instructions.ShiftPhase.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.md index 0ebe58c1869..12fd63f17a1 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.Snapshot.md @@ -62,20 +62,20 @@ Create new snapshot. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Snapshot.channel "qiskit.pulse.instructions.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | -| [`channels`](#qiskit.pulse.instructions.Snapshot.channels "qiskit.pulse.instructions.Snapshot.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Snapshot.duration "qiskit.pulse.instructions.Snapshot.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Snapshot.id "qiskit.pulse.instructions.Snapshot.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Snapshot.instructions "qiskit.pulse.instructions.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | -| [`label`](#qiskit.pulse.instructions.Snapshot.label "qiskit.pulse.instructions.Snapshot.label") | Label of snapshot. | -| [`name`](#qiskit.pulse.instructions.Snapshot.name "qiskit.pulse.instructions.Snapshot.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Snapshot.operands "qiskit.pulse.instructions.Snapshot.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Snapshot.parameters "qiskit.pulse.instructions.Snapshot.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.Snapshot.start_time "qiskit.pulse.instructions.Snapshot.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Snapshot.stop_time "qiskit.pulse.instructions.Snapshot.stop_time") | Relative end time of this instruction. | -| [`type`](#qiskit.pulse.instructions.Snapshot.type "qiskit.pulse.instructions.Snapshot.type") | Type of snapshot. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`channel`](#qiskit.pulse.instructions.Snapshot.channel "qiskit.pulse.instructions.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | +| [`channels`](#qiskit.pulse.instructions.Snapshot.channels "qiskit.pulse.instructions.Snapshot.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Snapshot.duration "qiskit.pulse.instructions.Snapshot.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Snapshot.id "qiskit.pulse.instructions.Snapshot.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Snapshot.instructions "qiskit.pulse.instructions.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | +| [`label`](#qiskit.pulse.instructions.Snapshot.label "qiskit.pulse.instructions.Snapshot.label") | Label of snapshot. | +| [`name`](#qiskit.pulse.instructions.Snapshot.name "qiskit.pulse.instructions.Snapshot.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Snapshot.operands "qiskit.pulse.instructions.Snapshot.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Snapshot.parameters "qiskit.pulse.instructions.Snapshot.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.Snapshot.start_time "qiskit.pulse.instructions.Snapshot.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Snapshot.stop_time "qiskit.pulse.instructions.Snapshot.stop_time") | Relative end time of this instruction. | +| [`type`](#qiskit.pulse.instructions.Snapshot.type "qiskit.pulse.instructions.Snapshot.type") | Type of snapshot. | ### append @@ -172,11 +172,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** -[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel") +[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel") ### channels @@ -188,7 +188,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel")] +`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel")] ### draw @@ -211,7 +211,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.27/qiskit.pulse.instructions.md b/docs/api/qiskit/0.27/qiskit.pulse.instructions.md index 02154d7c1ba..b3eda3b77e3 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.instructions.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.instructions.md @@ -1,10 +1,18 @@ +--- +title: instructions +description: API reference for qiskit.pulse.instructions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.instructions +--- + # qiskit.pulse.instructions -The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") specifying where the instruction will be applied. +The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") specifying where the instruction will be applied. -Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") `channel`: +Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") `channel`: ```python ShiftPhase(phase, channel) @@ -18,20 +26,21 @@ Delay(duration, channel) An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), which is a sequence of scheduled Pulse `Instruction` s over many channels. `Instruction` s and `Schedule` s implement the same interface. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | -| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | -| [`SetPhase`](qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | -| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | -| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | +| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | +| [`SetPhase`](qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | +| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). | +| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Abstract Classes | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`Instruction`](qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | + diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.27/qiskit.pulse.library.discrete.md index f43ecaa1572..a9ec40c6100 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.discrete.md @@ -1,9 +1,9 @@ --- -title: constant -description: API reference for qiskit.pulse.library.discrete.constant +title: discrete +description: API reference for qiskit.pulse.library.discrete in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.pulse.library.discrete.constant +python_api_type: module +python_api_name: qiskit.pulse.library.discrete --- diff --git a/docs/api/qiskit/0.27/qiskit.pulse.library.md b/docs/api/qiskit/0.27/qiskit.pulse.library.md index 988f5119861..d449fa5d283 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.library.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.library.md @@ -1,3 +1,11 @@ +--- +title: library +description: API reference for qiskit.pulse.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library +--- + # qiskit.pulse.library @@ -18,3 +26,4 @@ The parametric pulses, [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse. | [`Drag`](qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | | [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | | [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma, width) | A square pulse with a Gaussian shaped risefall on either side: | + diff --git a/docs/api/qiskit/0.27/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.27/qiskit.pulse.transforms.pad.md index 9b7de703646..c895d5da79f 100644 --- a/docs/api/qiskit/0.27/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.27/qiskit.pulse.transforms.pad.md @@ -17,7 +17,7 @@ Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedu **Parameters** * **schedule** (`Schedule`) – Schedule to pad. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Channels to pad. Defaults to all channels in `schedule` if not provided. If the supplied channel is not a member of `schedule` it will be added. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Channels to pad. Defaults to all channels in `schedule` if not provided. If the supplied channel is not a member of `schedule` it will be added. * **until** (`Optional`\[`int`]) – Time to pad until. Defaults to `schedule.duration` if not provided. * **inplace** (`bool`) – Pad this schedule by mutating rather than returning a new schedule. diff --git a/docs/api/qiskit/0.27/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.27/qiskit.scheduler.methods.basic.md index c686aa04f3d..27cd8d0ce83 100644 --- a/docs/api/qiskit/0.27/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.27/qiskit.scheduler.methods.basic.md @@ -1,9 +1,9 @@ --- -title: as_late_as_possible -description: API reference for qiskit.scheduler.methods.basic.as_late_as_possible +title: basic +description: API reference for qiskit.scheduler.methods.basic in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.scheduler.methods.basic.as_late_as_possible +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic --- diff --git a/docs/api/qiskit/0.27/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.27/qiskit.scheduler.schedule_circuit.md index 5c0025e87b0..1b7bc625d39 100644 --- a/docs/api/qiskit/0.27/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.27/qiskit.scheduler.schedule_circuit.md @@ -1,9 +1,9 @@ --- title: schedule_circuit -description: API reference for qiskit.scheduler.schedule_circuit.schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.scheduler.schedule_circuit.schedule_circuit +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit --- diff --git a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.draw.md index 557a47aad12..1f4b5fccdad 100644 --- a/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.27/qiskit.visualization.pulse_v2.draw.md @@ -26,7 +26,7 @@ Generate visualization data for pulse programs. * **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list is not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list is not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. diff --git a/docs/api/qiskit/0.28/_toc.json b/docs/api/qiskit/0.28/_toc.json index 2167d4d5ae4..9acdd78b52d 100644 --- a/docs/api/qiskit/0.28/_toc.json +++ b/docs/api/qiskit/0.28/_toc.json @@ -1756,38 +1756,6 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.28/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.28/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.28/qiskit.circuit.library.Barrier" - }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CCXGate" - }, - { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CDKMRippleCarryAdder" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.28/qiskit.circuit.ClassicalRegister" @@ -1796,226 +1764,22 @@ "title": "Clbit", "url": "/api/qiskit/0.28/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_8_3" - }, { "title": "ControlledGate", "url": "/api/qiskit/0.28/qiskit.circuit.ControlledGate" }, - { - "title": "CPhaseGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CSwapGate" - }, - { - "title": "CSXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CSXGate" - }, - { - "title": "CU1Gate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CU1Gate" - }, - { - "title": "CU3Gate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CU3Gate" - }, - { - "title": "CUGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CUGate" - }, - { - "title": "CXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CXGate" - }, - { - "title": "CYGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CYGate" - }, - { - "title": "CZGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.CZGate" - }, - { - "title": "DCXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.DCXGate" - }, { "title": "Delay", "url": "/api/qiskit/0.28/qiskit.circuit.Delay" }, - { - "title": "Diagonal", - "url": "/api/qiskit/0.28/qiskit.circuit.library.Diagonal" - }, - { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.28/qiskit.circuit.library.DraperQFTAdder" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.EfficientSU2" - }, { "title": "EquivalenceLibrary", "url": "/api/qiskit/0.28/qiskit.circuit.EquivalenceLibrary" }, - { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.28/qiskit.circuit.library.EvolvedOperatorAnsatz" - }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.28/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.28/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.28/qiskit.circuit.library.FunctionalPauliRotations" - }, { "title": "Gate", "url": "/api/qiskit/0.28/qiskit.circuit.Gate" }, - { - "title": "GMS", - "url": "/api/qiskit/0.28/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.28/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.28/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.28/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.28/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.28/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.28/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.28/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.28/qiskit.circuit.library.HRSCumulativeMultiplier" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.28/qiskit.circuit.library.InnerProduct" - }, { "title": "Instruction", "url": "/api/qiskit/0.28/qiskit.circuit.Instruction" @@ -2024,82 +1788,10 @@ "title": "InstructionSet", "url": "/api/qiskit/0.28/qiskit.circuit.InstructionSet" }, - { - "title": "IntegerComparator", - "url": "/api/qiskit/0.28/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.28/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.28/qiskit.circuit.library.LinearAmplitudeFunction" - }, - { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.28/qiskit.circuit.library.LinearPauliRotations" - }, - { - "title": "LogNormalDistribution", - "url": "/api/qiskit/0.28/qiskit.circuit.library.LogNormalDistribution" - }, - { - "title": "MCMT", - "url": "/api/qiskit/0.28/qiskit.circuit.library.MCMT" - }, - { - "title": "MCMTVChain", - "url": "/api/qiskit/0.28/qiskit.circuit.library.MCMTVChain" - }, - { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.MCPhaseGate" - }, - { - "title": "MCXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.MCXGate" - }, - { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.28/qiskit.circuit.library.MCXGrayCode" - }, - { - "title": "MCXRecursive", - "url": "/api/qiskit/0.28/qiskit.circuit.library.MCXRecursive" - }, - { - "title": "MCXVChain", - "url": "/api/qiskit/0.28/qiskit.circuit.library.MCXVChain" - }, { "title": "Measure", "url": "/api/qiskit/0.28/qiskit.circuit.Measure" }, - { - "title": "Measure", - "url": "/api/qiskit/0.28/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.28/qiskit.circuit.library.NLocal" - }, - { - "title": "NormalDistribution", - "url": "/api/qiskit/0.28/qiskit.circuit.library.NormalDistribution" - }, - { - "title": "OR", - "url": "/api/qiskit/0.28/qiskit.circuit.library.OR" - }, { "title": "Parameter", "url": "/api/qiskit/0.28/qiskit.circuit.Parameter" @@ -2112,66 +1804,10 @@ "title": "ParameterVector", "url": "/api/qiskit/0.28/qiskit.circuit.ParameterVector" }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.28/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.28/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.28/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.28/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.28/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.28/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.28/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.28/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.28/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.28/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.28/qiskit.circuit.library.QFT" - }, { "title": "qiskit.circuit.qpy_serialization", "url": "/api/qiskit/0.28/qpy" }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.28/qiskit.circuit.library.QuadraticForm" - }, { "title": "QuantumCircuit", "url": "/api/qiskit/0.28/qiskit.circuit.QuantumCircuit" @@ -2180,10 +1816,6 @@ "title": "QuantumRegister", "url": "/api/qiskit/0.28/qiskit.circuit.QuantumRegister" }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.28/qiskit.circuit.library.QuantumVolume" - }, { "title": "Qubit", "url": "/api/qiskit/0.28/qiskit.circuit.Qubit" @@ -2192,384 +1824,761 @@ "title": "random_circuit", "url": "/api/qiskit/0.28/qiskit.circuit.random.random_circuit" }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RealAmplitudes" - }, { "title": "Reset", "url": "/api/qiskit/0.28/qiskit.circuit.Reset" }, { - "title": "Reset", - "url": "/api/qiskit/0.28/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.SGate" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.SXdgGate" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.28/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.28/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "SXGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.28/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.UGate" - }, - { - "title": "UniformDistribution", - "url": "/api/qiskit/0.28/qiskit.circuit.library.UniformDistribution" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.28/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.28/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.28/qiskit.circuit.library.XOR" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.28/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.28/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.28/qiskit.circuit.library.ZZFeatureMap" - }, - { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.28/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.28/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.28/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.28/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.28/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.28/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.28/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.28/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.28/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.28/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.28/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.28/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.28/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.28/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.28/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.28/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.28/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.28/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.28/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.28/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.28/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.28/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.28/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.28/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.28/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "LogNormalDistribution", + "url": "/api/qiskit/0.28/qiskit.circuit.library.LogNormalDistribution" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.28/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.28/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.28/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.28/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.28/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.28/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.28/qiskit.circuit.library.NLocal" + }, + { + "title": "NormalDistribution", + "url": "/api/qiskit/0.28/qiskit.circuit.library.NormalDistribution" + }, + { + "title": "OR", + "url": "/api/qiskit/0.28/qiskit.circuit.library.OR" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.28/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.28/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.28/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.28/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.28/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.28/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.28/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.28/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.28/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.28/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.28/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.28/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.28/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.28/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.28/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.SGate" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.SwapGate" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.28/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "SXdgGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.SXdgGate" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "SXGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.SXGate" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "TdgGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.TdgGate" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.28/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.28/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.28/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.U2Gate" + }, + { + "title": "U3Gate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.U3Gate" + }, + { + "title": "UGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.UGate" + }, + { + "title": "UniformDistribution", + "url": "/api/qiskit/0.28/qiskit.circuit.library.UniformDistribution" + }, + { + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.28/qiskit.circuit.library.VBERippleCarryAdder" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.28/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.28/qiskit.circuit.library.XOR" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.28/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.28/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.28/qiskit.circuit.library.ZZFeatureMap" } ] } @@ -2729,11 +2738,11 @@ "url": "/api/qiskit/0.28/qiskit.finance.applications.ising" }, { - "title": "get_operator", + "title": "qiskit.finance.applications.ising.portfolio", "url": "/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio" }, { - "title": "get_operator", + "title": "qiskit.finance.applications.ising.portfolio_diversification", "url": "/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio_diversification" } ] @@ -3171,6 +3180,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.28/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.28/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.28/qiskit.ignis.verification.QOTP" @@ -3693,56 +3706,56 @@ "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising" }, { - "title": "check_disjoint", - "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.set_packing" + "title": "qiskit.optimization.applications.ising.clique", + "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.clique" }, { - "title": "check_full_edge_coverage", - "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.vertex_cover" + "title": "qiskit.optimization.applications.ising.common", + "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.common" }, { - "title": "check_solution_satisfiability", - "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.exact_cover" + "title": "qiskit.optimization.applications.ising.docplex", + "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.docplex" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.clique" + "title": "qiskit.optimization.applications.ising.exact_cover", + "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.exact_cover" }, { - "title": "get_graph_solution", + "title": "qiskit.optimization.applications.ising.graph_partition", "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.graph_partition" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.max_cut" + "title": "qiskit.optimization.applications.ising.knapsack", + "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.knapsack" }, { - "title": "get_graph_solution", - "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.stable_set" + "title": "qiskit.optimization.applications.ising.max_cut", + "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.max_cut" }, { - "title": "get_gset_result", - "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.common" + "title": "qiskit.optimization.applications.ising.partition", + "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.partition" }, { - "title": "get_operator", - "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.docplex" + "title": "qiskit.optimization.applications.ising.set_packing", + "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.set_packing" }, { - "title": "get_operator", - "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.knapsack" + "title": "qiskit.optimization.applications.ising.stable_set", + "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.stable_set" }, { - "title": "get_operator", - "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.partition" + "title": "qiskit.optimization.applications.ising.tsp", + "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp" }, { - "title": "get_operator", + "title": "qiskit.optimization.applications.ising.vehicle_routing", "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.vehicle_routing" }, { - "title": "TspData", - "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp" + "title": "qiskit.optimization.applications.ising.vertex_cover", + "url": "/api/qiskit/0.28/qiskit.optimization.applications.ising.vertex_cover" } ] } @@ -4680,10 +4693,6 @@ "title": "acquire", "url": "/api/qiskit/0.28/qiskit.pulse.builder.acquire" }, - { - "title": "Acquire", - "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Acquire" - }, { "title": "acquire_channel", "url": "/api/qiskit/0.28/qiskit.pulse.builder.acquire_channel" @@ -4692,10 +4701,6 @@ "title": "AcquireChannel", "url": "/api/qiskit/0.28/qiskit.pulse.AcquireChannel" }, - { - "title": "AcquireChannel", - "url": "/api/qiskit/0.28/qiskit.pulse.channels" - }, { "title": "active_backend", "url": "/api/qiskit/0.28/qiskit.pulse.builder.active_backend" @@ -4752,10 +4757,6 @@ "title": "call", "url": "/api/qiskit/0.28/qiskit.pulse.builder.call" }, - { - "title": "Call", - "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Call" - }, { "title": "circuit_scheduler_settings", "url": "/api/qiskit/0.28/qiskit.pulse.builder.circuit_scheduler_settings" @@ -4764,14 +4765,6 @@ "title": "Constant", "url": "/api/qiskit/0.28/qiskit.pulse.Constant" }, - { - "title": "Constant", - "url": "/api/qiskit/0.28/qiskit.pulse.library.Constant" - }, - { - "title": "constant", - "url": "/api/qiskit/0.28/qiskit.pulse.library.discrete" - }, { "title": "control_channels", "url": "/api/qiskit/0.28/qiskit.pulse.builder.control_channels" @@ -4792,10 +4785,6 @@ "title": "delay", "url": "/api/qiskit/0.28/qiskit.pulse.builder.delay" }, - { - "title": "Delay", - "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Delay" - }, { "title": "delay_qubits", "url": "/api/qiskit/0.28/qiskit.pulse.builder.delay_qubits" @@ -4804,10 +4793,6 @@ "title": "Drag", "url": "/api/qiskit/0.28/qiskit.pulse.Drag" }, - { - "title": "Drag", - "url": "/api/qiskit/0.28/qiskit.pulse.library.Drag" - }, { "title": "drive_channel", "url": "/api/qiskit/0.28/qiskit.pulse.builder.drive_channel" @@ -4824,18 +4809,10 @@ "title": "Gaussian", "url": "/api/qiskit/0.28/qiskit.pulse.Gaussian" }, - { - "title": "Gaussian", - "url": "/api/qiskit/0.28/qiskit.pulse.library.Gaussian" - }, { "title": "GaussianSquare", "url": "/api/qiskit/0.28/qiskit.pulse.GaussianSquare" }, - { - "title": "GaussianSquare", - "url": "/api/qiskit/0.28/qiskit.pulse.library.GaussianSquare" - }, { "title": "inline", "url": "/api/qiskit/0.28/qiskit.pulse.builder.inline" @@ -4844,10 +4821,6 @@ "title": "Instruction", "url": "/api/qiskit/0.28/qiskit.pulse.Instruction" }, - { - "title": "Instruction", - "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Instruction" - }, { "title": "InstructionScheduleMap", "url": "/api/qiskit/0.28/qiskit.pulse.InstructionScheduleMap" @@ -4896,14 +4869,14 @@ "title": "play", "url": "/api/qiskit/0.28/qiskit.pulse.builder.play" }, - { - "title": "Play", - "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Play" - }, { "title": "PulseError", "url": "/api/qiskit/0.28/qiskit.pulse.PulseError" }, + { + "title": "qiskit.pulse.channels", + "url": "/api/qiskit/0.28/qiskit.pulse.channels" + }, { "title": "qubit_channels", "url": "/api/qiskit/0.28/qiskit.pulse.builder.qubit_channels" @@ -4940,18 +4913,10 @@ "title": "SetFrequency", "url": "/api/qiskit/0.28/qiskit.pulse.SetFrequency" }, - { - "title": "SetFrequency", - "url": "/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency" - }, { "title": "SetPhase", "url": "/api/qiskit/0.28/qiskit.pulse.SetPhase" }, - { - "title": "SetPhase", - "url": "/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase" - }, { "title": "shift_frequency", "url": "/api/qiskit/0.28/qiskit.pulse.builder.shift_frequency" @@ -4964,18 +4929,10 @@ "title": "ShiftFrequency", "url": "/api/qiskit/0.28/qiskit.pulse.ShiftFrequency" }, - { - "title": "ShiftFrequency", - "url": "/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency" - }, { "title": "ShiftPhase", "url": "/api/qiskit/0.28/qiskit.pulse.ShiftPhase" }, - { - "title": "ShiftPhase", - "url": "/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase" - }, { "title": "Snapshot", "url": "/api/qiskit/0.28/qiskit.pulse.Snapshot" @@ -4984,10 +4941,6 @@ "title": "snapshot", "url": "/api/qiskit/0.28/qiskit.pulse.builder.snapshot" }, - { - "title": "Snapshot", - "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot" - }, { "title": "transpiler_settings", "url": "/api/qiskit/0.28/qiskit.pulse.builder.transpiler_settings" @@ -5008,13 +4961,91 @@ "title": "Waveform", "url": "/api/qiskit/0.28/qiskit.pulse.Waveform" }, - { - "title": "Waveform", - "url": "/api/qiskit/0.28/qiskit.pulse.library.Waveform" - }, { "title": "x", "url": "/api/qiskit/0.28/qiskit.pulse.builder.x" + }, + { + "title": "qiskit.pulse.instructions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.28/qiskit.pulse.instructions" + }, + { + "title": "Acquire", + "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Acquire" + }, + { + "title": "Call", + "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Call" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Delay" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Instruction" + }, + { + "title": "Play", + "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Play" + }, + { + "title": "SetFrequency", + "url": "/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency" + }, + { + "title": "SetPhase", + "url": "/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase" + }, + { + "title": "ShiftFrequency", + "url": "/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency" + }, + { + "title": "ShiftPhase", + "url": "/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot" + } + ] + }, + { + "title": "qiskit.pulse.library", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.28/qiskit.pulse.library" + }, + { + "title": "Constant", + "url": "/api/qiskit/0.28/qiskit.pulse.library.Constant" + }, + { + "title": "Drag", + "url": "/api/qiskit/0.28/qiskit.pulse.library.Drag" + }, + { + "title": "Gaussian", + "url": "/api/qiskit/0.28/qiskit.pulse.library.Gaussian" + }, + { + "title": "GaussianSquare", + "url": "/api/qiskit/0.28/qiskit.pulse.library.GaussianSquare" + }, + { + "title": "qiskit.pulse.library.discrete", + "url": "/api/qiskit/0.28/qiskit.pulse.library.discrete" + }, + { + "title": "Waveform", + "url": "/api/qiskit/0.28/qiskit.pulse.library.Waveform" + } + ] } ] }, @@ -5366,11 +5397,11 @@ "url": "/api/qiskit/0.28/scheduler" }, { - "title": "as_late_as_possible", + "title": "qiskit.scheduler.methods.basic", "url": "/api/qiskit/0.28/qiskit.scheduler.methods.basic" }, { - "title": "schedule_circuit", + "title": "qiskit.scheduler.schedule_circuit", "url": "/api/qiskit/0.28/qiskit.scheduler.schedule_circuit" }, { diff --git a/docs/api/qiskit/0.28/circuit_library.md b/docs/api/qiskit/0.28/circuit_library.md index 5690a237078..d38da990492 100644 --- a/docs/api/qiskit/0.28/circuit_library.md +++ b/docs/api/qiskit/0.28/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -277,3 +289,4 @@ | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.28/pulse.md b/docs/api/qiskit/0.28/pulse.md index 13a7f233cdb..c95c044148a 100644 --- a/docs/api/qiskit/0.28/pulse.md +++ b/docs/api/qiskit/0.28/pulse.md @@ -32,18 +32,18 @@ This is sufficient to allow the quantum physicist to explore and correct for noi `qiskit.pulse.instructions` -| | | -| ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | -| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Call`](qiskit.pulse.Call "qiskit.pulse.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | -| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftFrequency`](qiskit.pulse.ShiftFrequency "qiskit.pulse.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | -| [`SetPhase`](qiskit.pulse.SetPhase "qiskit.pulse.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | -| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | -| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | +| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Call`](qiskit.pulse.Call "qiskit.pulse.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | +| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftFrequency`](qiskit.pulse.ShiftFrequency "qiskit.pulse.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | +| [`SetPhase`](qiskit.pulse.SetPhase "qiskit.pulse.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | +| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). | +| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Pulse Library (waveforms ) @@ -274,11 +274,11 @@ with pulse.build(backend) as measure_sched: MemorySlot(0) ``` -| | | -| ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`measure`](qiskit.pulse.builder.measure "qiskit.pulse.builder.measure")(qubits\[, registers]) | Measure a qubit within the currently active builder context. | -| [`measure_all`](qiskit.pulse.builder.measure_all "qiskit.pulse.builder.measure_all")() | Measure all qubits within the currently active builder context. | -| [`delay_qubits`](qiskit.pulse.builder.delay_qubits "qiskit.pulse.builder.delay_qubits")(duration, \*qubits) | Insert delays on all of the [`channels.Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")s that correspond to the input `qubits` at the same time. | +| | | +| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`measure`](qiskit.pulse.builder.measure "qiskit.pulse.builder.measure")(qubits\[, registers]) | Measure a qubit within the currently active builder context. | +| [`measure_all`](qiskit.pulse.builder.measure_all "qiskit.pulse.builder.measure_all")() | Measure all qubits within the currently active builder context. | +| [`delay_qubits`](qiskit.pulse.builder.delay_qubits "qiskit.pulse.builder.delay_qubits")(duration, \*qubits) | Insert delays on all of the [`channels.Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")s that correspond to the input `qubits` at the same time. | ### Circuit Gates diff --git a/docs/api/qiskit/0.28/qiskit.compiler.assemble.md b/docs/api/qiskit/0.28/qiskit.compiler.assemble.md index fd39f90fbc7..138579fd1f2 100644 --- a/docs/api/qiskit/0.28/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.28/qiskit.compiler.assemble.md @@ -42,7 +42,7 @@ This function serializes the payloads, which could be either circuits or schedul * **meas\_lo\_range** (`Optional`\[`List`\[`float`]]) – List of job level measurement LO ranges each of form `[range_min, range_max]` in Hz. Used to validate `meas_lo_freq`. Must have length `n_qubits.` -* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment level (ie circuit or schedule) LO frequency configurations for qubit drive and measurement channels. These values override the job level values from `default_qubit_los` and `default_meas_los`. Frequencies are in Hz. Settable for qasm and pulse jobs. +* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment level (ie circuit or schedule) LO frequency configurations for qubit drive and measurement channels. These values override the job level values from `default_qubit_los` and `default_meas_los`. Frequencies are in Hz. Settable for qasm and pulse jobs. * **meas\_level** (`Union`\[`int`, `MeasLevel`]) – Set the appropriate level of the measurement output for pulse experiments. diff --git a/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio.md index 6ecac2fa438..82487c60134 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.finance.applications.ising.portfolio.get_operator +title: portfolio +description: API reference for qiskit.finance.applications.ising.portfolio in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.finance.applications.ising.portfolio.get_operator +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio --- diff --git a/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio_diversification.md index 4716f1a56b6..f91ddbb89e1 100644 --- a/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.28/qiskit.finance.applications.ising.portfolio_diversification.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.finance.applications.ising.portfolio_diversification.get_operator +title: portfolio_diversification +description: API reference for qiskit.finance.applications.ising.portfolio_diversification in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.finance.applications.ising.portfolio_diversification.get_operator +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio_diversification --- diff --git a/docs/api/qiskit/0.28/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.28/qiskit.ignis.verification.basis.md index e26610b6708..c7c0137e9f8 100644 --- a/docs/api/qiskit/0.28/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.28/qiskit.ignis.verification.basis.md @@ -1,5 +1,14 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # qiskit.ignis.verification.basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.clique.md index 940c74047fe..c0e4c528922 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.clique.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.clique.get_graph_solution +title: clique +description: API reference for qiskit.optimization.applications.ising.clique in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.clique.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.clique --- diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.common.md index 3392c7d4935..a80b94865a2 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.common.md @@ -1,9 +1,9 @@ --- -title: get_gset_result -description: API reference for qiskit.optimization.applications.ising.common.get_gset_result +title: common +description: API reference for qiskit.optimization.applications.ising.common in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.common.get_gset_result +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.common --- diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.docplex.md index 9ddbec3f2b1..343cc6b736b 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.docplex.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.docplex.get_operator +title: docplex +description: API reference for qiskit.optimization.applications.ising.docplex in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.docplex.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.docplex --- diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.exact_cover.md index 1e7745503a3..6eced2620c4 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.exact_cover.md @@ -1,9 +1,9 @@ --- -title: check_solution_satisfiability -description: API reference for qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability +title: exact_cover +description: API reference for qiskit.optimization.applications.ising.exact_cover in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.exact_cover --- diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.graph_partition.md index c9a4bfb5d3d..2d3f7e88296 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.graph_partition.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.graph_partition.get_graph_solution +title: graph_partition +description: API reference for qiskit.optimization.applications.ising.graph_partition in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.graph_partition.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.graph_partition --- @@ -50,11 +50,11 @@ Generate Hamiltonian for the graph partitioning **Notes** -## Goals: +**Goals:** 1 separate the vertices into two set of the same size 2 make sure the number of edges between the two set is minimized. -## Hamiltonian: +**Hamiltonian:** H = H\_A + H\_B H\_A = sum\_\{(i,j)in E}\{(1-ZiZj)/2} H\_B = (sum\_\{i}\{Zi})^2 = sum\_\{i}\{Zi^2}+sum\_\{i!=j}\{ZiZj} H\_A is for achieving goal 2 and H\_B is for achieving goal 1. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.knapsack.md index aa6c9e7c681..6f9306be50f 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.knapsack.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.knapsack.get_operator +title: knapsack +description: API reference for qiskit.optimization.applications.ising.knapsack in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.knapsack.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.knapsack --- diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.max_cut.md index 03838a55ff8..0f7cd5d4d0f 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.max_cut.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.max_cut.get_graph_solution +title: max_cut +description: API reference for qiskit.optimization.applications.ising.max_cut in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.max_cut.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.max_cut --- diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.partition.md index 2cc12770421..451c7de04e4 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.partition.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.partition.get_operator +title: partition +description: API reference for qiskit.optimization.applications.ising.partition in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.partition.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.partition --- diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.set_packing.md index 50a16bc2e93..6fe5f8562f4 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.set_packing.md @@ -1,9 +1,9 @@ --- -title: check_disjoint -description: API reference for qiskit.optimization.applications.ising.set_packing.check_disjoint +title: set_packing +description: API reference for qiskit.optimization.applications.ising.set_packing in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.set_packing.check_disjoint +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.set_packing --- diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.stable_set.md index e3ea779d063..2f6481bbfd8 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.stable_set.md @@ -1,9 +1,9 @@ --- -title: get_graph_solution -description: API reference for qiskit.optimization.applications.ising.stable_set.get_graph_solution +title: stable_set +description: API reference for qiskit.optimization.applications.ising.stable_set in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.stable_set.get_graph_solution +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.stable_set --- diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.md index bbc3456ab5a..e5f3da7c799 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.md @@ -1,9 +1,9 @@ --- -title: TspData -description: API reference for qiskit.optimization.applications.ising.tsp.TspData +title: tsp +description: API reference for qiskit.optimization.applications.ising.tsp in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.optimization.applications.ising.tsp.TspData +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.tsp --- diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vehicle_routing.md index 41417b86a6a..cb9da8e8f25 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vehicle_routing.md @@ -1,9 +1,9 @@ --- -title: get_operator -description: API reference for qiskit.optimization.applications.ising.vehicle_routing.get_operator +title: vehicle_routing +description: API reference for qiskit.optimization.applications.ising.vehicle_routing in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.vehicle_routing.get_operator +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vehicle_routing --- @@ -72,7 +72,7 @@ objective function value. `get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") -## Constructs auxiliary matrices from a vehicle routing instance, +**Constructs auxiliary matrices from a vehicle routing instance,** which represent the encoding into a binary quadratic program. This is used in the construction of the qubit ops and computation of the solution cost. @@ -96,7 +96,7 @@ a matrix defining the interactions between variables. a matrix defining the cont `get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/applications/ising/vehicle_routing.py "view source code") -## Tries to obtain a feasible solution (in vector form) of an instance +**Tries to obtain a feasible solution (in vector form) of an instance** of vehicle routing from the results dictionary. @@ -115,7 +115,7 @@ of vehicle routing from the results dictionary. a solution, i.e., a path, in its binary representation. -## #TODO: support statevector simulation, results should be a statevector or counts format, not +**#TODO: support statevector simulation, results should be a statevector or counts format, not** a result from algorithm run diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vertex_cover.md index 50658b90390..5ed46e10885 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.vertex_cover.md @@ -1,9 +1,9 @@ --- -title: check_full_edge_coverage -description: API reference for qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage +title: vertex_cover +description: API reference for qiskit.optimization.applications.ising.vertex_cover in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vertex_cover --- diff --git a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.md index d1c1fa4d758..78327eb7b7d 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.28/qiskit.providers.ibmq.IBMQBackend.md @@ -458,7 +458,7 @@ If a keyword specified here is also present in the `options` attribute/object, t * **meas\_lo\_freq** (`Optional`\[`List`\[`int`]]) – List of default measurement LO frequencies in Hz. Will be overridden by `schedule_los` if set. -* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. +* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. * **meas\_level** (`Union`\[`int`, `MeasLevel`, `None`]) – Set the appropriate level of the measurement output for pulse experiments. diff --git a/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.md index 358b4a9a8b8..bdc48b32d44 100644 --- a/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.28/qiskit.providers.models.PulseBackendConfiguration.md @@ -145,7 +145,7 @@ Return the acquisition channel for the given qubit. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") **Returns** @@ -170,7 +170,7 @@ Return the secondary drive channel for the given qubit – typically utilized fo **Return type** -`List`\[[`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")] +`List`\[[`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")] **Returns** @@ -212,7 +212,7 @@ backend.configuration().describe(ControlChannel(1)) **Parameters** -**channel** ([`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe. +**channel** ([`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe. **Raises** @@ -220,7 +220,7 @@ backend.configuration().describe(ControlChannel(1)) **Return type** -`Dict`\[[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel"), `complex`] +`Dict`\[[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel"), `complex`] **Returns** @@ -240,7 +240,7 @@ Return the drive channel for the given qubit. **Return type** -[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") +[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel") **Returns** @@ -300,7 +300,7 @@ Return a list of channels which operate on the given `qubit`. **Return type** -`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] **Returns** @@ -320,7 +320,7 @@ Return the measure stimulus channel for the given qubit. **Return type** -[`MeasureChannel`](qiskit.pulse.channels#qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") +[`MeasureChannel`](qiskit.pulse.channels#measurechannel "qiskit.pulse.channels.MeasureChannel") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.28/qiskit.pulse.Acquire.md index 463c97e41fd..21ea12f0366 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Acquire.md @@ -25,9 +25,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -47,9 +47,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -76,23 +76,23 @@ Create a new Acquire instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`acquire`](#qiskit.pulse.Acquire.acquire "qiskit.pulse.Acquire.acquire") | Acquire channel to acquire data. | -| [`channel`](#qiskit.pulse.Acquire.channel "qiskit.pulse.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Acquire.channels "qiskit.pulse.Acquire.channels") | Returns the channels that this schedule uses. | -| [`discriminator`](#qiskit.pulse.Acquire.discriminator "qiskit.pulse.Acquire.discriminator") | Return discrimination settings. | -| [`duration`](#qiskit.pulse.Acquire.duration "qiskit.pulse.Acquire.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Acquire.id "qiskit.pulse.Acquire.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Acquire.instructions "qiskit.pulse.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | -| [`kernel`](#qiskit.pulse.Acquire.kernel "qiskit.pulse.Acquire.kernel") | Return kernel settings. | -| [`mem_slot`](#qiskit.pulse.Acquire.mem_slot "qiskit.pulse.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | -| [`name`](#qiskit.pulse.Acquire.name "qiskit.pulse.Acquire.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Acquire.operands "qiskit.pulse.Acquire.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Acquire.parameters "qiskit.pulse.Acquire.parameters") | Parameters which determine the instruction behavior. | -| [`reg_slot`](#qiskit.pulse.Acquire.reg_slot "qiskit.pulse.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | -| [`start_time`](#qiskit.pulse.Acquire.start_time "qiskit.pulse.Acquire.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Acquire.stop_time "qiskit.pulse.Acquire.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`acquire`](#qiskit.pulse.Acquire.acquire "qiskit.pulse.Acquire.acquire") | Acquire channel to acquire data. | +| [`channel`](#qiskit.pulse.Acquire.channel "qiskit.pulse.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Acquire.channels "qiskit.pulse.Acquire.channels") | Returns the channels that this schedule uses. | +| [`discriminator`](#qiskit.pulse.Acquire.discriminator "qiskit.pulse.Acquire.discriminator") | Return discrimination settings. | +| [`duration`](#qiskit.pulse.Acquire.duration "qiskit.pulse.Acquire.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Acquire.id "qiskit.pulse.Acquire.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Acquire.instructions "qiskit.pulse.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | +| [`kernel`](#qiskit.pulse.Acquire.kernel "qiskit.pulse.Acquire.kernel") | Return kernel settings. | +| [`mem_slot`](#qiskit.pulse.Acquire.mem_slot "qiskit.pulse.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | +| [`name`](#qiskit.pulse.Acquire.name "qiskit.pulse.Acquire.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Acquire.operands "qiskit.pulse.Acquire.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Acquire.parameters "qiskit.pulse.Acquire.parameters") | Parameters which determine the instruction behavior. | +| [`reg_slot`](#qiskit.pulse.Acquire.reg_slot "qiskit.pulse.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | +| [`start_time`](#qiskit.pulse.Acquire.start_time "qiskit.pulse.Acquire.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Acquire.stop_time "qiskit.pulse.Acquire.stop_time") | Relative end time of this instruction. | ### acquire @@ -104,7 +104,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### append @@ -201,11 +201,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### channels @@ -217,7 +217,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]] +`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]] ### discriminator @@ -252,7 +252,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** @@ -366,7 +366,7 @@ The classical memory slot which will store the classified readout result. **Return type** -[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot") +[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot") ### name @@ -414,7 +414,7 @@ The fast-access register slot which will store the classified readout result for **Return type** -[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot") +[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot") ### shift diff --git a/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.md index 6998768b688..977a37a7c01 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.AcquireChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Call.md b/docs/api/qiskit/0.28/qiskit.pulse.Call.md index 8dc008e8a9f..6595c906c46 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Call.md @@ -221,7 +221,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -244,7 +244,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.md index b55d33e7a8f..f14a27549b7 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.ControlChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Delay.md b/docs/api/qiskit/0.28/qiskit.pulse.Delay.md index eda8634ad3c..9ef9f53191d 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Delay.md @@ -33,7 +33,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ### \_\_init\_\_ @@ -49,7 +49,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ## Methods @@ -70,18 +70,18 @@ No other instruction may be scheduled within a `Delay`. ## Attributes -| | | -| ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Delay.channel "qiskit.pulse.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Delay.channels "qiskit.pulse.Delay.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Delay.duration "qiskit.pulse.Delay.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Delay.id "qiskit.pulse.Delay.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Delay.instructions "qiskit.pulse.Delay.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.Delay.name "qiskit.pulse.Delay.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Delay.operands "qiskit.pulse.Delay.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Delay.parameters "qiskit.pulse.Delay.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.Delay.start_time "qiskit.pulse.Delay.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Delay.stop_time "qiskit.pulse.Delay.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.Delay.channel "qiskit.pulse.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Delay.channels "qiskit.pulse.Delay.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Delay.duration "qiskit.pulse.Delay.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Delay.id "qiskit.pulse.Delay.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Delay.instructions "qiskit.pulse.Delay.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.Delay.name "qiskit.pulse.Delay.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Delay.operands "qiskit.pulse.Delay.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Delay.parameters "qiskit.pulse.Delay.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.Delay.start_time "qiskit.pulse.Delay.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Delay.stop_time "qiskit.pulse.Delay.stop_time") | Relative end time of this instruction. | ### append @@ -178,11 +178,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") ### channels @@ -194,7 +194,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -217,7 +217,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.md index e99f3e0280d..3f799eff155 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.DriveChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.28/qiskit.pulse.Instruction.md index 0b7bf9ce0a5..c5fdc1fdc59 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Instruction.md @@ -20,7 +20,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -40,7 +40,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -177,7 +177,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -200,7 +200,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.md index 2c0a13e17c7..820bf6dbc2a 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.MeasureChannel.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.md index b70f6de1686..43c68c8f0e5 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.MemorySlot.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Play.md b/docs/api/qiskit/0.28/qiskit.pulse.Play.md index 7c6282a8313..a7d6608fc9d 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Play.md @@ -21,7 +21,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -39,7 +39,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -64,19 +64,19 @@ Create a new pulse instruction. ## Attributes -| | | -| ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Play.channel "qiskit.pulse.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.Play.channels "qiskit.pulse.Play.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Play.duration "qiskit.pulse.Play.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Play.id "qiskit.pulse.Play.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Play.instructions "qiskit.pulse.Play.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.Play.name "qiskit.pulse.Play.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Play.operands "qiskit.pulse.Play.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Play.parameters "qiskit.pulse.Play.parameters") | Parameters which determine the instruction behavior. | -| [`pulse`](#qiskit.pulse.Play.pulse "qiskit.pulse.Play.pulse") | A description of the samples that will be played. | -| [`start_time`](#qiskit.pulse.Play.start_time "qiskit.pulse.Play.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Play.stop_time "qiskit.pulse.Play.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.Play.channel "qiskit.pulse.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.Play.channels "qiskit.pulse.Play.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Play.duration "qiskit.pulse.Play.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Play.id "qiskit.pulse.Play.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Play.instructions "qiskit.pulse.Play.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.Play.name "qiskit.pulse.Play.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Play.operands "qiskit.pulse.Play.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Play.parameters "qiskit.pulse.Play.parameters") | Parameters which determine the instruction behavior. | +| [`pulse`](#qiskit.pulse.Play.pulse "qiskit.pulse.Play.pulse") | A description of the samples that will be played. | +| [`start_time`](#qiskit.pulse.Play.start_time "qiskit.pulse.Play.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Play.stop_time "qiskit.pulse.Play.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.md index 83423532caa..53e644cd0f5 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.RegisterSlot.md @@ -64,7 +64,7 @@ Return a new channel with the input Parameter assigned to value. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.28/qiskit.pulse.Schedule.md index 3dea124dce1..d4b3c13fc71 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Schedule.md @@ -223,7 +223,7 @@ Returns channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### children @@ -263,7 +263,7 @@ Plot the schedule. * **time\_unit** (`str`) – The unit of specified time range either dt or ns. The unit of ns is available only when backend object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. @@ -346,7 +346,7 @@ self.filter(args) | self.exclude(args) == self **Parameters** * **filter\_funcs** (`Callable`) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -369,7 +369,7 @@ If no arguments are provided, `self` is returned. **Parameters** * **filter\_funcs** (`Callable`) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -632,5 +632,5 @@ Time keeping attribute. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.md index d6b0af16fa0..57622395c54 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.ScheduleBlock.md @@ -237,7 +237,7 @@ Returns channels that this schedule clock uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -257,7 +257,7 @@ Plot the schedule. * **time\_unit** (`str`) – The unit of specified time range either dt or ns. The unit of ns is available only when backend object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. @@ -344,7 +344,7 @@ self.filter(args) | self.exclude(args) == self **Parameters** * **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -375,7 +375,7 @@ If no arguments are provided, `self` is returned. **Parameters** * **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. * **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. * **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. * **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. @@ -611,5 +611,5 @@ Time keeping attribute. **Return type** -`Dict`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] +`Dict`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `List`\[`Tuple`\[`int`, `int`]]] diff --git a/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.md index f158b213b66..d871e52fafd 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.SetFrequency.md @@ -27,7 +27,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -62,19 +62,19 @@ Creates a new set channel frequency instruction. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.SetFrequency.channel "qiskit.pulse.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.SetFrequency.channels "qiskit.pulse.SetFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.SetFrequency.duration "qiskit.pulse.SetFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.SetFrequency.frequency "qiskit.pulse.SetFrequency.frequency") | New frequency. | -| [`id`](#qiskit.pulse.SetFrequency.id "qiskit.pulse.SetFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.SetFrequency.instructions "qiskit.pulse.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.SetFrequency.name "qiskit.pulse.SetFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.SetFrequency.operands "qiskit.pulse.SetFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.SetFrequency.parameters "qiskit.pulse.SetFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.SetFrequency.start_time "qiskit.pulse.SetFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.SetFrequency.stop_time "qiskit.pulse.SetFrequency.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.SetFrequency.channel "qiskit.pulse.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.SetFrequency.channels "qiskit.pulse.SetFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.SetFrequency.duration "qiskit.pulse.SetFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.SetFrequency.frequency "qiskit.pulse.SetFrequency.frequency") | New frequency. | +| [`id`](#qiskit.pulse.SetFrequency.id "qiskit.pulse.SetFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.SetFrequency.instructions "qiskit.pulse.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.SetFrequency.name "qiskit.pulse.SetFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.SetFrequency.operands "qiskit.pulse.SetFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.SetFrequency.parameters "qiskit.pulse.SetFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.SetFrequency.start_time "qiskit.pulse.SetFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.SetFrequency.stop_time "qiskit.pulse.SetFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.md index 3a3d7b9f8a2..4096d28927c 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.SetPhase.md @@ -27,7 +27,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -62,19 +62,19 @@ Instantiate a set phase instruction, setting the output signal phase on `channel ## Attributes -| | | -| ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.SetPhase.channel "qiskit.pulse.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.SetPhase.channels "qiskit.pulse.SetPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.SetPhase.duration "qiskit.pulse.SetPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.SetPhase.id "qiskit.pulse.SetPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.SetPhase.instructions "qiskit.pulse.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.SetPhase.name "qiskit.pulse.SetPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.SetPhase.operands "qiskit.pulse.SetPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.SetPhase.parameters "qiskit.pulse.SetPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.SetPhase.phase "qiskit.pulse.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.SetPhase.start_time "qiskit.pulse.SetPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.SetPhase.stop_time "qiskit.pulse.SetPhase.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.SetPhase.channel "qiskit.pulse.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.SetPhase.channels "qiskit.pulse.SetPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.SetPhase.duration "qiskit.pulse.SetPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.SetPhase.id "qiskit.pulse.SetPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.SetPhase.instructions "qiskit.pulse.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.SetPhase.name "qiskit.pulse.SetPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.SetPhase.operands "qiskit.pulse.SetPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.SetPhase.parameters "qiskit.pulse.SetPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.SetPhase.phase "qiskit.pulse.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.SetPhase.start_time "qiskit.pulse.SetPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.SetPhase.stop_time "qiskit.pulse.SetPhase.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.md index 93590f38de2..abbbd4b3ac9 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.ShiftFrequency.md @@ -19,7 +19,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -33,7 +33,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -54,19 +54,19 @@ Creates a new shift frequency instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.ShiftFrequency.channel "qiskit.pulse.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.ShiftFrequency.channels "qiskit.pulse.ShiftFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.ShiftFrequency.duration "qiskit.pulse.ShiftFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.ShiftFrequency.frequency "qiskit.pulse.ShiftFrequency.frequency") | Frequency shift from the set frequency. | -| [`id`](#qiskit.pulse.ShiftFrequency.id "qiskit.pulse.ShiftFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.ShiftFrequency.instructions "qiskit.pulse.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.ShiftFrequency.name "qiskit.pulse.ShiftFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.ShiftFrequency.operands "qiskit.pulse.ShiftFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.ShiftFrequency.parameters "qiskit.pulse.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.ShiftFrequency.start_time "qiskit.pulse.ShiftFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.ShiftFrequency.stop_time "qiskit.pulse.ShiftFrequency.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.ShiftFrequency.channel "qiskit.pulse.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.ShiftFrequency.channels "qiskit.pulse.ShiftFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.ShiftFrequency.duration "qiskit.pulse.ShiftFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.ShiftFrequency.frequency "qiskit.pulse.ShiftFrequency.frequency") | Frequency shift from the set frequency. | +| [`id`](#qiskit.pulse.ShiftFrequency.id "qiskit.pulse.ShiftFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.ShiftFrequency.instructions "qiskit.pulse.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.ShiftFrequency.name "qiskit.pulse.ShiftFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.ShiftFrequency.operands "qiskit.pulse.ShiftFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.ShiftFrequency.parameters "qiskit.pulse.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.ShiftFrequency.start_time "qiskit.pulse.ShiftFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.ShiftFrequency.stop_time "qiskit.pulse.ShiftFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -163,11 +163,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -179,7 +179,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -202,7 +202,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.md index 689c3be5538..3c3db0d9d92 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.ShiftPhase `ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") -The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. +The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -29,7 +29,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -43,7 +43,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -64,19 +64,19 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch ## Attributes -| | | -| ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.ShiftPhase.channel "qiskit.pulse.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.ShiftPhase.channels "qiskit.pulse.ShiftPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.ShiftPhase.duration "qiskit.pulse.ShiftPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.ShiftPhase.id "qiskit.pulse.ShiftPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.ShiftPhase.instructions "qiskit.pulse.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.ShiftPhase.name "qiskit.pulse.ShiftPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.ShiftPhase.operands "qiskit.pulse.ShiftPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.ShiftPhase.parameters "qiskit.pulse.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.ShiftPhase.phase "qiskit.pulse.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.ShiftPhase.start_time "qiskit.pulse.ShiftPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.ShiftPhase.stop_time "qiskit.pulse.ShiftPhase.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.ShiftPhase.channel "qiskit.pulse.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.ShiftPhase.channels "qiskit.pulse.ShiftPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.ShiftPhase.duration "qiskit.pulse.ShiftPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.ShiftPhase.id "qiskit.pulse.ShiftPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.ShiftPhase.instructions "qiskit.pulse.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.ShiftPhase.name "qiskit.pulse.ShiftPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.ShiftPhase.operands "qiskit.pulse.ShiftPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.ShiftPhase.parameters "qiskit.pulse.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.ShiftPhase.phase "qiskit.pulse.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.ShiftPhase.start_time "qiskit.pulse.ShiftPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.ShiftPhase.stop_time "qiskit.pulse.ShiftPhase.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.md index 4df5a708c5f..544862446e7 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.Snapshot.md @@ -62,20 +62,20 @@ Create new snapshot. ## Attributes -| | | -| ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.Snapshot.channel "qiskit.pulse.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | -| [`channels`](#qiskit.pulse.Snapshot.channels "qiskit.pulse.Snapshot.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.Snapshot.duration "qiskit.pulse.Snapshot.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.Snapshot.id "qiskit.pulse.Snapshot.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.Snapshot.instructions "qiskit.pulse.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | -| [`label`](#qiskit.pulse.Snapshot.label "qiskit.pulse.Snapshot.label") | Label of snapshot. | -| [`name`](#qiskit.pulse.Snapshot.name "qiskit.pulse.Snapshot.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.Snapshot.operands "qiskit.pulse.Snapshot.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.Snapshot.parameters "qiskit.pulse.Snapshot.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.Snapshot.start_time "qiskit.pulse.Snapshot.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.Snapshot.stop_time "qiskit.pulse.Snapshot.stop_time") | Relative end time of this instruction. | -| [`type`](#qiskit.pulse.Snapshot.type "qiskit.pulse.Snapshot.type") | Type of snapshot. | +| | | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`channel`](#qiskit.pulse.Snapshot.channel "qiskit.pulse.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | +| [`channels`](#qiskit.pulse.Snapshot.channels "qiskit.pulse.Snapshot.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.Snapshot.duration "qiskit.pulse.Snapshot.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.Snapshot.id "qiskit.pulse.Snapshot.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.Snapshot.instructions "qiskit.pulse.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | +| [`label`](#qiskit.pulse.Snapshot.label "qiskit.pulse.Snapshot.label") | Label of snapshot. | +| [`name`](#qiskit.pulse.Snapshot.name "qiskit.pulse.Snapshot.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.Snapshot.operands "qiskit.pulse.Snapshot.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.Snapshot.parameters "qiskit.pulse.Snapshot.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.Snapshot.start_time "qiskit.pulse.Snapshot.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.Snapshot.stop_time "qiskit.pulse.Snapshot.stop_time") | Relative end time of this instruction. | +| [`type`](#qiskit.pulse.Snapshot.type "qiskit.pulse.Snapshot.type") | Type of snapshot. | ### append @@ -172,11 +172,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** -[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel") +[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel") ### channels @@ -188,7 +188,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel")] +`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel")] ### draw @@ -211,7 +211,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire.md index b155740cb8e..dc385ad2565 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire.md @@ -37,8 +37,8 @@ with pulse.build() as pulse_prog: **Parameters** * **duration** (`int`) – Duration to acquire data for -* **qubit\_or\_channel** (`Union`\[`int`, [`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")]) – Either the qubit to acquire data for or the specific [`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") to acquire on. -* **register** (`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])) – Location to store measured result. +* **qubit\_or\_channel** (`Union`\[`int`, [`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")]) – Either the qubit to acquire data for or the specific [`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") to acquire on. +* **register** (`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])) – Location to store measured result. * **metadata** (`Union`\[`Kernel`, `Discriminator`]) – Additional metadata for measurement. See [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire") for more information. **Raises** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire_channel.md index 59772098442..cb805c9a027 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.acquire_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.barrier.md index f7d1ce3013c..867986f31fa 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.barrier.md @@ -72,6 +72,6 @@ with pulse.build(backend) as pulse_prog: **Parameters** -* **channels\_or\_qubits** (`Union`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"), `int`]) – Channels or qubits to barrier. +* **channels\_or\_qubits** (`Union`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"), `int`]) – Channels or qubits to barrier. * **name** (`Optional`\[`str`]) – Name for the barrier diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.control_channels.md index 1f54e4d93d5..6e70c1a7b14 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.control_channels.md @@ -37,7 +37,7 @@ with pulse.build(backend): **Return type** -`List`\[[`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")] +`List`\[[`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")] **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.delay.md index e5ee2404190..cef465980e1 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.delay.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **duration** (`int`) – Number of cycles to delay for on `channel`. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Channel to delay on. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – Channel to delay on. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.drive_channel.md index 199b2376258..0954533412f 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.drive_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") +[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel") diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.frequency_offset.md index 89262f53778..ac1b318c989 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.frequency_offset.md @@ -41,7 +41,7 @@ assert len(pulse_prog.instructions) == 4 **Parameters** * **frequency** (`float`) – Amount of frequency offset in Hz. -* **channels** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset frequency of. +* **channels** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset frequency of. * **compensate\_phase** (`bool`) – Compensate for accumulated phase accumulated with respect to the channels’ frame at its initial frequency. **Yields** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure.md index c5b0c92a28a..ca9b35d9890 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure.md @@ -53,11 +53,11 @@ assert reg == mem0 **Parameters** * **qubits** (`Union`\[`List`\[`int`], `int`]) – Physical qubit to measure. -* **registers** (`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]), `None`]) – Register to store result in. If not selected the current behavior is to return the `MemorySlot` with the same index as `qubit`. This register will be returned. +* **registers** (`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]), `None`]) – Register to store result in. If not selected the current behavior is to return the `MemorySlot` with the same index as `qubit`. This register will be returned. **Return type** -`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")])] +`Union`\[`List`\[`NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])], `NewType()`(`StorageLocation`, `Union`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")])] **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_all.md index ec82b0249e4..09df2e00f29 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_all.md @@ -35,7 +35,7 @@ with pulse.build(backend) as pulse_prog: **Return type** -`List`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")] +`List`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")] **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_channel.md index 13f8e70cf44..dc5bb0eeece 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.measure_channel.md @@ -32,5 +32,5 @@ with pulse.build(backend): **Return type** -[`MeasureChannel`](qiskit.pulse.channels#qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") +[`MeasureChannel`](qiskit.pulse.channels#measurechannel "qiskit.pulse.channels.MeasureChannel") diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.pad.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.pad.md index 17ef784b00f..19396d3b77b 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.pad.md @@ -16,7 +16,7 @@ Deprecated. Pad all available timeslots with delays upon exiting context. **Parameters** -**chs** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Channels to pad with delays. Defaults to all channels in context if none are supplied. +**chs** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – Channels to pad with delays. Defaults to all channels in context if none are supplied. **Yields** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.phase_offset.md index 913a4735f38..4ac9536133e 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.phase_offset.md @@ -33,7 +33,7 @@ assert len(pulse_prog.instructions) == 3 **Parameters** * **phase** (`float`) – Amount of phase offset in radians. -* **channels** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset phase of. +* **channels** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channels to offset phase of. **Yields** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.play.md index d612eedd426..7aa1e665ae3 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.play.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **pulse** (`Union`\[`Pulse`, `ndarray`]) – Pulse to play. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to play pulse on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to play pulse on. * **name** (`Optional`\[`str`]) – Name of the pulse. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.qubit_channels.md index cdad23b8d5a..d1c6c2b14ea 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.qubit_channels.md @@ -40,5 +40,5 @@ with pulse.build(backend): **Return type** -`Set`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Set`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.set_frequency.md index 622e39e70c1..9a2adc4ac70 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.set_frequency.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **frequency** (`float`) – Frequency in Hz to set channel to. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to set frequency of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to set frequency of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.set_phase.md index 632b3c86ea6..124c645d77d 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.set_phase.md @@ -30,6 +30,6 @@ with pulse.build() as pulse_prog: **Parameters** * **phase** (`float`) – Phase in radians to set channel carrier signal to. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to set phase of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to set phase of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_frequency.md index b03b702ee32..86f9c48e6ec 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_frequency.md @@ -28,6 +28,6 @@ with pulse.build() as pulse_prog: **Parameters** * **frequency** (`float`) – Frequency in Hz to shift channel frequency by. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift frequency of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift frequency of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_phase.md index 98d056e2454..89bfc382db1 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.builder.shift_phase.md @@ -30,6 +30,6 @@ with pulse.build() as pulse_prog: **Parameters** * **phase** (`float`) – Phase in radians to shift channel carrier signal by. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift phase of. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – Channel to shift phase of. * **name** (`Optional`\[`str`]) – Name of the instruction. diff --git a/docs/api/qiskit/0.28/qiskit.pulse.channels.md b/docs/api/qiskit/0.28/qiskit.pulse.channels.md index 5097793bd2f..5c4e6ebaf8b 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.channels.md @@ -1,9 +1,9 @@ --- -title: AcquireChannel -description: API reference for qiskit.pulse.channels.AcquireChannel +title: channels +description: API reference for qiskit.pulse.channels in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit.pulse.channels.AcquireChannel +python_api_type: module +python_api_name: qiskit.pulse.channels --- diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.md index 3562402aa12..ba9ff115e89 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Acquire.md @@ -25,9 +25,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -47,9 +47,9 @@ Create a new Acquire instruction. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time to acquire data in terms of dt. -* **channel** ([`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. -* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. -* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. +* **channel** ([`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")) – The channel that will acquire data. +* **mem\_slot** (`Optional`\[[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot")]) – The classical memory slot in which to store the classified readout result. +* **reg\_slot** (`Optional`\[[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]) – The fast-access register slot in which to store the classified readout result for fast feedback. * **kernel** (`Optional`\[`Kernel`]) – A `Kernel` for integrating raw data. * **discriminator** (`Optional`\[`Discriminator`]) – A `Discriminator` for discriminating kerneled IQ data into 0/1 results. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. @@ -76,23 +76,23 @@ Create a new Acquire instruction. ## Attributes -| | | -| --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`acquire`](#qiskit.pulse.instructions.Acquire.acquire "qiskit.pulse.instructions.Acquire.acquire") | Acquire channel to acquire data. | -| [`channel`](#qiskit.pulse.instructions.Acquire.channel "qiskit.pulse.instructions.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Acquire.channels "qiskit.pulse.instructions.Acquire.channels") | Returns the channels that this schedule uses. | -| [`discriminator`](#qiskit.pulse.instructions.Acquire.discriminator "qiskit.pulse.instructions.Acquire.discriminator") | Return discrimination settings. | -| [`duration`](#qiskit.pulse.instructions.Acquire.duration "qiskit.pulse.instructions.Acquire.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Acquire.id "qiskit.pulse.instructions.Acquire.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Acquire.instructions "qiskit.pulse.instructions.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | -| [`kernel`](#qiskit.pulse.instructions.Acquire.kernel "qiskit.pulse.instructions.Acquire.kernel") | Return kernel settings. | -| [`mem_slot`](#qiskit.pulse.instructions.Acquire.mem_slot "qiskit.pulse.instructions.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | -| [`name`](#qiskit.pulse.instructions.Acquire.name "qiskit.pulse.instructions.Acquire.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Acquire.operands "qiskit.pulse.instructions.Acquire.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Acquire.parameters "qiskit.pulse.instructions.Acquire.parameters") | Parameters which determine the instruction behavior. | -| [`reg_slot`](#qiskit.pulse.instructions.Acquire.reg_slot "qiskit.pulse.instructions.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | -| [`start_time`](#qiskit.pulse.instructions.Acquire.start_time "qiskit.pulse.instructions.Acquire.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Acquire.stop_time "qiskit.pulse.instructions.Acquire.stop_time") | Relative end time of this instruction. | +| | | +| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`acquire`](#qiskit.pulse.instructions.Acquire.acquire "qiskit.pulse.instructions.Acquire.acquire") | Acquire channel to acquire data. | +| [`channel`](#qiskit.pulse.instructions.Acquire.channel "qiskit.pulse.instructions.Acquire.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Acquire.channels "qiskit.pulse.instructions.Acquire.channels") | Returns the channels that this schedule uses. | +| [`discriminator`](#qiskit.pulse.instructions.Acquire.discriminator "qiskit.pulse.instructions.Acquire.discriminator") | Return discrimination settings. | +| [`duration`](#qiskit.pulse.instructions.Acquire.duration "qiskit.pulse.instructions.Acquire.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Acquire.id "qiskit.pulse.instructions.Acquire.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Acquire.instructions "qiskit.pulse.instructions.Acquire.instructions") | Iterable for getting instructions from Schedule tree. | +| [`kernel`](#qiskit.pulse.instructions.Acquire.kernel "qiskit.pulse.instructions.Acquire.kernel") | Return kernel settings. | +| [`mem_slot`](#qiskit.pulse.instructions.Acquire.mem_slot "qiskit.pulse.instructions.Acquire.mem_slot") | The classical memory slot which will store the classified readout result. | +| [`name`](#qiskit.pulse.instructions.Acquire.name "qiskit.pulse.instructions.Acquire.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Acquire.operands "qiskit.pulse.instructions.Acquire.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Acquire.parameters "qiskit.pulse.instructions.Acquire.parameters") | Parameters which determine the instruction behavior. | +| [`reg_slot`](#qiskit.pulse.instructions.Acquire.reg_slot "qiskit.pulse.instructions.Acquire.reg_slot") | The fast-access register slot which will store the classified readout result for fast-feedback computation. | +| [`start_time`](#qiskit.pulse.instructions.Acquire.start_time "qiskit.pulse.instructions.Acquire.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Acquire.stop_time "qiskit.pulse.instructions.Acquire.stop_time") | Relative end time of this instruction. | ### acquire @@ -104,7 +104,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### append @@ -201,11 +201,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") +[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel") ### channels @@ -217,7 +217,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")]] +`Tuple`\[`Union`\[[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel"), [`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot"), [`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot")]] ### discriminator @@ -252,7 +252,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** @@ -366,7 +366,7 @@ The classical memory slot which will store the classified readout result. **Return type** -[`MemorySlot`](qiskit.pulse.channels#qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot") +[`MemorySlot`](qiskit.pulse.channels#memoryslot "qiskit.pulse.channels.MemorySlot") ### name @@ -414,7 +414,7 @@ The fast-access register slot which will store the classified readout result for **Return type** -[`RegisterSlot`](qiskit.pulse.channels#qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot") +[`RegisterSlot`](qiskit.pulse.channels#registerslot "qiskit.pulse.channels.RegisterSlot") ### shift diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.md index 751b15822f8..b07022f4c66 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Call.md @@ -221,7 +221,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -244,7 +244,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.md index 79fa267c4cf..3476ffb6741 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Delay.md @@ -33,7 +33,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ### \_\_init\_\_ @@ -49,7 +49,7 @@ No other instruction may be scheduled within a `Delay`. **Parameters** * **duration** (`Union`\[`int`, `ParameterExpression`]) – Length of time of the delay in terms of dt. -* **channel** ([`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. +* **channel** ([`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")) – The channel that will have the delay. * **name** (`Optional`\[`str`]) – Name of the delay for display purposes. ## Methods @@ -70,18 +70,18 @@ No other instruction may be scheduled within a `Delay`. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Delay.channel "qiskit.pulse.instructions.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Delay.channels "qiskit.pulse.instructions.Delay.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Delay.duration "qiskit.pulse.instructions.Delay.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Delay.id "qiskit.pulse.instructions.Delay.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Delay.instructions "qiskit.pulse.instructions.Delay.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.Delay.name "qiskit.pulse.instructions.Delay.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Delay.operands "qiskit.pulse.instructions.Delay.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Delay.parameters "qiskit.pulse.instructions.Delay.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.Delay.start_time "qiskit.pulse.instructions.Delay.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Delay.stop_time "qiskit.pulse.instructions.Delay.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.Delay.channel "qiskit.pulse.instructions.Delay.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Delay.channels "qiskit.pulse.instructions.Delay.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Delay.duration "qiskit.pulse.instructions.Delay.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Delay.id "qiskit.pulse.instructions.Delay.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Delay.instructions "qiskit.pulse.instructions.Delay.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.Delay.name "qiskit.pulse.instructions.Delay.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Delay.operands "qiskit.pulse.instructions.Delay.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Delay.parameters "qiskit.pulse.instructions.Delay.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.Delay.start_time "qiskit.pulse.instructions.Delay.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Delay.stop_time "qiskit.pulse.instructions.Delay.stop_time") | Relative end time of this instruction. | ### append @@ -178,11 +178,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") +[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") ### channels @@ -194,7 +194,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -217,7 +217,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.md index e505ec200c8..6ee3d1381f1 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Instruction.md @@ -20,7 +20,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -40,7 +40,7 @@ Instruction initializer. * **operands** (`Tuple`) – The argument list. * **duration** (`Optional`\[`int`]) – Deprecated. -* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Deprecated. +* **channels** (`Optional`\[`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Deprecated. * **name** (`Optional`\[`str`]) – Optional display name for this instruction. **Raises** @@ -177,7 +177,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +`Tuple`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")] ### draw @@ -200,7 +200,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.md index 03682f12e02..cd2667eeae1 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Play.md @@ -21,7 +21,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -39,7 +39,7 @@ Create a new pulse instruction. **Parameters** * **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** @@ -64,19 +64,19 @@ Create a new pulse instruction. ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Play.channel "qiskit.pulse.instructions.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.Play.channels "qiskit.pulse.instructions.Play.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Play.duration "qiskit.pulse.instructions.Play.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Play.id "qiskit.pulse.instructions.Play.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Play.instructions "qiskit.pulse.instructions.Play.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.Play.name "qiskit.pulse.instructions.Play.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Play.operands "qiskit.pulse.instructions.Play.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Play.parameters "qiskit.pulse.instructions.Play.parameters") | Parameters which determine the instruction behavior. | -| [`pulse`](#qiskit.pulse.instructions.Play.pulse "qiskit.pulse.instructions.Play.pulse") | A description of the samples that will be played. | -| [`start_time`](#qiskit.pulse.instructions.Play.start_time "qiskit.pulse.instructions.Play.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Play.stop_time "qiskit.pulse.instructions.Play.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.Play.channel "qiskit.pulse.instructions.Play.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.Play.channels "qiskit.pulse.instructions.Play.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Play.duration "qiskit.pulse.instructions.Play.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Play.id "qiskit.pulse.instructions.Play.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Play.instructions "qiskit.pulse.instructions.Play.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.Play.name "qiskit.pulse.instructions.Play.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Play.operands "qiskit.pulse.instructions.Play.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Play.parameters "qiskit.pulse.instructions.Play.parameters") | Parameters which determine the instruction behavior. | +| [`pulse`](#qiskit.pulse.instructions.Play.pulse "qiskit.pulse.instructions.Play.pulse") | A description of the samples that will be played. | +| [`start_time`](#qiskit.pulse.instructions.Play.start_time "qiskit.pulse.instructions.Play.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Play.stop_time "qiskit.pulse.instructions.Play.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.md index 5277d1cfdbf..d18463d9593 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetFrequency.md @@ -27,7 +27,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Creates a new set channel frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – New frequency of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -62,19 +62,19 @@ Creates a new set channel frequency instruction. ## Attributes -| | | -| ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.SetFrequency.channel "qiskit.pulse.instructions.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.SetFrequency.channels "qiskit.pulse.instructions.SetFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.SetFrequency.duration "qiskit.pulse.instructions.SetFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.instructions.SetFrequency.frequency "qiskit.pulse.instructions.SetFrequency.frequency") | New frequency. | -| [`id`](#qiskit.pulse.instructions.SetFrequency.id "qiskit.pulse.instructions.SetFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.SetFrequency.instructions "qiskit.pulse.instructions.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.SetFrequency.name "qiskit.pulse.instructions.SetFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.SetFrequency.operands "qiskit.pulse.instructions.SetFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.SetFrequency.parameters "qiskit.pulse.instructions.SetFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.SetFrequency.start_time "qiskit.pulse.instructions.SetFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.SetFrequency.stop_time "qiskit.pulse.instructions.SetFrequency.stop_time") | Relative end time of this instruction. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.SetFrequency.channel "qiskit.pulse.instructions.SetFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.SetFrequency.channels "qiskit.pulse.instructions.SetFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.SetFrequency.duration "qiskit.pulse.instructions.SetFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.instructions.SetFrequency.frequency "qiskit.pulse.instructions.SetFrequency.frequency") | New frequency. | +| [`id`](#qiskit.pulse.instructions.SetFrequency.id "qiskit.pulse.instructions.SetFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.SetFrequency.instructions "qiskit.pulse.instructions.SetFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.SetFrequency.name "qiskit.pulse.instructions.SetFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.SetFrequency.operands "qiskit.pulse.instructions.SetFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.SetFrequency.parameters "qiskit.pulse.instructions.SetFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.SetFrequency.start_time "qiskit.pulse.instructions.SetFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.SetFrequency.stop_time "qiskit.pulse.instructions.SetFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.md index 1a67f5e27d3..dd7fa1d7712 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.SetPhase.md @@ -27,7 +27,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -41,7 +41,7 @@ Instantiate a set phase instruction, setting the output signal phase on `channel **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -62,19 +62,19 @@ Instantiate a set phase instruction, setting the output signal phase on `channel ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.SetPhase.channel "qiskit.pulse.instructions.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.SetPhase.channels "qiskit.pulse.instructions.SetPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.SetPhase.duration "qiskit.pulse.instructions.SetPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.SetPhase.id "qiskit.pulse.instructions.SetPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.SetPhase.instructions "qiskit.pulse.instructions.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.SetPhase.name "qiskit.pulse.instructions.SetPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.SetPhase.operands "qiskit.pulse.instructions.SetPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.SetPhase.parameters "qiskit.pulse.instructions.SetPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.instructions.SetPhase.phase "qiskit.pulse.instructions.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.instructions.SetPhase.start_time "qiskit.pulse.instructions.SetPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.SetPhase.stop_time "qiskit.pulse.instructions.SetPhase.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.SetPhase.channel "qiskit.pulse.instructions.SetPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.SetPhase.channels "qiskit.pulse.instructions.SetPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.SetPhase.duration "qiskit.pulse.instructions.SetPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.SetPhase.id "qiskit.pulse.instructions.SetPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.SetPhase.instructions "qiskit.pulse.instructions.SetPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.SetPhase.name "qiskit.pulse.instructions.SetPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.SetPhase.operands "qiskit.pulse.instructions.SetPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.SetPhase.parameters "qiskit.pulse.instructions.SetPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.instructions.SetPhase.phase "qiskit.pulse.instructions.SetPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.instructions.SetPhase.start_time "qiskit.pulse.instructions.SetPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.SetPhase.stop_time "qiskit.pulse.instructions.SetPhase.stop_time") | Relative end time of this instruction. | ### append @@ -171,11 +171,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -187,7 +187,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -210,7 +210,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.md index 3f09a3dc09d..7579d41a2c0 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftFrequency.md @@ -19,7 +19,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ### \_\_init\_\_ @@ -33,7 +33,7 @@ Creates a new shift frequency instruction. **Parameters** * **frequency** (`Union`\[`float`, `ParameterExpression`]) – Frequency shift of the channel in Hz. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Name of this set channel frequency instruction. ## Methods @@ -54,19 +54,19 @@ Creates a new shift frequency instruction. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.ShiftFrequency.channel "qiskit.pulse.instructions.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.ShiftFrequency.channels "qiskit.pulse.instructions.ShiftFrequency.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.ShiftFrequency.duration "qiskit.pulse.instructions.ShiftFrequency.duration") | Duration of this instruction. | -| [`frequency`](#qiskit.pulse.instructions.ShiftFrequency.frequency "qiskit.pulse.instructions.ShiftFrequency.frequency") | Frequency shift from the set frequency. | -| [`id`](#qiskit.pulse.instructions.ShiftFrequency.id "qiskit.pulse.instructions.ShiftFrequency.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.ShiftFrequency.instructions "qiskit.pulse.instructions.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.ShiftFrequency.name "qiskit.pulse.instructions.ShiftFrequency.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.ShiftFrequency.operands "qiskit.pulse.instructions.ShiftFrequency.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.ShiftFrequency.parameters "qiskit.pulse.instructions.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.ShiftFrequency.start_time "qiskit.pulse.instructions.ShiftFrequency.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.ShiftFrequency.stop_time "qiskit.pulse.instructions.ShiftFrequency.stop_time") | Relative end time of this instruction. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.ShiftFrequency.channel "qiskit.pulse.instructions.ShiftFrequency.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.ShiftFrequency.channels "qiskit.pulse.instructions.ShiftFrequency.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.ShiftFrequency.duration "qiskit.pulse.instructions.ShiftFrequency.duration") | Duration of this instruction. | +| [`frequency`](#qiskit.pulse.instructions.ShiftFrequency.frequency "qiskit.pulse.instructions.ShiftFrequency.frequency") | Frequency shift from the set frequency. | +| [`id`](#qiskit.pulse.instructions.ShiftFrequency.id "qiskit.pulse.instructions.ShiftFrequency.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.ShiftFrequency.instructions "qiskit.pulse.instructions.ShiftFrequency.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.ShiftFrequency.name "qiskit.pulse.instructions.ShiftFrequency.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.ShiftFrequency.operands "qiskit.pulse.instructions.ShiftFrequency.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.ShiftFrequency.parameters "qiskit.pulse.instructions.ShiftFrequency.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.ShiftFrequency.start_time "qiskit.pulse.instructions.ShiftFrequency.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.ShiftFrequency.stop_time "qiskit.pulse.instructions.ShiftFrequency.stop_time") | Relative end time of this instruction. | ### append @@ -163,11 +163,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -179,7 +179,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -202,7 +202,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.md index fbc342da5e8..1c5e418fd25 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.ShiftPhase.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase `ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/phase.py "view source code") -The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. +The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). It is a relative increase in phase determined by the `phase` operand. In particular, a PulseChannel creates pulses of the form @@ -29,7 +29,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ### \_\_init\_\_ @@ -43,7 +43,7 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch **Parameters** * **phase** (`Union`\[`complex`, `ParameterExpression`]) – The rotation angle in radians. -* **channel** ([`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. +* **channel** ([`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")) – The channel this instruction operates on. * **name** (`Optional`\[`str`]) – Display name for this instruction. ## Methods @@ -64,19 +64,19 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch ## Attributes -| | | -| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.ShiftPhase.channel "qiskit.pulse.instructions.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | -| [`channels`](#qiskit.pulse.instructions.ShiftPhase.channels "qiskit.pulse.instructions.ShiftPhase.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.ShiftPhase.duration "qiskit.pulse.instructions.ShiftPhase.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.ShiftPhase.id "qiskit.pulse.instructions.ShiftPhase.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.ShiftPhase.instructions "qiskit.pulse.instructions.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | -| [`name`](#qiskit.pulse.instructions.ShiftPhase.name "qiskit.pulse.instructions.ShiftPhase.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.ShiftPhase.operands "qiskit.pulse.instructions.ShiftPhase.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.ShiftPhase.parameters "qiskit.pulse.instructions.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | -| [`phase`](#qiskit.pulse.instructions.ShiftPhase.phase "qiskit.pulse.instructions.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | -| [`start_time`](#qiskit.pulse.instructions.ShiftPhase.start_time "qiskit.pulse.instructions.ShiftPhase.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.ShiftPhase.stop_time "qiskit.pulse.instructions.ShiftPhase.stop_time") | Relative end time of this instruction. | +| | | +| ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| [`channel`](#qiskit.pulse.instructions.ShiftPhase.channel "qiskit.pulse.instructions.ShiftPhase.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. | +| [`channels`](#qiskit.pulse.instructions.ShiftPhase.channels "qiskit.pulse.instructions.ShiftPhase.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.ShiftPhase.duration "qiskit.pulse.instructions.ShiftPhase.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.ShiftPhase.id "qiskit.pulse.instructions.ShiftPhase.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.ShiftPhase.instructions "qiskit.pulse.instructions.ShiftPhase.instructions") | Iterable for getting instructions from Schedule tree. | +| [`name`](#qiskit.pulse.instructions.ShiftPhase.name "qiskit.pulse.instructions.ShiftPhase.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.ShiftPhase.operands "qiskit.pulse.instructions.ShiftPhase.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.ShiftPhase.parameters "qiskit.pulse.instructions.ShiftPhase.parameters") | Parameters which determine the instruction behavior. | +| [`phase`](#qiskit.pulse.instructions.ShiftPhase.phase "qiskit.pulse.instructions.ShiftPhase.phase") | Return the rotation angle enacted by this instruction in radians. | +| [`start_time`](#qiskit.pulse.instructions.ShiftPhase.start_time "qiskit.pulse.instructions.ShiftPhase.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.ShiftPhase.stop_time "qiskit.pulse.instructions.ShiftPhase.stop_time") | Relative end time of this instruction. | ### append @@ -173,11 +173,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** -[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel") +[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel") ### channels @@ -189,7 +189,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel")] +`Tuple`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel")] ### draw @@ -212,7 +212,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.md index f21c87af860..7d696d63e28 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.Snapshot.md @@ -62,20 +62,20 @@ Create new snapshot. ## Attributes -| | | -| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel`](#qiskit.pulse.instructions.Snapshot.channel "qiskit.pulse.instructions.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | -| [`channels`](#qiskit.pulse.instructions.Snapshot.channels "qiskit.pulse.instructions.Snapshot.channels") | Returns the channels that this schedule uses. | -| [`duration`](#qiskit.pulse.instructions.Snapshot.duration "qiskit.pulse.instructions.Snapshot.duration") | Duration of this instruction. | -| [`id`](#qiskit.pulse.instructions.Snapshot.id "qiskit.pulse.instructions.Snapshot.id") | Unique identifier for this instruction. | -| [`instructions`](#qiskit.pulse.instructions.Snapshot.instructions "qiskit.pulse.instructions.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | -| [`label`](#qiskit.pulse.instructions.Snapshot.label "qiskit.pulse.instructions.Snapshot.label") | Label of snapshot. | -| [`name`](#qiskit.pulse.instructions.Snapshot.name "qiskit.pulse.instructions.Snapshot.name") | Name of this instruction. | -| [`operands`](#qiskit.pulse.instructions.Snapshot.operands "qiskit.pulse.instructions.Snapshot.operands") | Return instruction operands. | -| [`parameters`](#qiskit.pulse.instructions.Snapshot.parameters "qiskit.pulse.instructions.Snapshot.parameters") | Parameters which determine the instruction behavior. | -| [`start_time`](#qiskit.pulse.instructions.Snapshot.start_time "qiskit.pulse.instructions.Snapshot.start_time") | Relative begin time of this instruction. | -| [`stop_time`](#qiskit.pulse.instructions.Snapshot.stop_time "qiskit.pulse.instructions.Snapshot.stop_time") | Relative end time of this instruction. | -| [`type`](#qiskit.pulse.instructions.Snapshot.type "qiskit.pulse.instructions.Snapshot.type") | Type of snapshot. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`channel`](#qiskit.pulse.instructions.Snapshot.channel "qiskit.pulse.instructions.Snapshot.channel") | Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. | +| [`channels`](#qiskit.pulse.instructions.Snapshot.channels "qiskit.pulse.instructions.Snapshot.channels") | Returns the channels that this schedule uses. | +| [`duration`](#qiskit.pulse.instructions.Snapshot.duration "qiskit.pulse.instructions.Snapshot.duration") | Duration of this instruction. | +| [`id`](#qiskit.pulse.instructions.Snapshot.id "qiskit.pulse.instructions.Snapshot.id") | Unique identifier for this instruction. | +| [`instructions`](#qiskit.pulse.instructions.Snapshot.instructions "qiskit.pulse.instructions.Snapshot.instructions") | Iterable for getting instructions from Schedule tree. | +| [`label`](#qiskit.pulse.instructions.Snapshot.label "qiskit.pulse.instructions.Snapshot.label") | Label of snapshot. | +| [`name`](#qiskit.pulse.instructions.Snapshot.name "qiskit.pulse.instructions.Snapshot.name") | Name of this instruction. | +| [`operands`](#qiskit.pulse.instructions.Snapshot.operands "qiskit.pulse.instructions.Snapshot.operands") | Return instruction operands. | +| [`parameters`](#qiskit.pulse.instructions.Snapshot.parameters "qiskit.pulse.instructions.Snapshot.parameters") | Parameters which determine the instruction behavior. | +| [`start_time`](#qiskit.pulse.instructions.Snapshot.start_time "qiskit.pulse.instructions.Snapshot.start_time") | Relative begin time of this instruction. | +| [`stop_time`](#qiskit.pulse.instructions.Snapshot.stop_time "qiskit.pulse.instructions.Snapshot.stop_time") | Relative end time of this instruction. | +| [`type`](#qiskit.pulse.instructions.Snapshot.type "qiskit.pulse.instructions.Snapshot.type") | Type of snapshot. | ### append @@ -172,11 +172,11 @@ Return maximum start time for supplied channels. `property channel` -Return the [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. +Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on; trivially, a `SnapshotChannel`. **Return type** -[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel") +[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel") ### channels @@ -188,7 +188,7 @@ Returns the channels that this schedule uses. **Return type** -`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel")] +`Tuple`\[[`SnapshotChannel`](qiskit.pulse.channels#snapshotchannel "qiskit.pulse.channels.SnapshotChannel")] ### draw @@ -211,7 +211,7 @@ Plot the instruction. * **table** (`bool`) – Draw event table for supported instructions * **label** (`bool`) – Label individual instructions * **framechange** (`bool`) – Add framechange indicators -* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot +* **channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A list of channel names to plot **Returns** diff --git a/docs/api/qiskit/0.28/qiskit.pulse.instructions.md b/docs/api/qiskit/0.28/qiskit.pulse.instructions.md index 02154d7c1ba..b3eda3b77e3 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.instructions.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.instructions.md @@ -1,10 +1,18 @@ +--- +title: instructions +description: API reference for qiskit.pulse.instructions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.instructions +--- + # qiskit.pulse.instructions -The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") specifying where the instruction will be applied. +The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") specifying where the instruction will be applied. -Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") `channel`: +Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") `channel`: ```python ShiftPhase(phase, channel) @@ -18,20 +26,21 @@ Delay(duration, channel) An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), which is a sequence of scheduled Pulse `Instruction` s over many channels. `Instruction` s and `Schedule` s implement the same interface. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | -| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | -| [`SetPhase`](qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | -| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | -| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | +| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | +| [`SetPhase`](qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | +| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). | +| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Abstract Classes | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`Instruction`](qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | + diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.28/qiskit.pulse.library.discrete.md index b1980522462..2bb30df0c46 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.discrete.md @@ -1,9 +1,9 @@ --- -title: constant -description: API reference for qiskit.pulse.library.discrete.constant +title: discrete +description: API reference for qiskit.pulse.library.discrete in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.pulse.library.discrete.constant +python_api_type: module +python_api_name: qiskit.pulse.library.discrete --- diff --git a/docs/api/qiskit/0.28/qiskit.pulse.library.md b/docs/api/qiskit/0.28/qiskit.pulse.library.md index 484c25b067f..66ef0e3edce 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.library.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.library.md @@ -1,3 +1,11 @@ +--- +title: library +description: API reference for qiskit.pulse.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library +--- + # qiskit.pulse.library @@ -18,3 +26,4 @@ The parametric pulses, [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse. | [`Drag`](qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | | [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | | [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma\[, …]) | A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio | + diff --git a/docs/api/qiskit/0.28/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.28/qiskit.pulse.transforms.pad.md index 96b65aefe82..c4916807d12 100644 --- a/docs/api/qiskit/0.28/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.28/qiskit.pulse.transforms.pad.md @@ -17,7 +17,7 @@ Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedu **Parameters** * **schedule** (`Schedule`) – Schedule to pad. -* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – Channels to pad. Defaults to all channels in `schedule` if not provided. If the supplied channel is not a member of `schedule` it will be added. +* **channels** (`Optional`\[`Iterable`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – Channels to pad. Defaults to all channels in `schedule` if not provided. If the supplied channel is not a member of `schedule` it will be added. * **until** (`Optional`\[`int`]) – Time to pad until. Defaults to `schedule.duration` if not provided. * **inplace** (`bool`) – Pad this schedule by mutating rather than returning a new schedule. diff --git a/docs/api/qiskit/0.28/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.28/qiskit.scheduler.methods.basic.md index aace97714e3..f64450184c4 100644 --- a/docs/api/qiskit/0.28/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.28/qiskit.scheduler.methods.basic.md @@ -1,9 +1,9 @@ --- -title: as_late_as_possible -description: API reference for qiskit.scheduler.methods.basic.as_late_as_possible +title: basic +description: API reference for qiskit.scheduler.methods.basic in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.scheduler.methods.basic.as_late_as_possible +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic --- diff --git a/docs/api/qiskit/0.28/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.28/qiskit.scheduler.schedule_circuit.md index d9295cb9789..cd74fda7445 100644 --- a/docs/api/qiskit/0.28/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.28/qiskit.scheduler.schedule_circuit.md @@ -1,9 +1,9 @@ --- title: schedule_circuit -description: API reference for qiskit.scheduler.schedule_circuit.schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit in_page_toc_min_heading_level: 1 -python_api_type: function -python_api_name: qiskit.scheduler.schedule_circuit.schedule_circuit +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit --- diff --git a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.draw.md b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.draw.md index 99bb2d85f9d..a488c639322 100644 --- a/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.draw.md +++ b/docs/api/qiskit/0.28/qiskit.visualization.pulse_v2.draw.md @@ -26,7 +26,7 @@ Generate visualization data for pulse programs. * **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. -* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list is not shown in the output image. +* **disable\_channels** (`Optional`\[`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list is not shown in the output image. * **show\_snapshot** (`bool`) – Show snapshot instructions. diff --git a/docs/api/qiskit/0.29/_toc.json b/docs/api/qiskit/0.29/_toc.json index 4b0b3c19b2f..31889fdc51e 100644 --- a/docs/api/qiskit/0.29/_toc.json +++ b/docs/api/qiskit/0.29/_toc.json @@ -12,10 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.29/algorithms" }, - { - "title": "ADAM", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.ADAM" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.29/qiskit.algorithms.AlgorithmError" @@ -40,34 +36,6 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.29/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.29/qiskit.algorithms.Eigensolver" @@ -76,10 +44,6 @@ "title": "EigensolverResult", "url": "/api/qiskit/0.29/qiskit.algorithms.EigensolverResult" }, - { - "title": "ESCH", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.ESCH" - }, { "title": "EstimationProblem", "url": "/api/qiskit/0.29/qiskit.algorithms.EstimationProblem" @@ -92,10 +56,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.29/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.GradientDescent" - }, { "title": "Grover", "url": "/api/qiskit/0.29/qiskit.algorithms.Grover" @@ -104,10 +64,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.29/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.29/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -120,14 +76,6 @@ "title": "HHL", "url": "/api/qiskit/0.29/qiskit.algorithms.HHL" }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.29/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -140,10 +88,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.29/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.L_BFGS_B" - }, { "title": "LinearSolver", "url": "/api/qiskit/0.29/qiskit.algorithms.LinearSolver" @@ -168,14 +112,6 @@ "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.29/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.29/qiskit.algorithms.NumPyEigensolver" @@ -188,18 +124,6 @@ "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.29/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.P_BFGS" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.29/qiskit.algorithms.PhaseEstimation" @@ -212,22 +136,10 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.29/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.POWELL" - }, { "title": "QAOA", "url": "/api/qiskit/0.29/qiskit.algorithms.QAOA" }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.QNSPSA" - }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "Shor", "url": "/api/qiskit/0.29/qiskit.algorithms.Shor" @@ -236,25 +148,126 @@ "title": "ShorResult", "url": "/api/qiskit/0.29/qiskit.algorithms.ShorResult" }, - { - "title": "SLSQP", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "TNC", - "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.TNC" - }, { "title": "VQE", "url": "/api/qiskit/0.29/qiskit.algorithms.VQE" + }, + { + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "qiskit.algorithms.optimizers.nlopts", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.nlopts" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.29/qiskit.algorithms.optimizers.TNC" + } + ] } ] }, @@ -1743,38 +1756,6 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.29/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.29/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.29/qiskit.circuit.library.Barrier" - }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CCXGate" - }, - { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CDKMRippleCarryAdder" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.29/qiskit.circuit.ClassicalRegister" @@ -1783,226 +1764,22 @@ "title": "Clbit", "url": "/api/qiskit/0.29/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_8_3" - }, { "title": "ControlledGate", "url": "/api/qiskit/0.29/qiskit.circuit.ControlledGate" }, - { - "title": "CPhaseGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CSwapGate" - }, - { - "title": "CSXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CSXGate" - }, - { - "title": "CU1Gate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CU1Gate" - }, - { - "title": "CU3Gate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CU3Gate" - }, - { - "title": "CUGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CUGate" - }, - { - "title": "CXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CXGate" - }, - { - "title": "CYGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CYGate" - }, - { - "title": "CZGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.CZGate" - }, - { - "title": "DCXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.DCXGate" - }, { "title": "Delay", "url": "/api/qiskit/0.29/qiskit.circuit.Delay" }, - { - "title": "Diagonal", - "url": "/api/qiskit/0.29/qiskit.circuit.library.Diagonal" - }, - { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.29/qiskit.circuit.library.DraperQFTAdder" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.EfficientSU2" - }, { "title": "EquivalenceLibrary", "url": "/api/qiskit/0.29/qiskit.circuit.EquivalenceLibrary" }, - { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.29/qiskit.circuit.library.EvolvedOperatorAnsatz" - }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.29/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.29/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.29/qiskit.circuit.library.FunctionalPauliRotations" - }, { "title": "Gate", "url": "/api/qiskit/0.29/qiskit.circuit.Gate" }, - { - "title": "GMS", - "url": "/api/qiskit/0.29/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.29/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.29/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.29/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.29/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.29/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.29/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.29/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.29/qiskit.circuit.library.HRSCumulativeMultiplier" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.29/qiskit.circuit.library.InnerProduct" - }, { "title": "Instruction", "url": "/api/qiskit/0.29/qiskit.circuit.Instruction" @@ -2012,547 +1789,792 @@ "url": "/api/qiskit/0.29/qiskit.circuit.InstructionSet" }, { - "title": "IntegerComparator", - "url": "/api/qiskit/0.29/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.29/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.29/qiskit.circuit.library.LinearAmplitudeFunction" + "title": "Measure", + "url": "/api/qiskit/0.29/qiskit.circuit.Measure" }, { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.29/qiskit.circuit.library.LinearPauliRotations" + "title": "Parameter", + "url": "/api/qiskit/0.29/qiskit.circuit.Parameter" }, { - "title": "LogNormalDistribution", - "url": "/api/qiskit/0.29/qiskit.circuit.library.LogNormalDistribution" + "title": "ParameterExpression", + "url": "/api/qiskit/0.29/qiskit.circuit.ParameterExpression" }, { - "title": "MCMT", - "url": "/api/qiskit/0.29/qiskit.circuit.library.MCMT" + "title": "ParameterVector", + "url": "/api/qiskit/0.29/qiskit.circuit.ParameterVector" }, { - "title": "MCMTVChain", - "url": "/api/qiskit/0.29/qiskit.circuit.library.MCMTVChain" + "title": "QuantumCircuit", + "url": "/api/qiskit/0.29/qiskit.circuit.QuantumCircuit" }, { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.MCPhaseGate" + "title": "QuantumRegister", + "url": "/api/qiskit/0.29/qiskit.circuit.QuantumRegister" }, { - "title": "MCXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.MCXGate" + "title": "Qubit", + "url": "/api/qiskit/0.29/qiskit.circuit.Qubit" }, { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.29/qiskit.circuit.library.MCXGrayCode" + "title": "random_circuit", + "url": "/api/qiskit/0.29/qiskit.circuit.random.random_circuit" }, { - "title": "MCXRecursive", - "url": "/api/qiskit/0.29/qiskit.circuit.library.MCXRecursive" + "title": "Reset", + "url": "/api/qiskit/0.29/qiskit.circuit.Reset" }, { - "title": "MCXVChain", - "url": "/api/qiskit/0.29/qiskit.circuit.library.MCXVChain" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.29/qiskit.circuit.Measure" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.29/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.29/qiskit.circuit.library.NLocal" - }, - { - "title": "NormalDistribution", - "url": "/api/qiskit/0.29/qiskit.circuit.library.NormalDistribution" - }, - { - "title": "OR", - "url": "/api/qiskit/0.29/qiskit.circuit.library.OR" - }, - { - "title": "Parameter", - "url": "/api/qiskit/0.29/qiskit.circuit.Parameter" - }, - { - "title": "ParameterExpression", - "url": "/api/qiskit/0.29/qiskit.circuit.ParameterExpression" - }, - { - "title": "ParameterVector", - "url": "/api/qiskit/0.29/qiskit.circuit.ParameterVector" - }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.29/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.29/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.29/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.29/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.29/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.29/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.29/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.29/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.29/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.29/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.29/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.29/qiskit.circuit.library.QuadraticForm" - }, - { - "title": "QuantumCircuit", - "url": "/api/qiskit/0.29/qiskit.circuit.QuantumCircuit" - }, - { - "title": "QuantumRegister", - "url": "/api/qiskit/0.29/qiskit.circuit.QuantumRegister" - }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.29/qiskit.circuit.library.QuantumVolume" - }, - { - "title": "Qubit", - "url": "/api/qiskit/0.29/qiskit.circuit.Qubit" - }, - { - "title": "random_circuit", - "url": "/api/qiskit/0.29/qiskit.circuit.random.random_circuit" - }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RealAmplitudes" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.29/qiskit.circuit.Reset" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.29/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.SGate" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.29/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.UGate" - }, - { - "title": "UniformDistribution", - "url": "/api/qiskit/0.29/qiskit.circuit.library.UniformDistribution" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.29/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.29/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.29/qiskit.circuit.library.XOR" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.29/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.29/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.29/qiskit.circuit.library.ZZFeatureMap" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.29/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.29/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.29/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.29/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.29/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.29/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.29/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.29/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.29/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.29/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.29/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.29/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.29/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.29/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.29/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.29/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.29/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.29/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.29/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.29/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.29/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.29/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.29/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.29/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.29/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.29/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "LogNormalDistribution", + "url": "/api/qiskit/0.29/qiskit.circuit.library.LogNormalDistribution" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.29/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.29/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.29/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.29/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.29/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.29/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.29/qiskit.circuit.library.NLocal" + }, + { + "title": "NormalDistribution", + "url": "/api/qiskit/0.29/qiskit.circuit.library.NormalDistribution" + }, + { + "title": "OR", + "url": "/api/qiskit/0.29/qiskit.circuit.library.OR" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.29/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.29/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.29/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.29/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.29/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.29/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.29/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.29/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.29/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.29/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.29/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.29/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.29/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.29/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_cy" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.29/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "rzx_xz", + "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_xz" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "rzx_yz", + "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_yz" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "rzx_zz1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_zz1" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.29/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "rzx_zz2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.29/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.SGate" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.29/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.29/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.U2Gate" + }, + { + "title": "U3Gate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.U3Gate" + }, + { + "title": "UGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.UGate" + }, + { + "title": "UniformDistribution", + "url": "/api/qiskit/0.29/qiskit.circuit.library.UniformDistribution" + }, + { + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.29/qiskit.circuit.library.VBERippleCarryAdder" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.29/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.29/qiskit.circuit.library.XOR" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.29/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.29/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.29/qiskit.circuit.library.ZZFeatureMap" } ] }, @@ -2723,7 +2745,20 @@ }, { "title": "qiskit.finance.applications.ising", - "url": "/api/qiskit/0.29/qiskit.finance.applications.ising" + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.finance.applications.ising" + }, + { + "title": "qiskit.finance.applications.ising.portfolio", + "url": "/api/qiskit/0.29/qiskit.finance.applications.ising.portfolio" + }, + { + "title": "qiskit.finance.applications.ising.portfolio_diversification", + "url": "/api/qiskit/0.29/qiskit.finance.applications.ising.portfolio_diversification" + } + ] } ] }, @@ -3158,6 +3193,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.29/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.29/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.29/qiskit.ignis.verification.QOTP" @@ -3276,225 +3315,288 @@ "title": "Overview", "url": "/api/qiskit/0.29/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.29/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.29/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.29/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.29/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.29/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.29/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.29/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.29/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.29/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.29/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.29/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.29/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.29/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.29/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.29/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.29/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.29/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.29/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.29/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.29/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.29/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.29/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.29/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.29/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.29/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.29/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.29/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.29/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.29/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.29/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.29/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.29/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.29/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.29/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.29/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.29/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.29/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.29/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.29/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.29/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.29/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.29/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.29/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.29/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.29/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.29/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.29/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.29/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.29/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.29/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.29/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.29/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.29/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.29/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.29/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.29/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.29/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3611,7 +3713,64 @@ }, { "title": "qiskit.optimization.applications.ising", - "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising" + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising" + }, + { + "title": "qiskit.optimization.applications.ising.clique", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.clique" + }, + { + "title": "qiskit.optimization.applications.ising.common", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.common" + }, + { + "title": "qiskit.optimization.applications.ising.docplex", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.docplex" + }, + { + "title": "qiskit.optimization.applications.ising.exact_cover", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.exact_cover" + }, + { + "title": "qiskit.optimization.applications.ising.graph_partition", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.graph_partition" + }, + { + "title": "qiskit.optimization.applications.ising.knapsack", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.knapsack" + }, + { + "title": "qiskit.optimization.applications.ising.max_cut", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.max_cut" + }, + { + "title": "qiskit.optimization.applications.ising.partition", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.partition" + }, + { + "title": "qiskit.optimization.applications.ising.set_packing", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.set_packing" + }, + { + "title": "qiskit.optimization.applications.ising.stable_set", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.stable_set" + }, + { + "title": "qiskit.optimization.applications.ising.tsp", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.tsp" + }, + { + "title": "qiskit.optimization.applications.ising.vehicle_routing", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.vehicle_routing" + }, + { + "title": "qiskit.optimization.applications.ising.vertex_cover", + "url": "/api/qiskit/0.29/qiskit.optimization.applications.ising.vertex_cover" + } + ] } ] }, @@ -4559,10 +4718,6 @@ "title": "acquire", "url": "/api/qiskit/0.29/qiskit.pulse.builder.acquire" }, - { - "title": "Acquire", - "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Acquire" - }, { "title": "acquire_channel", "url": "/api/qiskit/0.29/qiskit.pulse.builder.acquire_channel" @@ -4627,10 +4782,6 @@ "title": "call", "url": "/api/qiskit/0.29/qiskit.pulse.builder.call" }, - { - "title": "Call", - "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Call" - }, { "title": "circuit_scheduler_settings", "url": "/api/qiskit/0.29/qiskit.pulse.builder.circuit_scheduler_settings" @@ -4639,10 +4790,6 @@ "title": "Constant", "url": "/api/qiskit/0.29/qiskit.pulse.Constant" }, - { - "title": "Constant", - "url": "/api/qiskit/0.29/qiskit.pulse.library.Constant" - }, { "title": "control_channels", "url": "/api/qiskit/0.29/qiskit.pulse.builder.control_channels" @@ -4663,10 +4810,6 @@ "title": "delay", "url": "/api/qiskit/0.29/qiskit.pulse.builder.delay" }, - { - "title": "Delay", - "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Delay" - }, { "title": "delay_qubits", "url": "/api/qiskit/0.29/qiskit.pulse.builder.delay_qubits" @@ -4675,10 +4818,6 @@ "title": "Drag", "url": "/api/qiskit/0.29/qiskit.pulse.Drag" }, - { - "title": "Drag", - "url": "/api/qiskit/0.29/qiskit.pulse.library.Drag" - }, { "title": "drive_channel", "url": "/api/qiskit/0.29/qiskit.pulse.builder.drive_channel" @@ -4695,18 +4834,10 @@ "title": "Gaussian", "url": "/api/qiskit/0.29/qiskit.pulse.Gaussian" }, - { - "title": "Gaussian", - "url": "/api/qiskit/0.29/qiskit.pulse.library.Gaussian" - }, { "title": "GaussianSquare", "url": "/api/qiskit/0.29/qiskit.pulse.GaussianSquare" }, - { - "title": "GaussianSquare", - "url": "/api/qiskit/0.29/qiskit.pulse.library.GaussianSquare" - }, { "title": "inline", "url": "/api/qiskit/0.29/qiskit.pulse.builder.inline" @@ -4715,10 +4846,6 @@ "title": "Instruction", "url": "/api/qiskit/0.29/qiskit.pulse.Instruction" }, - { - "title": "Instruction", - "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Instruction" - }, { "title": "InstructionScheduleMap", "url": "/api/qiskit/0.29/qiskit.pulse.InstructionScheduleMap" @@ -4767,14 +4894,14 @@ "title": "play", "url": "/api/qiskit/0.29/qiskit.pulse.builder.play" }, - { - "title": "Play", - "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Play" - }, { "title": "PulseError", "url": "/api/qiskit/0.29/qiskit.pulse.PulseError" }, + { + "title": "qiskit.pulse.channels", + "url": "/api/qiskit/0.29/qiskit.pulse.channels" + }, { "title": "qubit_channels", "url": "/api/qiskit/0.29/qiskit.pulse.builder.qubit_channels" @@ -4811,18 +4938,10 @@ "title": "SetFrequency", "url": "/api/qiskit/0.29/qiskit.pulse.SetFrequency" }, - { - "title": "SetFrequency", - "url": "/api/qiskit/0.29/qiskit.pulse.instructions.SetFrequency" - }, { "title": "SetPhase", "url": "/api/qiskit/0.29/qiskit.pulse.SetPhase" }, - { - "title": "SetPhase", - "url": "/api/qiskit/0.29/qiskit.pulse.instructions.SetPhase" - }, { "title": "shift_frequency", "url": "/api/qiskit/0.29/qiskit.pulse.builder.shift_frequency" @@ -4835,18 +4954,10 @@ "title": "ShiftFrequency", "url": "/api/qiskit/0.29/qiskit.pulse.ShiftFrequency" }, - { - "title": "ShiftFrequency", - "url": "/api/qiskit/0.29/qiskit.pulse.instructions.ShiftFrequency" - }, { "title": "ShiftPhase", "url": "/api/qiskit/0.29/qiskit.pulse.ShiftPhase" }, - { - "title": "ShiftPhase", - "url": "/api/qiskit/0.29/qiskit.pulse.instructions.ShiftPhase" - }, { "title": "Snapshot", "url": "/api/qiskit/0.29/qiskit.pulse.Snapshot" @@ -4855,10 +4966,6 @@ "title": "snapshot", "url": "/api/qiskit/0.29/qiskit.pulse.builder.snapshot" }, - { - "title": "Snapshot", - "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Snapshot" - }, { "title": "transpiler_settings", "url": "/api/qiskit/0.29/qiskit.pulse.builder.transpiler_settings" @@ -4879,13 +4986,91 @@ "title": "Waveform", "url": "/api/qiskit/0.29/qiskit.pulse.Waveform" }, - { - "title": "Waveform", - "url": "/api/qiskit/0.29/qiskit.pulse.library.Waveform" - }, { "title": "x", "url": "/api/qiskit/0.29/qiskit.pulse.builder.x" + }, + { + "title": "qiskit.pulse.instructions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.pulse.instructions" + }, + { + "title": "Acquire", + "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Acquire" + }, + { + "title": "Call", + "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Call" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Delay" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Instruction" + }, + { + "title": "Play", + "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Play" + }, + { + "title": "SetFrequency", + "url": "/api/qiskit/0.29/qiskit.pulse.instructions.SetFrequency" + }, + { + "title": "SetPhase", + "url": "/api/qiskit/0.29/qiskit.pulse.instructions.SetPhase" + }, + { + "title": "ShiftFrequency", + "url": "/api/qiskit/0.29/qiskit.pulse.instructions.ShiftFrequency" + }, + { + "title": "ShiftPhase", + "url": "/api/qiskit/0.29/qiskit.pulse.instructions.ShiftPhase" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.29/qiskit.pulse.instructions.Snapshot" + } + ] + }, + { + "title": "qiskit.pulse.library", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.29/qiskit.pulse.library" + }, + { + "title": "Constant", + "url": "/api/qiskit/0.29/qiskit.pulse.library.Constant" + }, + { + "title": "Drag", + "url": "/api/qiskit/0.29/qiskit.pulse.library.Drag" + }, + { + "title": "Gaussian", + "url": "/api/qiskit/0.29/qiskit.pulse.library.Gaussian" + }, + { + "title": "GaussianSquare", + "url": "/api/qiskit/0.29/qiskit.pulse.library.GaussianSquare" + }, + { + "title": "qiskit.pulse.library.discrete", + "url": "/api/qiskit/0.29/qiskit.pulse.library.discrete" + }, + { + "title": "Waveform", + "url": "/api/qiskit/0.29/qiskit.pulse.library.Waveform" + } + ] } ] }, @@ -5236,6 +5421,14 @@ "title": "Overview", "url": "/api/qiskit/0.29/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.29/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.29/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.29/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.29/circuit_library.md b/docs/api/qiskit/0.29/circuit_library.md index 5690a237078..d38da990492 100644 --- a/docs/api/qiskit/0.29/circuit_library.md +++ b/docs/api/qiskit/0.29/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -277,3 +289,4 @@ | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.md index 189091514ea..9aef02e1505 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -67,3 +79,4 @@ The global optimizers are as follows: | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.nlopts.md b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.nlopts.md index f7fb470a11e..b430ce1d9d8 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.nlopts.md +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.nlopts.md @@ -1,3 +1,11 @@ +--- +title: nlopts +description: API reference for qiskit.algorithms.optimizers.nlopts +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.nlopts +--- + # qiskit.algorithms.optimizers.nlopts @@ -26,3 +34,4 @@ export PYTHONPATH=/usr/local/lib/python3.6/site-packages:${PYTHONPATH} ``` The two `export` commands above can be pasted into the `.bash_profile` file in the user’s home directory for automatic execution. Now you can run Qiskit and these optimizers should be available for you to use. + diff --git a/docs/api/qiskit/0.29/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.29/qiskit.finance.applications.ising.portfolio.md index b0a1fd4ce14..d8ff1c47f32 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.29/qiskit.finance.applications.ising.portfolio.md @@ -1,3 +1,11 @@ +--- +title: portfolio +description: API reference for qiskit.finance.applications.ising.portfolio +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio +--- + # qiskit.finance.applications.ising.portfolio @@ -13,3 +21,4 @@ Convert portfolio optimization instances into Pauli list | `portfolio_value`(x, mu, sigma, q, budget, penalty) | returns portfolio value | | `portfolio_variance`(x, sigma) | returns portfolio variance | | `random_model`(n\[, seed]) | Generate random model (mu, sigma) for portfolio optimization problem. | + diff --git a/docs/api/qiskit/0.29/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.29/qiskit.finance.applications.ising.portfolio_diversification.md index d9bfae4b1fd..34bcd93172d 100644 --- a/docs/api/qiskit/0.29/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.29/qiskit.finance.applications.ising.portfolio_diversification.md @@ -1,3 +1,11 @@ +--- +title: portfolio_diversification +description: API reference for qiskit.finance.applications.ising.portfolio_diversification +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio_diversification +--- + # qiskit.finance.applications.ising.portfolio\_diversification @@ -11,3 +19,4 @@ portfolio diversification | `get_operator`(rho, n, q) | Converts an instance of portfolio optimization into a list of Paulis. | | `get_portfoliodiversification_solution`(rho, …) | Tries to obtain a feasible solution (in vector form) of an instance of portfolio diversification from the results dictionary. | | `get_portfoliodiversification_value`(rho, n, …) | Evaluates an objective function of an instance of portfolio diversification and its solution (in vector form). | + diff --git a/docs/api/qiskit/0.29/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.29/qiskit.ignis.verification.basis.md index e26610b6708..c7c0137e9f8 100644 --- a/docs/api/qiskit/0.29/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.29/qiskit.ignis.verification.basis.md @@ -1,5 +1,14 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # qiskit.ignis.verification.basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.29/qiskit.opflow.converters.md b/docs/api/qiskit/0.29/qiskit.opflow.converters.md index de1cf2608c0..dd5860cb4b8 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, …]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, …]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.md index c1fbc4558e7..35e46f5058d 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.29/qiskit.opflow.expectations.md b/docs/api/qiskit/0.29/qiskit.opflow.expectations.md index 5f7f2c40cb7..9c99521085d 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.29/qiskit.opflow.gradients.md b/docs/api/qiskit/0.29/qiskit.opflow.gradients.md index d47fd11d45b..d19fdc725a5 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, …]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.md index e4108d55522..5593a1b809a 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](qiskit.aqua.operators.list_ops#module-qiskit.aqua.operators.list_ops "qiskit.aqua.operators.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.md index 9b8d4929b0c..c1f8f35ade4 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.md index be5505d8a1f..ada961c9425 100644 --- a/docs/api/qiskit/0.29/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.29/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, …]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, …]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.clique.md index 2e4cee68850..1abbbaf85c3 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.clique.md @@ -1,3 +1,11 @@ +--- +title: clique +description: API reference for qiskit.optimization.applications.ising.clique +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.clique +--- + # qiskit.optimization.applications.ising.clique @@ -13,3 +21,4 @@ Deal with Gset format. See [https://web.stanford.edu/\~yyye/yyye/Gset/](https:// | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix, K) | Generate Hamiltonian for the clique. | | `satisfy_or_not`(x, w, K) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.common.md index 60923757fc4..26464086f88 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.common.md @@ -1,3 +1,11 @@ +--- +title: common +description: API reference for qiskit.optimization.applications.ising.common +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.common +--- + # qiskit.optimization.applications.ising.common @@ -14,3 +22,4 @@ common module | `random_number_list`(n\[, weight\_range, …]) | Generate a set of positive integers within the given range. | | `read_numbers_from_file`(filename) | Read numbers from a file | | `sample_most_likely`(state\_vector) | Compute the most likely binary string from state vector. | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.docplex.md index 8a8fff9aa95..944b3c91d9b 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.docplex.md @@ -1,3 +1,11 @@ +--- +title: docplex +description: API reference for qiskit.optimization.applications.ising.docplex +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.docplex +--- + # qiskit.optimization.applications.ising.docplex @@ -49,3 +57,4 @@ print('tsp objective:', result['energy'] + offset) | | | | ---------------------------------------- | --------------------------------------------------- | | `get_operator`(mdl\[, auto\_penalty, …]) | Generate Ising Hamiltonian from a model of DOcplex. | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.exact_cover.md index 4bbd8e4a464..5b6dde4bf45 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.exact_cover.md @@ -1,3 +1,11 @@ +--- +title: exact_cover +description: API reference for qiskit.optimization.applications.ising.exact_cover +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.exact_cover +--- + # qiskit.optimization.applications.ising.exact\_cover @@ -11,3 +19,4 @@ exact cover | `check_solution_satisfiability`(sol, …) | check solution satisfiability | | `get_operator`(list\_of\_subsets) | Construct the Hamiltonian for the exact solver problem. | | `get_solution`(x) | **param x**binary string as numpy array. | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.graph_partition.md index 9249f6a3fae..8236aeed15a 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.graph_partition.md @@ -1,3 +1,11 @@ +--- +title: graph_partition +description: API reference for qiskit.optimization.applications.ising.graph_partition +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.graph_partition +--- + # qiskit.optimization.applications.ising.graph\_partition @@ -11,3 +19,4 @@ Convert graph partitioning instances into Pauli list Deal with Gset format. See | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the graph partitioning | | `objective_value`(x, w) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.knapsack.md index e9f34622a28..da979a64833 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.knapsack.md @@ -1,3 +1,11 @@ +--- +title: knapsack +description: API reference for qiskit.optimization.applications.ising.knapsack +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.knapsack +--- + # qiskit.optimization.applications.ising.knapsack @@ -15,3 +23,4 @@ If we have the weights w\[i], the values v\[i] and the maximum weight W\_max. We | `get_operator`(values, weights, max\_weight) | Generate Hamiltonian for the knapsack problem. | | `get_solution`(x, values) | Get the solution to the knapsack problem from the bitstring that represents to the ground state of the Hamiltonian | | `knapsack_value_weight`(solution, values, weights) | Get the total wight and value of the items taken in the knapsack. | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.max_cut.md index 5ff110e890e..44417cf9629 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.max_cut.md @@ -1,3 +1,11 @@ +--- +title: max_cut +description: API reference for qiskit.optimization.applications.ising.max_cut +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.max_cut +--- + # qiskit.optimization.applications.ising.max\_cut @@ -11,3 +19,4 @@ Convert max-cut instances into Pauli list Deal with Gset format. See [https://we | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the max-cut problem of a graph. | | `max_cut_value`(x, w) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.partition.md index d7d2956ba87..d09b7f6bf41 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.partition.md @@ -1,3 +1,11 @@ +--- +title: partition +description: API reference for qiskit.optimization.applications.ising.partition +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.partition +--- + # qiskit.optimization.applications.ising.partition @@ -10,3 +18,4 @@ Generate Number Partitioning (Partition) instances, and convert them into a Hami | ---------------------------------- | --------------------------------------------------------- | | `get_operator`(values) | Construct the Hamiltonian for a given Partition instance. | | `partition_value`(x, number\_list) | Compute the value of a partition. | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.set_packing.md index e285f22c000..7e956256324 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.set_packing.md @@ -1,3 +1,11 @@ +--- +title: set_packing +description: API reference for qiskit.optimization.applications.ising.set_packing +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.set_packing +--- + # qiskit.optimization.applications.ising.set\_packing @@ -11,3 +19,4 @@ set packing module | `check_disjoint`(sol, list\_of\_subsets) | check disjoint | | `get_operator`(list\_of\_subsets) | Construct the Hamiltonian for the set packing. | | `get_solution`(x) | **param x**binary string as numpy array. | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.stable_set.md index ad51e1a564f..947b8706017 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.stable_set.md @@ -1,3 +1,11 @@ +--- +title: stable_set +description: API reference for qiskit.optimization.applications.ising.stable_set +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.stable_set +--- + # qiskit.optimization.applications.ising.stable\_set @@ -11,3 +19,4 @@ Convert stable set instances into Pauli list. We read instances in the Gset form | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(w) | Generate Hamiltonian for the maximum stable set in a graph. | | `stable_set_value`(x, w) | Compute the value of a stable set, and its feasibility. | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.tsp.md index 139fd94208f..7667c627129 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.tsp.md @@ -1,3 +1,11 @@ +--- +title: tsp +description: API reference for qiskit.optimization.applications.ising.tsp +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.tsp +--- + # qiskit.optimization.applications.ising.tsp @@ -21,3 +29,4 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp | | | | ------------------------------ | --------------------------------------------------- | | `TspData`(name, dim, coord, w) | Create new instance of TspData(name, dim, coord, w) | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.vehicle_routing.md index 59ce2163183..a9608a20790 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.vehicle_routing.md @@ -1,3 +1,11 @@ +--- +title: vehicle_routing +description: API reference for qiskit.optimization.applications.ising.vehicle_routing +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vehicle_routing +--- + # qiskit.optimization.applications.ising.vehicle\_routing @@ -12,3 +20,4 @@ Converts vehicle routing instances into a list of Paulis, and provides some rela | `get_vehiclerouting_cost`(instance, n, K, x\_sol) | Computes the cost of a solution to an instance of a vehicle routing problem. | | `get_vehiclerouting_matrices`(instance, n, K) | Constructs auxiliary matrices from a vehicle routing instance, | | `get_vehiclerouting_solution`(instance, n, K, …) | Tries to obtain a feasible solution (in vector form) of an instance | + diff --git a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.vertex_cover.md index 2ad3728e28b..c55648d7d3d 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.29/qiskit.optimization.applications.ising.vertex_cover.md @@ -1,3 +1,11 @@ +--- +title: vertex_cover +description: API reference for qiskit.optimization.applications.ising.vertex_cover +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vertex_cover +--- + # qiskit.optimization.applications.ising.vertex\_cover @@ -11,3 +19,4 @@ Convert vertex cover instances into Pauli list Deal with Gset format. See [https | `check_full_edge_coverage`(x, w) | **param x**binary string as numpy array. | | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the vertex cover :param weight\_matrix: adjacency matrix. | + diff --git a/docs/api/qiskit/0.29/qiskit.pulse.channels.md b/docs/api/qiskit/0.29/qiskit.pulse.channels.md index 0335b26e49e..6f6a91d2f28 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.channels.md @@ -1,3 +1,11 @@ +--- +title: channels +description: API reference for qiskit.pulse.channels +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.channels +--- + # qiskit.pulse.channels @@ -23,3 +31,4 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s | `PulseChannel`(index) | Base class of transmit Channels. | | `RegisterSlot`(index) | Classical resister slot channels represent classical registers (low-latency classical memory). | | `SnapshotChannel`(\*args, \*\*kwargs) | Snapshot channels are used to specify instructions for simulators. | + diff --git a/docs/api/qiskit/0.29/qiskit.pulse.instructions.md b/docs/api/qiskit/0.29/qiskit.pulse.instructions.md index 5bcc0b989ac..6349cf5c240 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.instructions.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.instructions.md @@ -1,3 +1,11 @@ +--- +title: instructions +description: API reference for qiskit.pulse.instructions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.instructions +--- + # qiskit.pulse.instructions @@ -35,3 +43,4 @@ An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.puls | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`Instruction`](qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | + diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.29/qiskit.pulse.library.discrete.md index 5a40895f62a..6114c5986cb 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.discrete.md @@ -1,3 +1,11 @@ +--- +title: discrete +description: API reference for qiskit.pulse.library.discrete +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library.discrete +--- + # qiskit.pulse.library.discrete @@ -23,3 +31,4 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. | `square`(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | | `triangle`(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | | `zero`(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | + diff --git a/docs/api/qiskit/0.29/qiskit.pulse.library.md b/docs/api/qiskit/0.29/qiskit.pulse.library.md index 484c25b067f..66ef0e3edce 100644 --- a/docs/api/qiskit/0.29/qiskit.pulse.library.md +++ b/docs/api/qiskit/0.29/qiskit.pulse.library.md @@ -1,3 +1,11 @@ +--- +title: library +description: API reference for qiskit.pulse.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library +--- + # qiskit.pulse.library @@ -18,3 +26,4 @@ The parametric pulses, [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse. | [`Drag`](qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | | [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | | [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma\[, …]) | A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio | + diff --git a/docs/api/qiskit/0.29/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.29/qiskit.scheduler.methods.basic.md index a608dbeaf19..9761d8632a5 100644 --- a/docs/api/qiskit/0.29/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.29/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.29/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.29/qiskit.scheduler.schedule_circuit.md index c4adddcabfa..4253a0b99b8 100644 --- a/docs/api/qiskit/0.29/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.29/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | --------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, …]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.30/_toc.json b/docs/api/qiskit/0.30/_toc.json index d36b269c7bf..c21fbc28eeb 100644 --- a/docs/api/qiskit/0.30/_toc.json +++ b/docs/api/qiskit/0.30/_toc.json @@ -12,10 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.30/algorithms" }, - { - "title": "ADAM", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.ADAM" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.30/qiskit.algorithms.AlgorithmError" @@ -40,34 +36,6 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.30/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.30/qiskit.algorithms.Eigensolver" @@ -76,10 +44,6 @@ "title": "EigensolverResult", "url": "/api/qiskit/0.30/qiskit.algorithms.EigensolverResult" }, - { - "title": "ESCH", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.ESCH" - }, { "title": "EstimationProblem", "url": "/api/qiskit/0.30/qiskit.algorithms.EstimationProblem" @@ -92,10 +56,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.30/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.GradientDescent" - }, { "title": "Grover", "url": "/api/qiskit/0.30/qiskit.algorithms.Grover" @@ -104,10 +64,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.30/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.30/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -120,14 +76,6 @@ "title": "HHL", "url": "/api/qiskit/0.30/qiskit.algorithms.HHL" }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.30/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -140,10 +88,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.30/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.L_BFGS_B" - }, { "title": "LinearSolver", "url": "/api/qiskit/0.30/qiskit.algorithms.LinearSolver" @@ -168,14 +112,6 @@ "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.30/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.30/qiskit.algorithms.NumPyEigensolver" @@ -188,18 +124,6 @@ "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.30/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.P_BFGS" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.30/qiskit.algorithms.PhaseEstimation" @@ -212,22 +136,10 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.30/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.POWELL" - }, { "title": "QAOA", "url": "/api/qiskit/0.30/qiskit.algorithms.QAOA" }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.QNSPSA" - }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "Shor", "url": "/api/qiskit/0.30/qiskit.algorithms.Shor" @@ -236,25 +148,126 @@ "title": "ShorResult", "url": "/api/qiskit/0.30/qiskit.algorithms.ShorResult" }, - { - "title": "SLSQP", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "TNC", - "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.TNC" - }, { "title": "VQE", "url": "/api/qiskit/0.30/qiskit.algorithms.VQE" + }, + { + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "qiskit.algorithms.optimizers.nlopts", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.nlopts" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.30/qiskit.algorithms.optimizers.TNC" + } + ] } ] }, @@ -1743,38 +1756,6 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.30/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.30/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.30/qiskit.circuit.library.Barrier" - }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CCXGate" - }, - { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CDKMRippleCarryAdder" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.30/qiskit.circuit.ClassicalRegister" @@ -1783,226 +1764,22 @@ "title": "Clbit", "url": "/api/qiskit/0.30/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_8_3" - }, { "title": "ControlledGate", "url": "/api/qiskit/0.30/qiskit.circuit.ControlledGate" }, - { - "title": "CPhaseGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CSwapGate" - }, - { - "title": "CSXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CSXGate" - }, - { - "title": "CU1Gate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CU1Gate" - }, - { - "title": "CU3Gate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CU3Gate" - }, - { - "title": "CUGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CUGate" - }, - { - "title": "CXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CXGate" - }, - { - "title": "CYGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CYGate" - }, - { - "title": "CZGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.CZGate" - }, - { - "title": "DCXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.DCXGate" - }, { "title": "Delay", "url": "/api/qiskit/0.30/qiskit.circuit.Delay" }, - { - "title": "Diagonal", - "url": "/api/qiskit/0.30/qiskit.circuit.library.Diagonal" - }, - { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.30/qiskit.circuit.library.DraperQFTAdder" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.EfficientSU2" - }, { "title": "EquivalenceLibrary", "url": "/api/qiskit/0.30/qiskit.circuit.EquivalenceLibrary" }, - { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.30/qiskit.circuit.library.EvolvedOperatorAnsatz" - }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.30/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.30/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.30/qiskit.circuit.library.FunctionalPauliRotations" - }, { "title": "Gate", "url": "/api/qiskit/0.30/qiskit.circuit.Gate" }, - { - "title": "GMS", - "url": "/api/qiskit/0.30/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.30/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.30/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.30/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.30/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.30/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.30/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.30/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.30/qiskit.circuit.library.HRSCumulativeMultiplier" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.30/qiskit.circuit.library.InnerProduct" - }, { "title": "Instruction", "url": "/api/qiskit/0.30/qiskit.circuit.Instruction" @@ -2012,547 +1789,792 @@ "url": "/api/qiskit/0.30/qiskit.circuit.InstructionSet" }, { - "title": "IntegerComparator", - "url": "/api/qiskit/0.30/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.30/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.30/qiskit.circuit.library.LinearAmplitudeFunction" + "title": "Measure", + "url": "/api/qiskit/0.30/qiskit.circuit.Measure" }, { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.30/qiskit.circuit.library.LinearPauliRotations" + "title": "Parameter", + "url": "/api/qiskit/0.30/qiskit.circuit.Parameter" }, { - "title": "LogNormalDistribution", - "url": "/api/qiskit/0.30/qiskit.circuit.library.LogNormalDistribution" + "title": "ParameterExpression", + "url": "/api/qiskit/0.30/qiskit.circuit.ParameterExpression" }, { - "title": "MCMT", - "url": "/api/qiskit/0.30/qiskit.circuit.library.MCMT" + "title": "ParameterVector", + "url": "/api/qiskit/0.30/qiskit.circuit.ParameterVector" }, { - "title": "MCMTVChain", - "url": "/api/qiskit/0.30/qiskit.circuit.library.MCMTVChain" + "title": "QuantumCircuit", + "url": "/api/qiskit/0.30/qiskit.circuit.QuantumCircuit" }, { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.MCPhaseGate" + "title": "QuantumRegister", + "url": "/api/qiskit/0.30/qiskit.circuit.QuantumRegister" }, { - "title": "MCXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.MCXGate" + "title": "Qubit", + "url": "/api/qiskit/0.30/qiskit.circuit.Qubit" }, { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.30/qiskit.circuit.library.MCXGrayCode" + "title": "random_circuit", + "url": "/api/qiskit/0.30/qiskit.circuit.random.random_circuit" }, { - "title": "MCXRecursive", - "url": "/api/qiskit/0.30/qiskit.circuit.library.MCXRecursive" + "title": "Reset", + "url": "/api/qiskit/0.30/qiskit.circuit.Reset" }, { - "title": "MCXVChain", - "url": "/api/qiskit/0.30/qiskit.circuit.library.MCXVChain" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.30/qiskit.circuit.Measure" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.30/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.30/qiskit.circuit.library.NLocal" - }, - { - "title": "NormalDistribution", - "url": "/api/qiskit/0.30/qiskit.circuit.library.NormalDistribution" - }, - { - "title": "OR", - "url": "/api/qiskit/0.30/qiskit.circuit.library.OR" - }, - { - "title": "Parameter", - "url": "/api/qiskit/0.30/qiskit.circuit.Parameter" - }, - { - "title": "ParameterExpression", - "url": "/api/qiskit/0.30/qiskit.circuit.ParameterExpression" - }, - { - "title": "ParameterVector", - "url": "/api/qiskit/0.30/qiskit.circuit.ParameterVector" - }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.30/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.30/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.30/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.30/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.30/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.30/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.30/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.30/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.30/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.30/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.30/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.30/qiskit.circuit.library.QuadraticForm" - }, - { - "title": "QuantumCircuit", - "url": "/api/qiskit/0.30/qiskit.circuit.QuantumCircuit" - }, - { - "title": "QuantumRegister", - "url": "/api/qiskit/0.30/qiskit.circuit.QuantumRegister" - }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.30/qiskit.circuit.library.QuantumVolume" - }, - { - "title": "Qubit", - "url": "/api/qiskit/0.30/qiskit.circuit.Qubit" - }, - { - "title": "random_circuit", - "url": "/api/qiskit/0.30/qiskit.circuit.random.random_circuit" - }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RealAmplitudes" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.30/qiskit.circuit.Reset" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.30/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.SGate" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.30/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.UGate" - }, - { - "title": "UniformDistribution", - "url": "/api/qiskit/0.30/qiskit.circuit.library.UniformDistribution" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.30/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.30/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.30/qiskit.circuit.library.XOR" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.30/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.30/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.30/qiskit.circuit.library.ZZFeatureMap" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.30/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.30/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.30/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.30/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.30/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.30/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.30/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.30/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.30/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.30/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.30/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.30/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.30/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.30/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.30/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.30/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.30/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.30/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.30/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.30/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.30/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.30/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.30/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.30/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.30/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.30/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "LogNormalDistribution", + "url": "/api/qiskit/0.30/qiskit.circuit.library.LogNormalDistribution" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.30/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.30/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.30/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.30/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.30/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.30/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.30/qiskit.circuit.library.NLocal" + }, + { + "title": "NormalDistribution", + "url": "/api/qiskit/0.30/qiskit.circuit.library.NormalDistribution" + }, + { + "title": "OR", + "url": "/api/qiskit/0.30/qiskit.circuit.library.OR" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.30/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.30/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.30/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.30/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.30/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.30/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.30/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.30/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.30/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.30/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.30/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.30/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.30/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.30/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_cy" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.30/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "rzx_xz", + "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_xz" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "rzx_yz", + "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_yz" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "rzx_zz1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_zz1" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.30/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "rzx_zz2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.30/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.SGate" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.30/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.30/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.U2Gate" + }, + { + "title": "U3Gate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.U3Gate" + }, + { + "title": "UGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.UGate" + }, + { + "title": "UniformDistribution", + "url": "/api/qiskit/0.30/qiskit.circuit.library.UniformDistribution" + }, + { + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.30/qiskit.circuit.library.VBERippleCarryAdder" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.30/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.30/qiskit.circuit.library.XOR" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.30/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.30/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.30/qiskit.circuit.library.ZZFeatureMap" } ] }, @@ -2723,7 +2745,20 @@ }, { "title": "qiskit.finance.applications.ising", - "url": "/api/qiskit/0.30/qiskit.finance.applications.ising" + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.finance.applications.ising" + }, + { + "title": "qiskit.finance.applications.ising.portfolio", + "url": "/api/qiskit/0.30/qiskit.finance.applications.ising.portfolio" + }, + { + "title": "qiskit.finance.applications.ising.portfolio_diversification", + "url": "/api/qiskit/0.30/qiskit.finance.applications.ising.portfolio_diversification" + } + ] } ] }, @@ -3158,6 +3193,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.30/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.30/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.30/qiskit.ignis.verification.QOTP" @@ -3276,225 +3315,288 @@ "title": "Overview", "url": "/api/qiskit/0.30/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.30/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.30/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.30/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.30/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.30/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.30/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.30/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.30/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.30/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.30/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.30/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.30/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.30/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.30/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.30/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.30/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.30/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.30/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.30/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.30/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.30/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.30/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.30/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.30/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.30/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.30/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.30/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.30/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.30/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.30/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.30/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.30/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.30/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.30/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.30/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.30/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.30/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.30/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.30/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.30/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.30/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.30/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.30/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.30/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.30/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.30/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.30/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.30/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.30/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.30/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.30/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.30/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.30/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.30/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.30/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.30/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.30/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3611,7 +3713,64 @@ }, { "title": "qiskit.optimization.applications.ising", - "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising" + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising" + }, + { + "title": "qiskit.optimization.applications.ising.clique", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.clique" + }, + { + "title": "qiskit.optimization.applications.ising.common", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.common" + }, + { + "title": "qiskit.optimization.applications.ising.docplex", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.docplex" + }, + { + "title": "qiskit.optimization.applications.ising.exact_cover", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.exact_cover" + }, + { + "title": "qiskit.optimization.applications.ising.graph_partition", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.graph_partition" + }, + { + "title": "qiskit.optimization.applications.ising.knapsack", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.knapsack" + }, + { + "title": "qiskit.optimization.applications.ising.max_cut", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.max_cut" + }, + { + "title": "qiskit.optimization.applications.ising.partition", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.partition" + }, + { + "title": "qiskit.optimization.applications.ising.set_packing", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.set_packing" + }, + { + "title": "qiskit.optimization.applications.ising.stable_set", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.stable_set" + }, + { + "title": "qiskit.optimization.applications.ising.tsp", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.tsp" + }, + { + "title": "qiskit.optimization.applications.ising.vehicle_routing", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.vehicle_routing" + }, + { + "title": "qiskit.optimization.applications.ising.vertex_cover", + "url": "/api/qiskit/0.30/qiskit.optimization.applications.ising.vertex_cover" + } + ] } ] }, @@ -4572,10 +4731,6 @@ "title": "acquire", "url": "/api/qiskit/0.30/qiskit.pulse.builder.acquire" }, - { - "title": "Acquire", - "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Acquire" - }, { "title": "acquire_channel", "url": "/api/qiskit/0.30/qiskit.pulse.builder.acquire_channel" @@ -4640,10 +4795,6 @@ "title": "call", "url": "/api/qiskit/0.30/qiskit.pulse.builder.call" }, - { - "title": "Call", - "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Call" - }, { "title": "circuit_scheduler_settings", "url": "/api/qiskit/0.30/qiskit.pulse.builder.circuit_scheduler_settings" @@ -4652,10 +4803,6 @@ "title": "Constant", "url": "/api/qiskit/0.30/qiskit.pulse.Constant" }, - { - "title": "Constant", - "url": "/api/qiskit/0.30/qiskit.pulse.library.Constant" - }, { "title": "control_channels", "url": "/api/qiskit/0.30/qiskit.pulse.builder.control_channels" @@ -4676,10 +4823,6 @@ "title": "delay", "url": "/api/qiskit/0.30/qiskit.pulse.builder.delay" }, - { - "title": "Delay", - "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Delay" - }, { "title": "delay_qubits", "url": "/api/qiskit/0.30/qiskit.pulse.builder.delay_qubits" @@ -4688,10 +4831,6 @@ "title": "Drag", "url": "/api/qiskit/0.30/qiskit.pulse.Drag" }, - { - "title": "Drag", - "url": "/api/qiskit/0.30/qiskit.pulse.library.Drag" - }, { "title": "drive_channel", "url": "/api/qiskit/0.30/qiskit.pulse.builder.drive_channel" @@ -4708,18 +4847,10 @@ "title": "Gaussian", "url": "/api/qiskit/0.30/qiskit.pulse.Gaussian" }, - { - "title": "Gaussian", - "url": "/api/qiskit/0.30/qiskit.pulse.library.Gaussian" - }, { "title": "GaussianSquare", "url": "/api/qiskit/0.30/qiskit.pulse.GaussianSquare" }, - { - "title": "GaussianSquare", - "url": "/api/qiskit/0.30/qiskit.pulse.library.GaussianSquare" - }, { "title": "inline", "url": "/api/qiskit/0.30/qiskit.pulse.builder.inline" @@ -4728,10 +4859,6 @@ "title": "Instruction", "url": "/api/qiskit/0.30/qiskit.pulse.Instruction" }, - { - "title": "Instruction", - "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Instruction" - }, { "title": "InstructionScheduleMap", "url": "/api/qiskit/0.30/qiskit.pulse.InstructionScheduleMap" @@ -4780,14 +4907,14 @@ "title": "play", "url": "/api/qiskit/0.30/qiskit.pulse.builder.play" }, - { - "title": "Play", - "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Play" - }, { "title": "PulseError", "url": "/api/qiskit/0.30/qiskit.pulse.PulseError" }, + { + "title": "qiskit.pulse.channels", + "url": "/api/qiskit/0.30/qiskit.pulse.channels" + }, { "title": "qubit_channels", "url": "/api/qiskit/0.30/qiskit.pulse.builder.qubit_channels" @@ -4824,18 +4951,10 @@ "title": "SetFrequency", "url": "/api/qiskit/0.30/qiskit.pulse.SetFrequency" }, - { - "title": "SetFrequency", - "url": "/api/qiskit/0.30/qiskit.pulse.instructions.SetFrequency" - }, { "title": "SetPhase", "url": "/api/qiskit/0.30/qiskit.pulse.SetPhase" }, - { - "title": "SetPhase", - "url": "/api/qiskit/0.30/qiskit.pulse.instructions.SetPhase" - }, { "title": "shift_frequency", "url": "/api/qiskit/0.30/qiskit.pulse.builder.shift_frequency" @@ -4848,18 +4967,10 @@ "title": "ShiftFrequency", "url": "/api/qiskit/0.30/qiskit.pulse.ShiftFrequency" }, - { - "title": "ShiftFrequency", - "url": "/api/qiskit/0.30/qiskit.pulse.instructions.ShiftFrequency" - }, { "title": "ShiftPhase", "url": "/api/qiskit/0.30/qiskit.pulse.ShiftPhase" }, - { - "title": "ShiftPhase", - "url": "/api/qiskit/0.30/qiskit.pulse.instructions.ShiftPhase" - }, { "title": "Snapshot", "url": "/api/qiskit/0.30/qiskit.pulse.Snapshot" @@ -4868,10 +4979,6 @@ "title": "snapshot", "url": "/api/qiskit/0.30/qiskit.pulse.builder.snapshot" }, - { - "title": "Snapshot", - "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Snapshot" - }, { "title": "transpiler_settings", "url": "/api/qiskit/0.30/qiskit.pulse.builder.transpiler_settings" @@ -4892,13 +4999,91 @@ "title": "Waveform", "url": "/api/qiskit/0.30/qiskit.pulse.Waveform" }, - { - "title": "Waveform", - "url": "/api/qiskit/0.30/qiskit.pulse.library.Waveform" - }, { "title": "x", "url": "/api/qiskit/0.30/qiskit.pulse.builder.x" + }, + { + "title": "qiskit.pulse.instructions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.pulse.instructions" + }, + { + "title": "Acquire", + "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Acquire" + }, + { + "title": "Call", + "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Call" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Delay" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Instruction" + }, + { + "title": "Play", + "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Play" + }, + { + "title": "SetFrequency", + "url": "/api/qiskit/0.30/qiskit.pulse.instructions.SetFrequency" + }, + { + "title": "SetPhase", + "url": "/api/qiskit/0.30/qiskit.pulse.instructions.SetPhase" + }, + { + "title": "ShiftFrequency", + "url": "/api/qiskit/0.30/qiskit.pulse.instructions.ShiftFrequency" + }, + { + "title": "ShiftPhase", + "url": "/api/qiskit/0.30/qiskit.pulse.instructions.ShiftPhase" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.30/qiskit.pulse.instructions.Snapshot" + } + ] + }, + { + "title": "qiskit.pulse.library", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.30/qiskit.pulse.library" + }, + { + "title": "Constant", + "url": "/api/qiskit/0.30/qiskit.pulse.library.Constant" + }, + { + "title": "Drag", + "url": "/api/qiskit/0.30/qiskit.pulse.library.Drag" + }, + { + "title": "Gaussian", + "url": "/api/qiskit/0.30/qiskit.pulse.library.Gaussian" + }, + { + "title": "GaussianSquare", + "url": "/api/qiskit/0.30/qiskit.pulse.library.GaussianSquare" + }, + { + "title": "qiskit.pulse.library.discrete", + "url": "/api/qiskit/0.30/qiskit.pulse.library.discrete" + }, + { + "title": "Waveform", + "url": "/api/qiskit/0.30/qiskit.pulse.library.Waveform" + } + ] } ] }, @@ -5249,6 +5434,14 @@ "title": "Overview", "url": "/api/qiskit/0.30/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.30/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.30/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.30/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.30/circuit_library.md b/docs/api/qiskit/0.30/circuit_library.md index 5690a237078..d38da990492 100644 --- a/docs/api/qiskit/0.30/circuit_library.md +++ b/docs/api/qiskit/0.30/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -277,3 +289,4 @@ | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.md index 189091514ea..9aef02e1505 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -67,3 +79,4 @@ The global optimizers are as follows: | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.nlopts.md b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.nlopts.md index f7fb470a11e..b430ce1d9d8 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.nlopts.md +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.nlopts.md @@ -1,3 +1,11 @@ +--- +title: nlopts +description: API reference for qiskit.algorithms.optimizers.nlopts +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.nlopts +--- + # qiskit.algorithms.optimizers.nlopts @@ -26,3 +34,4 @@ export PYTHONPATH=/usr/local/lib/python3.6/site-packages:${PYTHONPATH} ``` The two `export` commands above can be pasted into the `.bash_profile` file in the user’s home directory for automatic execution. Now you can run Qiskit and these optimizers should be available for you to use. + diff --git a/docs/api/qiskit/0.30/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.30/qiskit.finance.applications.ising.portfolio.md index b0a1fd4ce14..d8ff1c47f32 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.30/qiskit.finance.applications.ising.portfolio.md @@ -1,3 +1,11 @@ +--- +title: portfolio +description: API reference for qiskit.finance.applications.ising.portfolio +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio +--- + # qiskit.finance.applications.ising.portfolio @@ -13,3 +21,4 @@ Convert portfolio optimization instances into Pauli list | `portfolio_value`(x, mu, sigma, q, budget, penalty) | returns portfolio value | | `portfolio_variance`(x, sigma) | returns portfolio variance | | `random_model`(n\[, seed]) | Generate random model (mu, sigma) for portfolio optimization problem. | + diff --git a/docs/api/qiskit/0.30/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.30/qiskit.finance.applications.ising.portfolio_diversification.md index d9bfae4b1fd..34bcd93172d 100644 --- a/docs/api/qiskit/0.30/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.30/qiskit.finance.applications.ising.portfolio_diversification.md @@ -1,3 +1,11 @@ +--- +title: portfolio_diversification +description: API reference for qiskit.finance.applications.ising.portfolio_diversification +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio_diversification +--- + # qiskit.finance.applications.ising.portfolio\_diversification @@ -11,3 +19,4 @@ portfolio diversification | `get_operator`(rho, n, q) | Converts an instance of portfolio optimization into a list of Paulis. | | `get_portfoliodiversification_solution`(rho, …) | Tries to obtain a feasible solution (in vector form) of an instance of portfolio diversification from the results dictionary. | | `get_portfoliodiversification_value`(rho, n, …) | Evaluates an objective function of an instance of portfolio diversification and its solution (in vector form). | + diff --git a/docs/api/qiskit/0.30/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.30/qiskit.ignis.verification.basis.md index e26610b6708..c7c0137e9f8 100644 --- a/docs/api/qiskit/0.30/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.30/qiskit.ignis.verification.basis.md @@ -1,5 +1,14 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # qiskit.ignis.verification.basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.30/qiskit.opflow.converters.md b/docs/api/qiskit/0.30/qiskit.opflow.converters.md index de1cf2608c0..dd5860cb4b8 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, …]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, …]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.md index c1fbc4558e7..35e46f5058d 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.30/qiskit.opflow.expectations.md b/docs/api/qiskit/0.30/qiskit.opflow.expectations.md index 5f7f2c40cb7..9c99521085d 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.30/qiskit.opflow.gradients.md b/docs/api/qiskit/0.30/qiskit.opflow.gradients.md index d47fd11d45b..d19fdc725a5 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, …]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.md index e4108d55522..5593a1b809a 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](qiskit.aqua.operators.list_ops#module-qiskit.aqua.operators.list_ops "qiskit.aqua.operators.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.md index 9b8d4929b0c..c1f8f35ade4 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.md index be5505d8a1f..ada961c9425 100644 --- a/docs/api/qiskit/0.30/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.30/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, …]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, …]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.clique.md index 2e4cee68850..1abbbaf85c3 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.clique.md @@ -1,3 +1,11 @@ +--- +title: clique +description: API reference for qiskit.optimization.applications.ising.clique +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.clique +--- + # qiskit.optimization.applications.ising.clique @@ -13,3 +21,4 @@ Deal with Gset format. See [https://web.stanford.edu/\~yyye/yyye/Gset/](https:// | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix, K) | Generate Hamiltonian for the clique. | | `satisfy_or_not`(x, w, K) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.common.md index 60923757fc4..26464086f88 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.common.md @@ -1,3 +1,11 @@ +--- +title: common +description: API reference for qiskit.optimization.applications.ising.common +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.common +--- + # qiskit.optimization.applications.ising.common @@ -14,3 +22,4 @@ common module | `random_number_list`(n\[, weight\_range, …]) | Generate a set of positive integers within the given range. | | `read_numbers_from_file`(filename) | Read numbers from a file | | `sample_most_likely`(state\_vector) | Compute the most likely binary string from state vector. | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.docplex.md index 8a8fff9aa95..944b3c91d9b 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.docplex.md @@ -1,3 +1,11 @@ +--- +title: docplex +description: API reference for qiskit.optimization.applications.ising.docplex +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.docplex +--- + # qiskit.optimization.applications.ising.docplex @@ -49,3 +57,4 @@ print('tsp objective:', result['energy'] + offset) | | | | ---------------------------------------- | --------------------------------------------------- | | `get_operator`(mdl\[, auto\_penalty, …]) | Generate Ising Hamiltonian from a model of DOcplex. | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.exact_cover.md index 4bbd8e4a464..5b6dde4bf45 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.exact_cover.md @@ -1,3 +1,11 @@ +--- +title: exact_cover +description: API reference for qiskit.optimization.applications.ising.exact_cover +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.exact_cover +--- + # qiskit.optimization.applications.ising.exact\_cover @@ -11,3 +19,4 @@ exact cover | `check_solution_satisfiability`(sol, …) | check solution satisfiability | | `get_operator`(list\_of\_subsets) | Construct the Hamiltonian for the exact solver problem. | | `get_solution`(x) | **param x**binary string as numpy array. | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.graph_partition.md index 9249f6a3fae..8236aeed15a 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.graph_partition.md @@ -1,3 +1,11 @@ +--- +title: graph_partition +description: API reference for qiskit.optimization.applications.ising.graph_partition +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.graph_partition +--- + # qiskit.optimization.applications.ising.graph\_partition @@ -11,3 +19,4 @@ Convert graph partitioning instances into Pauli list Deal with Gset format. See | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the graph partitioning | | `objective_value`(x, w) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.knapsack.md index e9f34622a28..da979a64833 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.knapsack.md @@ -1,3 +1,11 @@ +--- +title: knapsack +description: API reference for qiskit.optimization.applications.ising.knapsack +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.knapsack +--- + # qiskit.optimization.applications.ising.knapsack @@ -15,3 +23,4 @@ If we have the weights w\[i], the values v\[i] and the maximum weight W\_max. We | `get_operator`(values, weights, max\_weight) | Generate Hamiltonian for the knapsack problem. | | `get_solution`(x, values) | Get the solution to the knapsack problem from the bitstring that represents to the ground state of the Hamiltonian | | `knapsack_value_weight`(solution, values, weights) | Get the total wight and value of the items taken in the knapsack. | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.max_cut.md index 5ff110e890e..44417cf9629 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.max_cut.md @@ -1,3 +1,11 @@ +--- +title: max_cut +description: API reference for qiskit.optimization.applications.ising.max_cut +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.max_cut +--- + # qiskit.optimization.applications.ising.max\_cut @@ -11,3 +19,4 @@ Convert max-cut instances into Pauli list Deal with Gset format. See [https://we | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the max-cut problem of a graph. | | `max_cut_value`(x, w) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.partition.md index d7d2956ba87..d09b7f6bf41 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.partition.md @@ -1,3 +1,11 @@ +--- +title: partition +description: API reference for qiskit.optimization.applications.ising.partition +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.partition +--- + # qiskit.optimization.applications.ising.partition @@ -10,3 +18,4 @@ Generate Number Partitioning (Partition) instances, and convert them into a Hami | ---------------------------------- | --------------------------------------------------------- | | `get_operator`(values) | Construct the Hamiltonian for a given Partition instance. | | `partition_value`(x, number\_list) | Compute the value of a partition. | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.set_packing.md index e285f22c000..7e956256324 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.set_packing.md @@ -1,3 +1,11 @@ +--- +title: set_packing +description: API reference for qiskit.optimization.applications.ising.set_packing +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.set_packing +--- + # qiskit.optimization.applications.ising.set\_packing @@ -11,3 +19,4 @@ set packing module | `check_disjoint`(sol, list\_of\_subsets) | check disjoint | | `get_operator`(list\_of\_subsets) | Construct the Hamiltonian for the set packing. | | `get_solution`(x) | **param x**binary string as numpy array. | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.stable_set.md index ad51e1a564f..947b8706017 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.stable_set.md @@ -1,3 +1,11 @@ +--- +title: stable_set +description: API reference for qiskit.optimization.applications.ising.stable_set +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.stable_set +--- + # qiskit.optimization.applications.ising.stable\_set @@ -11,3 +19,4 @@ Convert stable set instances into Pauli list. We read instances in the Gset form | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(w) | Generate Hamiltonian for the maximum stable set in a graph. | | `stable_set_value`(x, w) | Compute the value of a stable set, and its feasibility. | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.tsp.md index 139fd94208f..7667c627129 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.tsp.md @@ -1,3 +1,11 @@ +--- +title: tsp +description: API reference for qiskit.optimization.applications.ising.tsp +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.tsp +--- + # qiskit.optimization.applications.ising.tsp @@ -21,3 +29,4 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp | | | | ------------------------------ | --------------------------------------------------- | | `TspData`(name, dim, coord, w) | Create new instance of TspData(name, dim, coord, w) | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.vehicle_routing.md index 59ce2163183..a9608a20790 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.vehicle_routing.md @@ -1,3 +1,11 @@ +--- +title: vehicle_routing +description: API reference for qiskit.optimization.applications.ising.vehicle_routing +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vehicle_routing +--- + # qiskit.optimization.applications.ising.vehicle\_routing @@ -12,3 +20,4 @@ Converts vehicle routing instances into a list of Paulis, and provides some rela | `get_vehiclerouting_cost`(instance, n, K, x\_sol) | Computes the cost of a solution to an instance of a vehicle routing problem. | | `get_vehiclerouting_matrices`(instance, n, K) | Constructs auxiliary matrices from a vehicle routing instance, | | `get_vehiclerouting_solution`(instance, n, K, …) | Tries to obtain a feasible solution (in vector form) of an instance | + diff --git a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.vertex_cover.md index 2ad3728e28b..c55648d7d3d 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.30/qiskit.optimization.applications.ising.vertex_cover.md @@ -1,3 +1,11 @@ +--- +title: vertex_cover +description: API reference for qiskit.optimization.applications.ising.vertex_cover +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vertex_cover +--- + # qiskit.optimization.applications.ising.vertex\_cover @@ -11,3 +19,4 @@ Convert vertex cover instances into Pauli list Deal with Gset format. See [https | `check_full_edge_coverage`(x, w) | **param x**binary string as numpy array. | | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the vertex cover :param weight\_matrix: adjacency matrix. | + diff --git a/docs/api/qiskit/0.30/qiskit.pulse.channels.md b/docs/api/qiskit/0.30/qiskit.pulse.channels.md index 0335b26e49e..6f6a91d2f28 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.channels.md @@ -1,3 +1,11 @@ +--- +title: channels +description: API reference for qiskit.pulse.channels +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.channels +--- + # qiskit.pulse.channels @@ -23,3 +31,4 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s | `PulseChannel`(index) | Base class of transmit Channels. | | `RegisterSlot`(index) | Classical resister slot channels represent classical registers (low-latency classical memory). | | `SnapshotChannel`(\*args, \*\*kwargs) | Snapshot channels are used to specify instructions for simulators. | + diff --git a/docs/api/qiskit/0.30/qiskit.pulse.instructions.md b/docs/api/qiskit/0.30/qiskit.pulse.instructions.md index 5bcc0b989ac..6349cf5c240 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.instructions.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.instructions.md @@ -1,3 +1,11 @@ +--- +title: instructions +description: API reference for qiskit.pulse.instructions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.instructions +--- + # qiskit.pulse.instructions @@ -35,3 +43,4 @@ An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.puls | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`Instruction`](qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | + diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.30/qiskit.pulse.library.discrete.md index 5a40895f62a..6114c5986cb 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.discrete.md @@ -1,3 +1,11 @@ +--- +title: discrete +description: API reference for qiskit.pulse.library.discrete +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library.discrete +--- + # qiskit.pulse.library.discrete @@ -23,3 +31,4 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. | `square`(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | | `triangle`(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | | `zero`(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | + diff --git a/docs/api/qiskit/0.30/qiskit.pulse.library.md b/docs/api/qiskit/0.30/qiskit.pulse.library.md index 484c25b067f..66ef0e3edce 100644 --- a/docs/api/qiskit/0.30/qiskit.pulse.library.md +++ b/docs/api/qiskit/0.30/qiskit.pulse.library.md @@ -1,3 +1,11 @@ +--- +title: library +description: API reference for qiskit.pulse.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library +--- + # qiskit.pulse.library @@ -18,3 +26,4 @@ The parametric pulses, [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse. | [`Drag`](qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | | [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | | [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma\[, …]) | A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio | + diff --git a/docs/api/qiskit/0.30/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.30/qiskit.scheduler.methods.basic.md index a608dbeaf19..9761d8632a5 100644 --- a/docs/api/qiskit/0.30/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.30/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.30/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.30/qiskit.scheduler.schedule_circuit.md index c4adddcabfa..4253a0b99b8 100644 --- a/docs/api/qiskit/0.30/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.30/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | --------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, …]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.31/_toc.json b/docs/api/qiskit/0.31/_toc.json index e59e7e19f63..51c34518201 100644 --- a/docs/api/qiskit/0.31/_toc.json +++ b/docs/api/qiskit/0.31/_toc.json @@ -12,10 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.31/algorithms" }, - { - "title": "ADAM", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.ADAM" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.31/qiskit.algorithms.AlgorithmError" @@ -40,34 +36,6 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.31/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.31/qiskit.algorithms.Eigensolver" @@ -76,10 +44,6 @@ "title": "EigensolverResult", "url": "/api/qiskit/0.31/qiskit.algorithms.EigensolverResult" }, - { - "title": "ESCH", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.ESCH" - }, { "title": "EstimationProblem", "url": "/api/qiskit/0.31/qiskit.algorithms.EstimationProblem" @@ -92,10 +56,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.31/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.GradientDescent" - }, { "title": "Grover", "url": "/api/qiskit/0.31/qiskit.algorithms.Grover" @@ -104,10 +64,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.31/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.31/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -120,14 +76,6 @@ "title": "HHL", "url": "/api/qiskit/0.31/qiskit.algorithms.HHL" }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.31/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -140,10 +88,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.31/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.L_BFGS_B" - }, { "title": "LinearSolver", "url": "/api/qiskit/0.31/qiskit.algorithms.LinearSolver" @@ -168,14 +112,6 @@ "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.31/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.31/qiskit.algorithms.NumPyEigensolver" @@ -188,18 +124,6 @@ "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.31/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.P_BFGS" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.31/qiskit.algorithms.PhaseEstimation" @@ -212,22 +136,10 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.31/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.POWELL" - }, { "title": "QAOA", "url": "/api/qiskit/0.31/qiskit.algorithms.QAOA" }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.QNSPSA" - }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "Shor", "url": "/api/qiskit/0.31/qiskit.algorithms.Shor" @@ -236,25 +148,126 @@ "title": "ShorResult", "url": "/api/qiskit/0.31/qiskit.algorithms.ShorResult" }, - { - "title": "SLSQP", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "TNC", - "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.TNC" - }, { "title": "VQE", "url": "/api/qiskit/0.31/qiskit.algorithms.VQE" + }, + { + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "qiskit.algorithms.optimizers.nlopts", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.nlopts" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.31/qiskit.algorithms.optimizers.TNC" + } + ] } ] }, @@ -1743,38 +1756,6 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.31/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.31/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.31/qiskit.circuit.library.Barrier" - }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CCXGate" - }, - { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CDKMRippleCarryAdder" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.31/qiskit.circuit.ClassicalRegister" @@ -1783,226 +1764,22 @@ "title": "Clbit", "url": "/api/qiskit/0.31/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_8_3" - }, { "title": "ControlledGate", "url": "/api/qiskit/0.31/qiskit.circuit.ControlledGate" }, - { - "title": "CPhaseGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CSwapGate" - }, - { - "title": "CSXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CSXGate" - }, - { - "title": "CU1Gate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CU1Gate" - }, - { - "title": "CU3Gate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CU3Gate" - }, - { - "title": "CUGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CUGate" - }, - { - "title": "CXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CXGate" - }, - { - "title": "CYGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CYGate" - }, - { - "title": "CZGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.CZGate" - }, - { - "title": "DCXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.DCXGate" - }, { "title": "Delay", "url": "/api/qiskit/0.31/qiskit.circuit.Delay" }, - { - "title": "Diagonal", - "url": "/api/qiskit/0.31/qiskit.circuit.library.Diagonal" - }, - { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.31/qiskit.circuit.library.DraperQFTAdder" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.EfficientSU2" - }, { "title": "EquivalenceLibrary", "url": "/api/qiskit/0.31/qiskit.circuit.EquivalenceLibrary" }, - { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.31/qiskit.circuit.library.EvolvedOperatorAnsatz" - }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.31/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.31/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.31/qiskit.circuit.library.FunctionalPauliRotations" - }, { "title": "Gate", "url": "/api/qiskit/0.31/qiskit.circuit.Gate" }, - { - "title": "GMS", - "url": "/api/qiskit/0.31/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.31/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.31/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.31/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.31/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.31/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.31/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.31/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.31/qiskit.circuit.library.HRSCumulativeMultiplier" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.31/qiskit.circuit.library.InnerProduct" - }, { "title": "Instruction", "url": "/api/qiskit/0.31/qiskit.circuit.Instruction" @@ -2012,547 +1789,792 @@ "url": "/api/qiskit/0.31/qiskit.circuit.InstructionSet" }, { - "title": "IntegerComparator", - "url": "/api/qiskit/0.31/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.31/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.31/qiskit.circuit.library.LinearAmplitudeFunction" + "title": "Measure", + "url": "/api/qiskit/0.31/qiskit.circuit.Measure" }, { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.31/qiskit.circuit.library.LinearPauliRotations" + "title": "Parameter", + "url": "/api/qiskit/0.31/qiskit.circuit.Parameter" }, { - "title": "LogNormalDistribution", - "url": "/api/qiskit/0.31/qiskit.circuit.library.LogNormalDistribution" + "title": "ParameterExpression", + "url": "/api/qiskit/0.31/qiskit.circuit.ParameterExpression" }, { - "title": "MCMT", - "url": "/api/qiskit/0.31/qiskit.circuit.library.MCMT" + "title": "ParameterVector", + "url": "/api/qiskit/0.31/qiskit.circuit.ParameterVector" }, { - "title": "MCMTVChain", - "url": "/api/qiskit/0.31/qiskit.circuit.library.MCMTVChain" + "title": "QuantumCircuit", + "url": "/api/qiskit/0.31/qiskit.circuit.QuantumCircuit" }, { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.MCPhaseGate" + "title": "QuantumRegister", + "url": "/api/qiskit/0.31/qiskit.circuit.QuantumRegister" }, { - "title": "MCXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.MCXGate" + "title": "Qubit", + "url": "/api/qiskit/0.31/qiskit.circuit.Qubit" }, { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.31/qiskit.circuit.library.MCXGrayCode" + "title": "random_circuit", + "url": "/api/qiskit/0.31/qiskit.circuit.random.random_circuit" }, { - "title": "MCXRecursive", - "url": "/api/qiskit/0.31/qiskit.circuit.library.MCXRecursive" + "title": "Reset", + "url": "/api/qiskit/0.31/qiskit.circuit.Reset" }, { - "title": "MCXVChain", - "url": "/api/qiskit/0.31/qiskit.circuit.library.MCXVChain" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.31/qiskit.circuit.Measure" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.31/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.31/qiskit.circuit.library.NLocal" - }, - { - "title": "NormalDistribution", - "url": "/api/qiskit/0.31/qiskit.circuit.library.NormalDistribution" - }, - { - "title": "OR", - "url": "/api/qiskit/0.31/qiskit.circuit.library.OR" - }, - { - "title": "Parameter", - "url": "/api/qiskit/0.31/qiskit.circuit.Parameter" - }, - { - "title": "ParameterExpression", - "url": "/api/qiskit/0.31/qiskit.circuit.ParameterExpression" - }, - { - "title": "ParameterVector", - "url": "/api/qiskit/0.31/qiskit.circuit.ParameterVector" - }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.31/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.31/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.31/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.31/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.31/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.31/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.31/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.31/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.31/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.31/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.31/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.31/qiskit.circuit.library.QuadraticForm" - }, - { - "title": "QuantumCircuit", - "url": "/api/qiskit/0.31/qiskit.circuit.QuantumCircuit" - }, - { - "title": "QuantumRegister", - "url": "/api/qiskit/0.31/qiskit.circuit.QuantumRegister" - }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.31/qiskit.circuit.library.QuantumVolume" - }, - { - "title": "Qubit", - "url": "/api/qiskit/0.31/qiskit.circuit.Qubit" - }, - { - "title": "random_circuit", - "url": "/api/qiskit/0.31/qiskit.circuit.random.random_circuit" - }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RealAmplitudes" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.31/qiskit.circuit.Reset" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.31/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.SGate" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.31/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.UGate" - }, - { - "title": "UniformDistribution", - "url": "/api/qiskit/0.31/qiskit.circuit.library.UniformDistribution" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.31/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.31/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.31/qiskit.circuit.library.XOR" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.31/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.31/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.31/qiskit.circuit.library.ZZFeatureMap" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.31/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.31/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.31/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.31/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.31/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.31/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.31/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.31/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.31/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.31/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.31/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.31/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.31/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.31/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.31/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.31/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.31/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.31/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.31/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.31/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.31/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.31/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.31/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.31/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.31/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.31/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "LogNormalDistribution", + "url": "/api/qiskit/0.31/qiskit.circuit.library.LogNormalDistribution" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.31/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.31/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.31/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.31/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.31/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.31/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.31/qiskit.circuit.library.NLocal" + }, + { + "title": "NormalDistribution", + "url": "/api/qiskit/0.31/qiskit.circuit.library.NormalDistribution" + }, + { + "title": "OR", + "url": "/api/qiskit/0.31/qiskit.circuit.library.OR" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.31/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.31/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.31/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.31/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.31/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.31/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.31/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.31/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.31/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.31/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.31/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.31/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.31/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.31/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_cy" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.31/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "rzx_xz", + "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_xz" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "rzx_yz", + "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_yz" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "rzx_zz1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_zz1" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.31/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "rzx_zz2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.31/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.SGate" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.31/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.31/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.U2Gate" + }, + { + "title": "U3Gate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.U3Gate" + }, + { + "title": "UGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.UGate" + }, + { + "title": "UniformDistribution", + "url": "/api/qiskit/0.31/qiskit.circuit.library.UniformDistribution" + }, + { + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.31/qiskit.circuit.library.VBERippleCarryAdder" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.31/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.31/qiskit.circuit.library.XOR" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.31/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.31/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.31/qiskit.circuit.library.ZZFeatureMap" } ] }, @@ -2723,7 +2745,20 @@ }, { "title": "qiskit.finance.applications.ising", - "url": "/api/qiskit/0.31/qiskit.finance.applications.ising" + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.finance.applications.ising" + }, + { + "title": "qiskit.finance.applications.ising.portfolio", + "url": "/api/qiskit/0.31/qiskit.finance.applications.ising.portfolio" + }, + { + "title": "qiskit.finance.applications.ising.portfolio_diversification", + "url": "/api/qiskit/0.31/qiskit.finance.applications.ising.portfolio_diversification" + } + ] } ] }, @@ -3158,6 +3193,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.31/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.31/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.31/qiskit.ignis.verification.QOTP" @@ -3276,225 +3315,288 @@ "title": "Overview", "url": "/api/qiskit/0.31/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.31/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.31/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.31/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.31/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.31/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.31/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.31/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.31/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.31/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.31/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.31/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.31/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.31/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.31/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.31/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.31/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.31/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.31/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.31/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.31/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.31/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.31/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.31/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.31/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.31/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.31/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.31/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.31/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.31/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.31/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.31/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.31/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.31/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.31/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.31/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.31/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.31/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.31/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.31/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.31/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.31/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.31/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.31/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.31/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.31/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.31/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.31/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.31/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.31/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.31/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.31/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.31/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.31/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.31/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.31/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.31/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.31/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3611,7 +3713,64 @@ }, { "title": "qiskit.optimization.applications.ising", - "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising" + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising" + }, + { + "title": "qiskit.optimization.applications.ising.clique", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.clique" + }, + { + "title": "qiskit.optimization.applications.ising.common", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.common" + }, + { + "title": "qiskit.optimization.applications.ising.docplex", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.docplex" + }, + { + "title": "qiskit.optimization.applications.ising.exact_cover", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.exact_cover" + }, + { + "title": "qiskit.optimization.applications.ising.graph_partition", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.graph_partition" + }, + { + "title": "qiskit.optimization.applications.ising.knapsack", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.knapsack" + }, + { + "title": "qiskit.optimization.applications.ising.max_cut", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.max_cut" + }, + { + "title": "qiskit.optimization.applications.ising.partition", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.partition" + }, + { + "title": "qiskit.optimization.applications.ising.set_packing", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.set_packing" + }, + { + "title": "qiskit.optimization.applications.ising.stable_set", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.stable_set" + }, + { + "title": "qiskit.optimization.applications.ising.tsp", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.tsp" + }, + { + "title": "qiskit.optimization.applications.ising.vehicle_routing", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.vehicle_routing" + }, + { + "title": "qiskit.optimization.applications.ising.vertex_cover", + "url": "/api/qiskit/0.31/qiskit.optimization.applications.ising.vertex_cover" + } + ] } ] }, @@ -4572,10 +4731,6 @@ "title": "acquire", "url": "/api/qiskit/0.31/qiskit.pulse.builder.acquire" }, - { - "title": "Acquire", - "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Acquire" - }, { "title": "acquire_channel", "url": "/api/qiskit/0.31/qiskit.pulse.builder.acquire_channel" @@ -4640,10 +4795,6 @@ "title": "call", "url": "/api/qiskit/0.31/qiskit.pulse.builder.call" }, - { - "title": "Call", - "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Call" - }, { "title": "circuit_scheduler_settings", "url": "/api/qiskit/0.31/qiskit.pulse.builder.circuit_scheduler_settings" @@ -4652,10 +4803,6 @@ "title": "Constant", "url": "/api/qiskit/0.31/qiskit.pulse.Constant" }, - { - "title": "Constant", - "url": "/api/qiskit/0.31/qiskit.pulse.library.Constant" - }, { "title": "control_channels", "url": "/api/qiskit/0.31/qiskit.pulse.builder.control_channels" @@ -4676,10 +4823,6 @@ "title": "delay", "url": "/api/qiskit/0.31/qiskit.pulse.builder.delay" }, - { - "title": "Delay", - "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Delay" - }, { "title": "delay_qubits", "url": "/api/qiskit/0.31/qiskit.pulse.builder.delay_qubits" @@ -4688,10 +4831,6 @@ "title": "Drag", "url": "/api/qiskit/0.31/qiskit.pulse.Drag" }, - { - "title": "Drag", - "url": "/api/qiskit/0.31/qiskit.pulse.library.Drag" - }, { "title": "drive_channel", "url": "/api/qiskit/0.31/qiskit.pulse.builder.drive_channel" @@ -4708,18 +4847,10 @@ "title": "Gaussian", "url": "/api/qiskit/0.31/qiskit.pulse.Gaussian" }, - { - "title": "Gaussian", - "url": "/api/qiskit/0.31/qiskit.pulse.library.Gaussian" - }, { "title": "GaussianSquare", "url": "/api/qiskit/0.31/qiskit.pulse.GaussianSquare" }, - { - "title": "GaussianSquare", - "url": "/api/qiskit/0.31/qiskit.pulse.library.GaussianSquare" - }, { "title": "inline", "url": "/api/qiskit/0.31/qiskit.pulse.builder.inline" @@ -4728,10 +4859,6 @@ "title": "Instruction", "url": "/api/qiskit/0.31/qiskit.pulse.Instruction" }, - { - "title": "Instruction", - "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Instruction" - }, { "title": "InstructionScheduleMap", "url": "/api/qiskit/0.31/qiskit.pulse.InstructionScheduleMap" @@ -4780,14 +4907,14 @@ "title": "play", "url": "/api/qiskit/0.31/qiskit.pulse.builder.play" }, - { - "title": "Play", - "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Play" - }, { "title": "PulseError", "url": "/api/qiskit/0.31/qiskit.pulse.PulseError" }, + { + "title": "qiskit.pulse.channels", + "url": "/api/qiskit/0.31/qiskit.pulse.channels" + }, { "title": "qubit_channels", "url": "/api/qiskit/0.31/qiskit.pulse.builder.qubit_channels" @@ -4824,18 +4951,10 @@ "title": "SetFrequency", "url": "/api/qiskit/0.31/qiskit.pulse.SetFrequency" }, - { - "title": "SetFrequency", - "url": "/api/qiskit/0.31/qiskit.pulse.instructions.SetFrequency" - }, { "title": "SetPhase", "url": "/api/qiskit/0.31/qiskit.pulse.SetPhase" }, - { - "title": "SetPhase", - "url": "/api/qiskit/0.31/qiskit.pulse.instructions.SetPhase" - }, { "title": "shift_frequency", "url": "/api/qiskit/0.31/qiskit.pulse.builder.shift_frequency" @@ -4848,18 +4967,10 @@ "title": "ShiftFrequency", "url": "/api/qiskit/0.31/qiskit.pulse.ShiftFrequency" }, - { - "title": "ShiftFrequency", - "url": "/api/qiskit/0.31/qiskit.pulse.instructions.ShiftFrequency" - }, { "title": "ShiftPhase", "url": "/api/qiskit/0.31/qiskit.pulse.ShiftPhase" }, - { - "title": "ShiftPhase", - "url": "/api/qiskit/0.31/qiskit.pulse.instructions.ShiftPhase" - }, { "title": "Snapshot", "url": "/api/qiskit/0.31/qiskit.pulse.Snapshot" @@ -4868,10 +4979,6 @@ "title": "snapshot", "url": "/api/qiskit/0.31/qiskit.pulse.builder.snapshot" }, - { - "title": "Snapshot", - "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Snapshot" - }, { "title": "transpiler_settings", "url": "/api/qiskit/0.31/qiskit.pulse.builder.transpiler_settings" @@ -4892,13 +4999,91 @@ "title": "Waveform", "url": "/api/qiskit/0.31/qiskit.pulse.Waveform" }, - { - "title": "Waveform", - "url": "/api/qiskit/0.31/qiskit.pulse.library.Waveform" - }, { "title": "x", "url": "/api/qiskit/0.31/qiskit.pulse.builder.x" + }, + { + "title": "qiskit.pulse.instructions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.pulse.instructions" + }, + { + "title": "Acquire", + "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Acquire" + }, + { + "title": "Call", + "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Call" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Delay" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Instruction" + }, + { + "title": "Play", + "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Play" + }, + { + "title": "SetFrequency", + "url": "/api/qiskit/0.31/qiskit.pulse.instructions.SetFrequency" + }, + { + "title": "SetPhase", + "url": "/api/qiskit/0.31/qiskit.pulse.instructions.SetPhase" + }, + { + "title": "ShiftFrequency", + "url": "/api/qiskit/0.31/qiskit.pulse.instructions.ShiftFrequency" + }, + { + "title": "ShiftPhase", + "url": "/api/qiskit/0.31/qiskit.pulse.instructions.ShiftPhase" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.31/qiskit.pulse.instructions.Snapshot" + } + ] + }, + { + "title": "qiskit.pulse.library", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.31/qiskit.pulse.library" + }, + { + "title": "Constant", + "url": "/api/qiskit/0.31/qiskit.pulse.library.Constant" + }, + { + "title": "Drag", + "url": "/api/qiskit/0.31/qiskit.pulse.library.Drag" + }, + { + "title": "Gaussian", + "url": "/api/qiskit/0.31/qiskit.pulse.library.Gaussian" + }, + { + "title": "GaussianSquare", + "url": "/api/qiskit/0.31/qiskit.pulse.library.GaussianSquare" + }, + { + "title": "qiskit.pulse.library.discrete", + "url": "/api/qiskit/0.31/qiskit.pulse.library.discrete" + }, + { + "title": "Waveform", + "url": "/api/qiskit/0.31/qiskit.pulse.library.Waveform" + } + ] } ] }, @@ -5249,6 +5434,14 @@ "title": "Overview", "url": "/api/qiskit/0.31/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.31/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.31/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.31/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.31/circuit_library.md b/docs/api/qiskit/0.31/circuit_library.md index 5690a237078..d38da990492 100644 --- a/docs/api/qiskit/0.31/circuit_library.md +++ b/docs/api/qiskit/0.31/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -277,3 +289,4 @@ | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.md index 189091514ea..9aef02e1505 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -67,3 +79,4 @@ The global optimizers are as follows: | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.nlopts.md b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.nlopts.md index f7fb470a11e..b430ce1d9d8 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.nlopts.md +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.nlopts.md @@ -1,3 +1,11 @@ +--- +title: nlopts +description: API reference for qiskit.algorithms.optimizers.nlopts +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.nlopts +--- + # qiskit.algorithms.optimizers.nlopts @@ -26,3 +34,4 @@ export PYTHONPATH=/usr/local/lib/python3.6/site-packages:${PYTHONPATH} ``` The two `export` commands above can be pasted into the `.bash_profile` file in the user’s home directory for automatic execution. Now you can run Qiskit and these optimizers should be available for you to use. + diff --git a/docs/api/qiskit/0.31/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.31/qiskit.finance.applications.ising.portfolio.md index b0a1fd4ce14..d8ff1c47f32 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.31/qiskit.finance.applications.ising.portfolio.md @@ -1,3 +1,11 @@ +--- +title: portfolio +description: API reference for qiskit.finance.applications.ising.portfolio +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio +--- + # qiskit.finance.applications.ising.portfolio @@ -13,3 +21,4 @@ Convert portfolio optimization instances into Pauli list | `portfolio_value`(x, mu, sigma, q, budget, penalty) | returns portfolio value | | `portfolio_variance`(x, sigma) | returns portfolio variance | | `random_model`(n\[, seed]) | Generate random model (mu, sigma) for portfolio optimization problem. | + diff --git a/docs/api/qiskit/0.31/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.31/qiskit.finance.applications.ising.portfolio_diversification.md index d9bfae4b1fd..34bcd93172d 100644 --- a/docs/api/qiskit/0.31/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.31/qiskit.finance.applications.ising.portfolio_diversification.md @@ -1,3 +1,11 @@ +--- +title: portfolio_diversification +description: API reference for qiskit.finance.applications.ising.portfolio_diversification +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio_diversification +--- + # qiskit.finance.applications.ising.portfolio\_diversification @@ -11,3 +19,4 @@ portfolio diversification | `get_operator`(rho, n, q) | Converts an instance of portfolio optimization into a list of Paulis. | | `get_portfoliodiversification_solution`(rho, …) | Tries to obtain a feasible solution (in vector form) of an instance of portfolio diversification from the results dictionary. | | `get_portfoliodiversification_value`(rho, n, …) | Evaluates an objective function of an instance of portfolio diversification and its solution (in vector form). | + diff --git a/docs/api/qiskit/0.31/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.31/qiskit.ignis.verification.basis.md index e26610b6708..c7c0137e9f8 100644 --- a/docs/api/qiskit/0.31/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.31/qiskit.ignis.verification.basis.md @@ -1,5 +1,14 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # qiskit.ignis.verification.basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.31/qiskit.opflow.converters.md b/docs/api/qiskit/0.31/qiskit.opflow.converters.md index de1cf2608c0..dd5860cb4b8 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, …]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, …]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.md index c1fbc4558e7..35e46f5058d 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.31/qiskit.opflow.expectations.md b/docs/api/qiskit/0.31/qiskit.opflow.expectations.md index 5f7f2c40cb7..9c99521085d 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.31/qiskit.opflow.gradients.md b/docs/api/qiskit/0.31/qiskit.opflow.gradients.md index d47fd11d45b..d19fdc725a5 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, …]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.md index e4108d55522..5593a1b809a 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](qiskit.aqua.operators.list_ops#module-qiskit.aqua.operators.list_ops "qiskit.aqua.operators.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.md index 9b8d4929b0c..c1f8f35ade4 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.md index be5505d8a1f..ada961c9425 100644 --- a/docs/api/qiskit/0.31/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.31/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, …]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, …]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.clique.md index 2e4cee68850..1abbbaf85c3 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.clique.md @@ -1,3 +1,11 @@ +--- +title: clique +description: API reference for qiskit.optimization.applications.ising.clique +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.clique +--- + # qiskit.optimization.applications.ising.clique @@ -13,3 +21,4 @@ Deal with Gset format. See [https://web.stanford.edu/\~yyye/yyye/Gset/](https:// | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix, K) | Generate Hamiltonian for the clique. | | `satisfy_or_not`(x, w, K) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.common.md index 60923757fc4..26464086f88 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.common.md @@ -1,3 +1,11 @@ +--- +title: common +description: API reference for qiskit.optimization.applications.ising.common +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.common +--- + # qiskit.optimization.applications.ising.common @@ -14,3 +22,4 @@ common module | `random_number_list`(n\[, weight\_range, …]) | Generate a set of positive integers within the given range. | | `read_numbers_from_file`(filename) | Read numbers from a file | | `sample_most_likely`(state\_vector) | Compute the most likely binary string from state vector. | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.docplex.md index 8a8fff9aa95..944b3c91d9b 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.docplex.md @@ -1,3 +1,11 @@ +--- +title: docplex +description: API reference for qiskit.optimization.applications.ising.docplex +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.docplex +--- + # qiskit.optimization.applications.ising.docplex @@ -49,3 +57,4 @@ print('tsp objective:', result['energy'] + offset) | | | | ---------------------------------------- | --------------------------------------------------- | | `get_operator`(mdl\[, auto\_penalty, …]) | Generate Ising Hamiltonian from a model of DOcplex. | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.exact_cover.md index 4bbd8e4a464..5b6dde4bf45 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.exact_cover.md @@ -1,3 +1,11 @@ +--- +title: exact_cover +description: API reference for qiskit.optimization.applications.ising.exact_cover +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.exact_cover +--- + # qiskit.optimization.applications.ising.exact\_cover @@ -11,3 +19,4 @@ exact cover | `check_solution_satisfiability`(sol, …) | check solution satisfiability | | `get_operator`(list\_of\_subsets) | Construct the Hamiltonian for the exact solver problem. | | `get_solution`(x) | **param x**binary string as numpy array. | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.graph_partition.md index 9249f6a3fae..8236aeed15a 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.graph_partition.md @@ -1,3 +1,11 @@ +--- +title: graph_partition +description: API reference for qiskit.optimization.applications.ising.graph_partition +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.graph_partition +--- + # qiskit.optimization.applications.ising.graph\_partition @@ -11,3 +19,4 @@ Convert graph partitioning instances into Pauli list Deal with Gset format. See | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the graph partitioning | | `objective_value`(x, w) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.knapsack.md index e9f34622a28..da979a64833 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.knapsack.md @@ -1,3 +1,11 @@ +--- +title: knapsack +description: API reference for qiskit.optimization.applications.ising.knapsack +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.knapsack +--- + # qiskit.optimization.applications.ising.knapsack @@ -15,3 +23,4 @@ If we have the weights w\[i], the values v\[i] and the maximum weight W\_max. We | `get_operator`(values, weights, max\_weight) | Generate Hamiltonian for the knapsack problem. | | `get_solution`(x, values) | Get the solution to the knapsack problem from the bitstring that represents to the ground state of the Hamiltonian | | `knapsack_value_weight`(solution, values, weights) | Get the total wight and value of the items taken in the knapsack. | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.max_cut.md index 5ff110e890e..44417cf9629 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.max_cut.md @@ -1,3 +1,11 @@ +--- +title: max_cut +description: API reference for qiskit.optimization.applications.ising.max_cut +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.max_cut +--- + # qiskit.optimization.applications.ising.max\_cut @@ -11,3 +19,4 @@ Convert max-cut instances into Pauli list Deal with Gset format. See [https://we | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the max-cut problem of a graph. | | `max_cut_value`(x, w) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.partition.md index d7d2956ba87..d09b7f6bf41 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.partition.md @@ -1,3 +1,11 @@ +--- +title: partition +description: API reference for qiskit.optimization.applications.ising.partition +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.partition +--- + # qiskit.optimization.applications.ising.partition @@ -10,3 +18,4 @@ Generate Number Partitioning (Partition) instances, and convert them into a Hami | ---------------------------------- | --------------------------------------------------------- | | `get_operator`(values) | Construct the Hamiltonian for a given Partition instance. | | `partition_value`(x, number\_list) | Compute the value of a partition. | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.set_packing.md index e285f22c000..7e956256324 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.set_packing.md @@ -1,3 +1,11 @@ +--- +title: set_packing +description: API reference for qiskit.optimization.applications.ising.set_packing +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.set_packing +--- + # qiskit.optimization.applications.ising.set\_packing @@ -11,3 +19,4 @@ set packing module | `check_disjoint`(sol, list\_of\_subsets) | check disjoint | | `get_operator`(list\_of\_subsets) | Construct the Hamiltonian for the set packing. | | `get_solution`(x) | **param x**binary string as numpy array. | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.stable_set.md index ad51e1a564f..947b8706017 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.stable_set.md @@ -1,3 +1,11 @@ +--- +title: stable_set +description: API reference for qiskit.optimization.applications.ising.stable_set +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.stable_set +--- + # qiskit.optimization.applications.ising.stable\_set @@ -11,3 +19,4 @@ Convert stable set instances into Pauli list. We read instances in the Gset form | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(w) | Generate Hamiltonian for the maximum stable set in a graph. | | `stable_set_value`(x, w) | Compute the value of a stable set, and its feasibility. | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.tsp.md index 139fd94208f..7667c627129 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.tsp.md @@ -1,3 +1,11 @@ +--- +title: tsp +description: API reference for qiskit.optimization.applications.ising.tsp +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.tsp +--- + # qiskit.optimization.applications.ising.tsp @@ -21,3 +29,4 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp | | | | ------------------------------ | --------------------------------------------------- | | `TspData`(name, dim, coord, w) | Create new instance of TspData(name, dim, coord, w) | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.vehicle_routing.md index 59ce2163183..a9608a20790 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.vehicle_routing.md @@ -1,3 +1,11 @@ +--- +title: vehicle_routing +description: API reference for qiskit.optimization.applications.ising.vehicle_routing +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vehicle_routing +--- + # qiskit.optimization.applications.ising.vehicle\_routing @@ -12,3 +20,4 @@ Converts vehicle routing instances into a list of Paulis, and provides some rela | `get_vehiclerouting_cost`(instance, n, K, x\_sol) | Computes the cost of a solution to an instance of a vehicle routing problem. | | `get_vehiclerouting_matrices`(instance, n, K) | Constructs auxiliary matrices from a vehicle routing instance, | | `get_vehiclerouting_solution`(instance, n, K, …) | Tries to obtain a feasible solution (in vector form) of an instance | + diff --git a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.vertex_cover.md index 2ad3728e28b..c55648d7d3d 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.31/qiskit.optimization.applications.ising.vertex_cover.md @@ -1,3 +1,11 @@ +--- +title: vertex_cover +description: API reference for qiskit.optimization.applications.ising.vertex_cover +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vertex_cover +--- + # qiskit.optimization.applications.ising.vertex\_cover @@ -11,3 +19,4 @@ Convert vertex cover instances into Pauli list Deal with Gset format. See [https | `check_full_edge_coverage`(x, w) | **param x**binary string as numpy array. | | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the vertex cover :param weight\_matrix: adjacency matrix. | + diff --git a/docs/api/qiskit/0.31/qiskit.pulse.channels.md b/docs/api/qiskit/0.31/qiskit.pulse.channels.md index 0335b26e49e..6f6a91d2f28 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.channels.md @@ -1,3 +1,11 @@ +--- +title: channels +description: API reference for qiskit.pulse.channels +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.channels +--- + # qiskit.pulse.channels @@ -23,3 +31,4 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s | `PulseChannel`(index) | Base class of transmit Channels. | | `RegisterSlot`(index) | Classical resister slot channels represent classical registers (low-latency classical memory). | | `SnapshotChannel`(\*args, \*\*kwargs) | Snapshot channels are used to specify instructions for simulators. | + diff --git a/docs/api/qiskit/0.31/qiskit.pulse.instructions.md b/docs/api/qiskit/0.31/qiskit.pulse.instructions.md index 5bcc0b989ac..6349cf5c240 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.instructions.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.instructions.md @@ -1,3 +1,11 @@ +--- +title: instructions +description: API reference for qiskit.pulse.instructions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.instructions +--- + # qiskit.pulse.instructions @@ -35,3 +43,4 @@ An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.puls | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`Instruction`](qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | + diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.31/qiskit.pulse.library.discrete.md index 5a40895f62a..6114c5986cb 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.discrete.md @@ -1,3 +1,11 @@ +--- +title: discrete +description: API reference for qiskit.pulse.library.discrete +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library.discrete +--- + # qiskit.pulse.library.discrete @@ -23,3 +31,4 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. | `square`(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | | `triangle`(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | | `zero`(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | + diff --git a/docs/api/qiskit/0.31/qiskit.pulse.library.md b/docs/api/qiskit/0.31/qiskit.pulse.library.md index 484c25b067f..66ef0e3edce 100644 --- a/docs/api/qiskit/0.31/qiskit.pulse.library.md +++ b/docs/api/qiskit/0.31/qiskit.pulse.library.md @@ -1,3 +1,11 @@ +--- +title: library +description: API reference for qiskit.pulse.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library +--- + # qiskit.pulse.library @@ -18,3 +26,4 @@ The parametric pulses, [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse. | [`Drag`](qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | | [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | | [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma\[, …]) | A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio | + diff --git a/docs/api/qiskit/0.31/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.31/qiskit.scheduler.methods.basic.md index a608dbeaf19..9761d8632a5 100644 --- a/docs/api/qiskit/0.31/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.31/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.31/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.31/qiskit.scheduler.schedule_circuit.md index c4adddcabfa..4253a0b99b8 100644 --- a/docs/api/qiskit/0.31/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.31/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | --------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, …]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.32/_toc.json b/docs/api/qiskit/0.32/_toc.json index 0647e292de2..dee6956e4ec 100644 --- a/docs/api/qiskit/0.32/_toc.json +++ b/docs/api/qiskit/0.32/_toc.json @@ -12,10 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.32/algorithms" }, - { - "title": "ADAM", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.32/qiskit.algorithms.AlgorithmError" @@ -40,34 +36,6 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.32/qiskit.algorithms.Eigensolver" @@ -76,10 +44,6 @@ "title": "EigensolverResult", "url": "/api/qiskit/0.32/qiskit.algorithms.EigensolverResult" }, - { - "title": "ESCH", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH" - }, { "title": "EstimationProblem", "url": "/api/qiskit/0.32/qiskit.algorithms.EstimationProblem" @@ -92,10 +56,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent" - }, { "title": "Grover", "url": "/api/qiskit/0.32/qiskit.algorithms.Grover" @@ -104,10 +64,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.32/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -120,14 +76,6 @@ "title": "HHL", "url": "/api/qiskit/0.32/qiskit.algorithms.HHL" }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -140,10 +88,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.L_BFGS_B" - }, { "title": "LinearSolver", "url": "/api/qiskit/0.32/qiskit.algorithms.LinearSolver" @@ -168,14 +112,6 @@ "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver" @@ -188,18 +124,6 @@ "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.P_BFGS" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation" @@ -212,22 +136,10 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL" - }, { "title": "QAOA", "url": "/api/qiskit/0.32/qiskit.algorithms.QAOA" }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA" - }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "Shor", "url": "/api/qiskit/0.32/qiskit.algorithms.Shor" @@ -236,25 +148,126 @@ "title": "ShorResult", "url": "/api/qiskit/0.32/qiskit.algorithms.ShorResult" }, - { - "title": "SLSQP", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "TNC", - "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC" - }, { "title": "VQE", "url": "/api/qiskit/0.32/qiskit.algorithms.VQE" + }, + { + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "qiskit.algorithms.optimizers.nlopts", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.nlopts" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC" + } + ] } ] }, @@ -1743,38 +1756,6 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.32/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.32/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.32/qiskit.circuit.library.Barrier" - }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CCXGate" - }, - { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.32/qiskit.circuit.ClassicalRegister" @@ -1783,226 +1764,22 @@ "title": "Clbit", "url": "/api/qiskit/0.32/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_8_3" - }, { "title": "ControlledGate", "url": "/api/qiskit/0.32/qiskit.circuit.ControlledGate" }, - { - "title": "CPhaseGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CSwapGate" - }, - { - "title": "CSXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CSXGate" - }, - { - "title": "CU1Gate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CU1Gate" - }, - { - "title": "CU3Gate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CU3Gate" - }, - { - "title": "CUGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CUGate" - }, - { - "title": "CXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CXGate" - }, - { - "title": "CYGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CYGate" - }, - { - "title": "CZGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.CZGate" - }, - { - "title": "DCXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.DCXGate" - }, { "title": "Delay", "url": "/api/qiskit/0.32/qiskit.circuit.Delay" }, - { - "title": "Diagonal", - "url": "/api/qiskit/0.32/qiskit.circuit.library.Diagonal" - }, - { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2" - }, { "title": "EquivalenceLibrary", "url": "/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary" }, - { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz" - }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.32/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations" - }, { "title": "Gate", "url": "/api/qiskit/0.32/qiskit.circuit.Gate" }, - { - "title": "GMS", - "url": "/api/qiskit/0.32/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.32/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.32/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.32/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.32/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.32/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.32/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.32/qiskit.circuit.library.InnerProduct" - }, { "title": "Instruction", "url": "/api/qiskit/0.32/qiskit.circuit.Instruction" @@ -2012,547 +1789,792 @@ "url": "/api/qiskit/0.32/qiskit.circuit.InstructionSet" }, { - "title": "IntegerComparator", - "url": "/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.32/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction" + "title": "Measure", + "url": "/api/qiskit/0.32/qiskit.circuit.Measure" }, { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations" + "title": "Parameter", + "url": "/api/qiskit/0.32/qiskit.circuit.Parameter" }, { - "title": "LogNormalDistribution", - "url": "/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution" + "title": "ParameterExpression", + "url": "/api/qiskit/0.32/qiskit.circuit.ParameterExpression" }, { - "title": "MCMT", - "url": "/api/qiskit/0.32/qiskit.circuit.library.MCMT" + "title": "ParameterVector", + "url": "/api/qiskit/0.32/qiskit.circuit.ParameterVector" }, { - "title": "MCMTVChain", - "url": "/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain" + "title": "QuantumCircuit", + "url": "/api/qiskit/0.32/qiskit.circuit.QuantumCircuit" }, { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate" + "title": "QuantumRegister", + "url": "/api/qiskit/0.32/qiskit.circuit.QuantumRegister" }, { - "title": "MCXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXGate" + "title": "Qubit", + "url": "/api/qiskit/0.32/qiskit.circuit.Qubit" }, { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode" + "title": "random_circuit", + "url": "/api/qiskit/0.32/qiskit.circuit.random.random_circuit" }, { - "title": "MCXRecursive", - "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive" + "title": "Reset", + "url": "/api/qiskit/0.32/qiskit.circuit.Reset" }, { - "title": "MCXVChain", - "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXVChain" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.32/qiskit.circuit.Measure" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.32/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.32/qiskit.circuit.library.NLocal" - }, - { - "title": "NormalDistribution", - "url": "/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution" - }, - { - "title": "OR", - "url": "/api/qiskit/0.32/qiskit.circuit.library.OR" - }, - { - "title": "Parameter", - "url": "/api/qiskit/0.32/qiskit.circuit.Parameter" - }, - { - "title": "ParameterExpression", - "url": "/api/qiskit/0.32/qiskit.circuit.ParameterExpression" - }, - { - "title": "ParameterVector", - "url": "/api/qiskit/0.32/qiskit.circuit.ParameterVector" - }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.32/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.32/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm" - }, - { - "title": "QuantumCircuit", - "url": "/api/qiskit/0.32/qiskit.circuit.QuantumCircuit" - }, - { - "title": "QuantumRegister", - "url": "/api/qiskit/0.32/qiskit.circuit.QuantumRegister" - }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume" - }, - { - "title": "Qubit", - "url": "/api/qiskit/0.32/qiskit.circuit.Qubit" - }, - { - "title": "random_circuit", - "url": "/api/qiskit/0.32/qiskit.circuit.random.random_circuit" - }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.32/qiskit.circuit.Reset" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.32/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.SGate" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.32/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.UGate" - }, - { - "title": "UniformDistribution", - "url": "/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.32/qiskit.circuit.library.XOR" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.32/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.32/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.32/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.32/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.32/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.32/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.32/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.32/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.32/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "LogNormalDistribution", + "url": "/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.32/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.32/qiskit.circuit.library.NLocal" + }, + { + "title": "NormalDistribution", + "url": "/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution" + }, + { + "title": "OR", + "url": "/api/qiskit/0.32/qiskit.circuit.library.OR" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.32/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.32/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.32/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_cy" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "rzx_xz", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_xz" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "rzx_yz", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_yz" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "rzx_zz1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_zz1" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "rzx_zz2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.SGate" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.32/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.U2Gate" + }, + { + "title": "U3Gate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.U3Gate" + }, + { + "title": "UGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.UGate" + }, + { + "title": "UniformDistribution", + "url": "/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution" + }, + { + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.32/qiskit.circuit.library.XOR" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap" } ] }, @@ -2723,7 +2745,20 @@ }, { "title": "qiskit.finance.applications.ising", - "url": "/api/qiskit/0.32/qiskit.finance.applications.ising" + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.finance.applications.ising" + }, + { + "title": "qiskit.finance.applications.ising.portfolio", + "url": "/api/qiskit/0.32/qiskit.finance.applications.ising.portfolio" + }, + { + "title": "qiskit.finance.applications.ising.portfolio_diversification", + "url": "/api/qiskit/0.32/qiskit.finance.applications.ising.portfolio_diversification" + } + ] } ] }, @@ -3158,6 +3193,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.32/qiskit.ignis.verification.QOTP" @@ -3276,225 +3315,288 @@ "title": "Overview", "url": "/api/qiskit/0.32/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.32/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.32/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.32/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.32/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.32/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.32/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.32/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.32/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3611,7 +3713,64 @@ }, { "title": "qiskit.optimization.applications.ising", - "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising" + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising" + }, + { + "title": "qiskit.optimization.applications.ising.clique", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.clique" + }, + { + "title": "qiskit.optimization.applications.ising.common", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.common" + }, + { + "title": "qiskit.optimization.applications.ising.docplex", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.docplex" + }, + { + "title": "qiskit.optimization.applications.ising.exact_cover", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.exact_cover" + }, + { + "title": "qiskit.optimization.applications.ising.graph_partition", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.graph_partition" + }, + { + "title": "qiskit.optimization.applications.ising.knapsack", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.knapsack" + }, + { + "title": "qiskit.optimization.applications.ising.max_cut", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.max_cut" + }, + { + "title": "qiskit.optimization.applications.ising.partition", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.partition" + }, + { + "title": "qiskit.optimization.applications.ising.set_packing", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.set_packing" + }, + { + "title": "qiskit.optimization.applications.ising.stable_set", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.stable_set" + }, + { + "title": "qiskit.optimization.applications.ising.tsp", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.tsp" + }, + { + "title": "qiskit.optimization.applications.ising.vehicle_routing", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.vehicle_routing" + }, + { + "title": "qiskit.optimization.applications.ising.vertex_cover", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising.vertex_cover" + } + ] } ] }, @@ -4572,10 +4731,6 @@ "title": "acquire", "url": "/api/qiskit/0.32/qiskit.pulse.builder.acquire" }, - { - "title": "Acquire", - "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Acquire" - }, { "title": "acquire_channel", "url": "/api/qiskit/0.32/qiskit.pulse.builder.acquire_channel" @@ -4640,10 +4795,6 @@ "title": "call", "url": "/api/qiskit/0.32/qiskit.pulse.builder.call" }, - { - "title": "Call", - "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Call" - }, { "title": "circuit_scheduler_settings", "url": "/api/qiskit/0.32/qiskit.pulse.builder.circuit_scheduler_settings" @@ -4652,10 +4803,6 @@ "title": "Constant", "url": "/api/qiskit/0.32/qiskit.pulse.Constant" }, - { - "title": "Constant", - "url": "/api/qiskit/0.32/qiskit.pulse.library.Constant" - }, { "title": "control_channels", "url": "/api/qiskit/0.32/qiskit.pulse.builder.control_channels" @@ -4676,10 +4823,6 @@ "title": "delay", "url": "/api/qiskit/0.32/qiskit.pulse.builder.delay" }, - { - "title": "Delay", - "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Delay" - }, { "title": "delay_qubits", "url": "/api/qiskit/0.32/qiskit.pulse.builder.delay_qubits" @@ -4688,10 +4831,6 @@ "title": "Drag", "url": "/api/qiskit/0.32/qiskit.pulse.Drag" }, - { - "title": "Drag", - "url": "/api/qiskit/0.32/qiskit.pulse.library.Drag" - }, { "title": "drive_channel", "url": "/api/qiskit/0.32/qiskit.pulse.builder.drive_channel" @@ -4708,18 +4847,10 @@ "title": "Gaussian", "url": "/api/qiskit/0.32/qiskit.pulse.Gaussian" }, - { - "title": "Gaussian", - "url": "/api/qiskit/0.32/qiskit.pulse.library.Gaussian" - }, { "title": "GaussianSquare", "url": "/api/qiskit/0.32/qiskit.pulse.GaussianSquare" }, - { - "title": "GaussianSquare", - "url": "/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare" - }, { "title": "inline", "url": "/api/qiskit/0.32/qiskit.pulse.builder.inline" @@ -4728,10 +4859,6 @@ "title": "Instruction", "url": "/api/qiskit/0.32/qiskit.pulse.Instruction" }, - { - "title": "Instruction", - "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Instruction" - }, { "title": "InstructionScheduleMap", "url": "/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap" @@ -4780,14 +4907,14 @@ "title": "play", "url": "/api/qiskit/0.32/qiskit.pulse.builder.play" }, - { - "title": "Play", - "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Play" - }, { "title": "PulseError", "url": "/api/qiskit/0.32/qiskit.pulse.PulseError" }, + { + "title": "qiskit.pulse.channels", + "url": "/api/qiskit/0.32/qiskit.pulse.channels" + }, { "title": "qubit_channels", "url": "/api/qiskit/0.32/qiskit.pulse.builder.qubit_channels" @@ -4824,18 +4951,10 @@ "title": "SetFrequency", "url": "/api/qiskit/0.32/qiskit.pulse.SetFrequency" }, - { - "title": "SetFrequency", - "url": "/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency" - }, { "title": "SetPhase", "url": "/api/qiskit/0.32/qiskit.pulse.SetPhase" }, - { - "title": "SetPhase", - "url": "/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase" - }, { "title": "shift_frequency", "url": "/api/qiskit/0.32/qiskit.pulse.builder.shift_frequency" @@ -4848,18 +4967,10 @@ "title": "ShiftFrequency", "url": "/api/qiskit/0.32/qiskit.pulse.ShiftFrequency" }, - { - "title": "ShiftFrequency", - "url": "/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency" - }, { "title": "ShiftPhase", "url": "/api/qiskit/0.32/qiskit.pulse.ShiftPhase" }, - { - "title": "ShiftPhase", - "url": "/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase" - }, { "title": "Snapshot", "url": "/api/qiskit/0.32/qiskit.pulse.Snapshot" @@ -4868,10 +4979,6 @@ "title": "snapshot", "url": "/api/qiskit/0.32/qiskit.pulse.builder.snapshot" }, - { - "title": "Snapshot", - "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot" - }, { "title": "transpiler_settings", "url": "/api/qiskit/0.32/qiskit.pulse.builder.transpiler_settings" @@ -4892,13 +4999,91 @@ "title": "Waveform", "url": "/api/qiskit/0.32/qiskit.pulse.Waveform" }, - { - "title": "Waveform", - "url": "/api/qiskit/0.32/qiskit.pulse.library.Waveform" - }, { "title": "x", "url": "/api/qiskit/0.32/qiskit.pulse.builder.x" + }, + { + "title": "qiskit.pulse.instructions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions" + }, + { + "title": "Acquire", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Acquire" + }, + { + "title": "Call", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Call" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Delay" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Instruction" + }, + { + "title": "Play", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Play" + }, + { + "title": "SetFrequency", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency" + }, + { + "title": "SetPhase", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase" + }, + { + "title": "ShiftFrequency", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency" + }, + { + "title": "ShiftPhase", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot" + } + ] + }, + { + "title": "qiskit.pulse.library", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.pulse.library" + }, + { + "title": "Constant", + "url": "/api/qiskit/0.32/qiskit.pulse.library.Constant" + }, + { + "title": "Drag", + "url": "/api/qiskit/0.32/qiskit.pulse.library.Drag" + }, + { + "title": "Gaussian", + "url": "/api/qiskit/0.32/qiskit.pulse.library.Gaussian" + }, + { + "title": "GaussianSquare", + "url": "/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare" + }, + { + "title": "qiskit.pulse.library.discrete", + "url": "/api/qiskit/0.32/qiskit.pulse.library.discrete" + }, + { + "title": "Waveform", + "url": "/api/qiskit/0.32/qiskit.pulse.library.Waveform" + } + ] } ] }, @@ -5249,6 +5434,14 @@ "title": "Overview", "url": "/api/qiskit/0.32/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.32/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.32/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.32/circuit_library.md b/docs/api/qiskit/0.32/circuit_library.md index 5690a237078..d38da990492 100644 --- a/docs/api/qiskit/0.32/circuit_library.md +++ b/docs/api/qiskit/0.32/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -277,3 +289,4 @@ | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.md index 189091514ea..9aef02e1505 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -67,3 +79,4 @@ The global optimizers are as follows: | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.nlopts.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.nlopts.md index f7fb470a11e..b430ce1d9d8 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.nlopts.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.nlopts.md @@ -1,3 +1,11 @@ +--- +title: nlopts +description: API reference for qiskit.algorithms.optimizers.nlopts +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.nlopts +--- + # qiskit.algorithms.optimizers.nlopts @@ -26,3 +34,4 @@ export PYTHONPATH=/usr/local/lib/python3.6/site-packages:${PYTHONPATH} ``` The two `export` commands above can be pasted into the `.bash_profile` file in the user’s home directory for automatic execution. Now you can run Qiskit and these optimizers should be available for you to use. + diff --git a/docs/api/qiskit/0.32/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.32/qiskit.finance.applications.ising.portfolio.md index b0a1fd4ce14..d8ff1c47f32 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.applications.ising.portfolio.md +++ b/docs/api/qiskit/0.32/qiskit.finance.applications.ising.portfolio.md @@ -1,3 +1,11 @@ +--- +title: portfolio +description: API reference for qiskit.finance.applications.ising.portfolio +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio +--- + # qiskit.finance.applications.ising.portfolio @@ -13,3 +21,4 @@ Convert portfolio optimization instances into Pauli list | `portfolio_value`(x, mu, sigma, q, budget, penalty) | returns portfolio value | | `portfolio_variance`(x, sigma) | returns portfolio variance | | `random_model`(n\[, seed]) | Generate random model (mu, sigma) for portfolio optimization problem. | + diff --git a/docs/api/qiskit/0.32/qiskit.finance.applications.ising.portfolio_diversification.md b/docs/api/qiskit/0.32/qiskit.finance.applications.ising.portfolio_diversification.md index d9bfae4b1fd..34bcd93172d 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.applications.ising.portfolio_diversification.md +++ b/docs/api/qiskit/0.32/qiskit.finance.applications.ising.portfolio_diversification.md @@ -1,3 +1,11 @@ +--- +title: portfolio_diversification +description: API reference for qiskit.finance.applications.ising.portfolio_diversification +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.finance.applications.ising.portfolio_diversification +--- + # qiskit.finance.applications.ising.portfolio\_diversification @@ -11,3 +19,4 @@ portfolio diversification | `get_operator`(rho, n, q) | Converts an instance of portfolio optimization into a list of Paulis. | | `get_portfoliodiversification_solution`(rho, …) | Tries to obtain a feasible solution (in vector form) of an instance of portfolio diversification from the results dictionary. | | `get_portfoliodiversification_value`(rho, n, …) | Evaluates an objective function of an instance of portfolio diversification and its solution (in vector form). | + diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.basis.md index e26610b6708..c7c0137e9f8 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.basis.md @@ -1,5 +1,14 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # qiskit.ignis.verification.basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.md b/docs/api/qiskit/0.32/qiskit.opflow.converters.md index de1cf2608c0..dd5860cb4b8 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, …]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, …]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.md index c1fbc4558e7..35e46f5058d 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.md b/docs/api/qiskit/0.32/qiskit.opflow.expectations.md index 5f7f2c40cb7..9c99521085d 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.md index d47fd11d45b..d19fdc725a5 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, …]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.md index e4108d55522..5593a1b809a 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](qiskit.aqua.operators.list_ops#module-qiskit.aqua.operators.list_ops "qiskit.aqua.operators.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.md index 9b8d4929b0c..c1f8f35ade4 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.md index be5505d8a1f..ada961c9425 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, …]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, …]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.clique.md index 2e4cee68850..1abbbaf85c3 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.clique.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.clique.md @@ -1,3 +1,11 @@ +--- +title: clique +description: API reference for qiskit.optimization.applications.ising.clique +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.clique +--- + # qiskit.optimization.applications.ising.clique @@ -13,3 +21,4 @@ Deal with Gset format. See [https://web.stanford.edu/\~yyye/yyye/Gset/](https:// | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix, K) | Generate Hamiltonian for the clique. | | `satisfy_or_not`(x, w, K) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.common.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.common.md index 60923757fc4..26464086f88 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.common.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.common.md @@ -1,3 +1,11 @@ +--- +title: common +description: API reference for qiskit.optimization.applications.ising.common +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.common +--- + # qiskit.optimization.applications.ising.common @@ -14,3 +22,4 @@ common module | `random_number_list`(n\[, weight\_range, …]) | Generate a set of positive integers within the given range. | | `read_numbers_from_file`(filename) | Read numbers from a file | | `sample_most_likely`(state\_vector) | Compute the most likely binary string from state vector. | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.docplex.md index 8a8fff9aa95..944b3c91d9b 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.docplex.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.docplex.md @@ -1,3 +1,11 @@ +--- +title: docplex +description: API reference for qiskit.optimization.applications.ising.docplex +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.docplex +--- + # qiskit.optimization.applications.ising.docplex @@ -49,3 +57,4 @@ print('tsp objective:', result['energy'] + offset) | | | | ---------------------------------------- | --------------------------------------------------- | | `get_operator`(mdl\[, auto\_penalty, …]) | Generate Ising Hamiltonian from a model of DOcplex. | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.exact_cover.md index 4bbd8e4a464..5b6dde4bf45 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.exact_cover.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.exact_cover.md @@ -1,3 +1,11 @@ +--- +title: exact_cover +description: API reference for qiskit.optimization.applications.ising.exact_cover +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.exact_cover +--- + # qiskit.optimization.applications.ising.exact\_cover @@ -11,3 +19,4 @@ exact cover | `check_solution_satisfiability`(sol, …) | check solution satisfiability | | `get_operator`(list\_of\_subsets) | Construct the Hamiltonian for the exact solver problem. | | `get_solution`(x) | **param x**binary string as numpy array. | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.graph_partition.md index 9249f6a3fae..8236aeed15a 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.graph_partition.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.graph_partition.md @@ -1,3 +1,11 @@ +--- +title: graph_partition +description: API reference for qiskit.optimization.applications.ising.graph_partition +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.graph_partition +--- + # qiskit.optimization.applications.ising.graph\_partition @@ -11,3 +19,4 @@ Convert graph partitioning instances into Pauli list Deal with Gset format. See | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the graph partitioning | | `objective_value`(x, w) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.knapsack.md index e9f34622a28..da979a64833 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.knapsack.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.knapsack.md @@ -1,3 +1,11 @@ +--- +title: knapsack +description: API reference for qiskit.optimization.applications.ising.knapsack +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.knapsack +--- + # qiskit.optimization.applications.ising.knapsack @@ -15,3 +23,4 @@ If we have the weights w\[i], the values v\[i] and the maximum weight W\_max. We | `get_operator`(values, weights, max\_weight) | Generate Hamiltonian for the knapsack problem. | | `get_solution`(x, values) | Get the solution to the knapsack problem from the bitstring that represents to the ground state of the Hamiltonian | | `knapsack_value_weight`(solution, values, weights) | Get the total wight and value of the items taken in the knapsack. | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.max_cut.md index 5ff110e890e..44417cf9629 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.max_cut.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.max_cut.md @@ -1,3 +1,11 @@ +--- +title: max_cut +description: API reference for qiskit.optimization.applications.ising.max_cut +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.max_cut +--- + # qiskit.optimization.applications.ising.max\_cut @@ -11,3 +19,4 @@ Convert max-cut instances into Pauli list Deal with Gset format. See [https://we | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the max-cut problem of a graph. | | `max_cut_value`(x, w) | Compute the value of a cut. | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.partition.md index d7d2956ba87..d09b7f6bf41 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.partition.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.partition.md @@ -1,3 +1,11 @@ +--- +title: partition +description: API reference for qiskit.optimization.applications.ising.partition +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.partition +--- + # qiskit.optimization.applications.ising.partition @@ -10,3 +18,4 @@ Generate Number Partitioning (Partition) instances, and convert them into a Hami | ---------------------------------- | --------------------------------------------------------- | | `get_operator`(values) | Construct the Hamiltonian for a given Partition instance. | | `partition_value`(x, number\_list) | Compute the value of a partition. | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.set_packing.md index e285f22c000..7e956256324 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.set_packing.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.set_packing.md @@ -1,3 +1,11 @@ +--- +title: set_packing +description: API reference for qiskit.optimization.applications.ising.set_packing +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.set_packing +--- + # qiskit.optimization.applications.ising.set\_packing @@ -11,3 +19,4 @@ set packing module | `check_disjoint`(sol, list\_of\_subsets) | check disjoint | | `get_operator`(list\_of\_subsets) | Construct the Hamiltonian for the set packing. | | `get_solution`(x) | **param x**binary string as numpy array. | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.stable_set.md index ad51e1a564f..947b8706017 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.stable_set.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.stable_set.md @@ -1,3 +1,11 @@ +--- +title: stable_set +description: API reference for qiskit.optimization.applications.ising.stable_set +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.stable_set +--- + # qiskit.optimization.applications.ising.stable\_set @@ -11,3 +19,4 @@ Convert stable set instances into Pauli list. We read instances in the Gset form | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(w) | Generate Hamiltonian for the maximum stable set in a graph. | | `stable_set_value`(x, w) | Compute the value of a stable set, and its feasibility. | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.tsp.md index 139fd94208f..7667c627129 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.tsp.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.tsp.md @@ -1,3 +1,11 @@ +--- +title: tsp +description: API reference for qiskit.optimization.applications.ising.tsp +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.tsp +--- + # qiskit.optimization.applications.ising.tsp @@ -21,3 +29,4 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp | | | | ------------------------------ | --------------------------------------------------- | | `TspData`(name, dim, coord, w) | Create new instance of TspData(name, dim, coord, w) | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.vehicle_routing.md index 59ce2163183..a9608a20790 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.vehicle_routing.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.vehicle_routing.md @@ -1,3 +1,11 @@ +--- +title: vehicle_routing +description: API reference for qiskit.optimization.applications.ising.vehicle_routing +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vehicle_routing +--- + # qiskit.optimization.applications.ising.vehicle\_routing @@ -12,3 +20,4 @@ Converts vehicle routing instances into a list of Paulis, and provides some rela | `get_vehiclerouting_cost`(instance, n, K, x\_sol) | Computes the cost of a solution to an instance of a vehicle routing problem. | | `get_vehiclerouting_matrices`(instance, n, K) | Constructs auxiliary matrices from a vehicle routing instance, | | `get_vehiclerouting_solution`(instance, n, K, …) | Tries to obtain a feasible solution (in vector form) of an instance | + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.vertex_cover.md index 2ad3728e28b..c55648d7d3d 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.vertex_cover.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.applications.ising.vertex_cover.md @@ -1,3 +1,11 @@ +--- +title: vertex_cover +description: API reference for qiskit.optimization.applications.ising.vertex_cover +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.optimization.applications.ising.vertex_cover +--- + # qiskit.optimization.applications.ising.vertex\_cover @@ -11,3 +19,4 @@ Convert vertex cover instances into Pauli list Deal with Gset format. See [https | `check_full_edge_coverage`(x, w) | **param x**binary string as numpy array. | | `get_graph_solution`(x) | Get graph solution from binary string. | | `get_operator`(weight\_matrix) | Generate Hamiltonian for the vertex cover :param weight\_matrix: adjacency matrix. | + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.channels.md b/docs/api/qiskit/0.32/qiskit.pulse.channels.md index 0335b26e49e..6f6a91d2f28 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.channels.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.channels.md @@ -1,3 +1,11 @@ +--- +title: channels +description: API reference for qiskit.pulse.channels +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.channels +--- + # qiskit.pulse.channels @@ -23,3 +31,4 @@ Novel channel types can often utilize the `ControlChannel`, but if this is not s | `PulseChannel`(index) | Base class of transmit Channels. | | `RegisterSlot`(index) | Classical resister slot channels represent classical registers (low-latency classical memory). | | `SnapshotChannel`(\*args, \*\*kwargs) | Snapshot channels are used to specify instructions for simulators. | + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.md index 5bcc0b989ac..6349cf5c240 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.md @@ -1,3 +1,11 @@ +--- +title: instructions +description: API reference for qiskit.pulse.instructions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.instructions +--- + # qiskit.pulse.instructions @@ -35,3 +43,4 @@ An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.puls | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`Instruction`](qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.32/qiskit.pulse.library.discrete.md index 5a40895f62a..6114c5986cb 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.discrete.md @@ -1,3 +1,11 @@ +--- +title: discrete +description: API reference for qiskit.pulse.library.discrete +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library.discrete +--- + # qiskit.pulse.library.discrete @@ -23,3 +31,4 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. | `square`(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | | `triangle`(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | | `zero`(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.md b/docs/api/qiskit/0.32/qiskit.pulse.library.md index 484c25b067f..66ef0e3edce 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.md @@ -1,3 +1,11 @@ +--- +title: library +description: API reference for qiskit.pulse.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library +--- + # qiskit.pulse.library @@ -18,3 +26,4 @@ The parametric pulses, [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse. | [`Drag`](qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | | [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | | [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma\[, …]) | A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio | + diff --git a/docs/api/qiskit/0.32/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.32/qiskit.scheduler.methods.basic.md index a608dbeaf19..9761d8632a5 100644 --- a/docs/api/qiskit/0.32/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.32/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.32/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.32/qiskit.scheduler.schedule_circuit.md index c4adddcabfa..4253a0b99b8 100644 --- a/docs/api/qiskit/0.32/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.32/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | --------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, …]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.33/_toc.json b/docs/api/qiskit/0.33/_toc.json index 6d4dae2810a..71cdf571d89 100644 --- a/docs/api/qiskit/0.33/_toc.json +++ b/docs/api/qiskit/0.33/_toc.json @@ -12,10 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.33/algorithms" }, - { - "title": "ADAM", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.ADAM" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.33/qiskit.algorithms.AlgorithmError" @@ -40,34 +36,6 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.33/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.33/qiskit.algorithms.Eigensolver" @@ -76,10 +44,6 @@ "title": "EigensolverResult", "url": "/api/qiskit/0.33/qiskit.algorithms.EigensolverResult" }, - { - "title": "ESCH", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.ESCH" - }, { "title": "EstimationProblem", "url": "/api/qiskit/0.33/qiskit.algorithms.EstimationProblem" @@ -92,10 +56,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.33/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.GradientDescent" - }, { "title": "Grover", "url": "/api/qiskit/0.33/qiskit.algorithms.Grover" @@ -104,10 +64,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.33/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.33/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -120,14 +76,6 @@ "title": "HHL", "url": "/api/qiskit/0.33/qiskit.algorithms.HHL" }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.33/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -140,10 +88,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.33/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.L_BFGS_B" - }, { "title": "LinearSolver", "url": "/api/qiskit/0.33/qiskit.algorithms.LinearSolver" @@ -168,14 +112,6 @@ "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.33/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.33/qiskit.algorithms.NumPyEigensolver" @@ -188,22 +124,6 @@ "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.33/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerResult", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerResult" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.P_BFGS" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.33/qiskit.algorithms.PhaseEstimation" @@ -216,22 +136,10 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.33/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.POWELL" - }, { "title": "QAOA", "url": "/api/qiskit/0.33/qiskit.algorithms.QAOA" }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.QNSPSA" - }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "Shor", "url": "/api/qiskit/0.33/qiskit.algorithms.Shor" @@ -240,25 +148,130 @@ "title": "ShorResult", "url": "/api/qiskit/0.33/qiskit.algorithms.ShorResult" }, - { - "title": "SLSQP", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "TNC", - "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.TNC" - }, { "title": "VQE", "url": "/api/qiskit/0.33/qiskit.algorithms.VQE" + }, + { + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerResult", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerResult" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "qiskit.algorithms.optimizers.nlopts", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.nlopts" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.33/qiskit.algorithms.optimizers.TNC" + } + ] } ] }, @@ -302,42 +315,10 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.33/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.33/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.33/qiskit.circuit.library.Barrier" - }, { "title": "BreakLoopOp", "url": "/api/qiskit/0.33/qiskit.circuit.BreakLoopOp" }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CCXGate" - }, - { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CDKMRippleCarryAdder" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.33/qiskit.circuit.ClassicalRegister" @@ -346,78 +327,6 @@ "title": "Clbit", "url": "/api/qiskit/0.33/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_8_3" - }, { "title": "ContinueLoopOp", "url": "/api/qiskit/0.33/qiskit.circuit.ContinueLoopOp" @@ -430,162 +339,26 @@ "title": "ControlledGate", "url": "/api/qiskit/0.33/qiskit.circuit.ControlledGate" }, - { - "title": "CPhaseGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CSwapGate" - }, - { - "title": "CSXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CSXGate" - }, - { - "title": "CU1Gate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CU1Gate" - }, - { - "title": "CU3Gate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CU3Gate" - }, - { - "title": "CUGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CUGate" - }, - { - "title": "CXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CXGate" - }, - { - "title": "CYGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CYGate" - }, - { - "title": "CZGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.CZGate" - }, - { - "title": "DCXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.DCXGate" - }, { "title": "Delay", "url": "/api/qiskit/0.33/qiskit.circuit.Delay" }, - { - "title": "Diagonal", - "url": "/api/qiskit/0.33/qiskit.circuit.library.Diagonal" - }, - { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.33/qiskit.circuit.library.DraperQFTAdder" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.EfficientSU2" - }, { "title": "EquivalenceLibrary", "url": "/api/qiskit/0.33/qiskit.circuit.EquivalenceLibrary" }, - { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.33/qiskit.circuit.library.EvolvedOperatorAnsatz" - }, - { - "title": "ExactReciprocal", - "url": "/api/qiskit/0.33/qiskit.circuit.library.ExactReciprocal" - }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.33/qiskit.circuit.library.ExcitationPreserving" - }, { "title": "ForLoopOp", "url": "/api/qiskit/0.33/qiskit.circuit.ForLoopOp" }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.33/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.33/qiskit.circuit.library.FunctionalPauliRotations" - }, { "title": "Gate", "url": "/api/qiskit/0.33/qiskit.circuit.Gate" }, - { - "title": "GMS", - "url": "/api/qiskit/0.33/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.33/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.33/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.33/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.33/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.33/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.33/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.33/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.33/qiskit.circuit.library.HRSCumulativeMultiplier" - }, { "title": "IfElseOp", "url": "/api/qiskit/0.33/qiskit.circuit.IfElseOp" }, - { - "title": "IGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.33/qiskit.circuit.library.InnerProduct" - }, { "title": "Instruction", "url": "/api/qiskit/0.33/qiskit.circuit.Instruction" @@ -595,555 +368,804 @@ "url": "/api/qiskit/0.33/qiskit.circuit.InstructionSet" }, { - "title": "IntegerComparator", - "url": "/api/qiskit/0.33/qiskit.circuit.library.IntegerComparator" + "title": "Measure", + "url": "/api/qiskit/0.33/qiskit.circuit.Measure" }, { - "title": "IQP", - "url": "/api/qiskit/0.33/qiskit.circuit.library.IQP" + "title": "Parameter", + "url": "/api/qiskit/0.33/qiskit.circuit.Parameter" }, { - "title": "iSwapGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.iSwapGate" + "title": "ParameterExpression", + "url": "/api/qiskit/0.33/qiskit.circuit.ParameterExpression" }, { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.33/qiskit.circuit.library.LinearAmplitudeFunction" + "title": "ParameterVector", + "url": "/api/qiskit/0.33/qiskit.circuit.ParameterVector" }, { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.33/qiskit.circuit.library.LinearPauliRotations" + "title": "QuantumCircuit", + "url": "/api/qiskit/0.33/qiskit.circuit.QuantumCircuit" }, { - "title": "LogNormalDistribution", - "url": "/api/qiskit/0.33/qiskit.circuit.library.LogNormalDistribution" + "title": "QuantumRegister", + "url": "/api/qiskit/0.33/qiskit.circuit.QuantumRegister" }, { - "title": "MCMT", - "url": "/api/qiskit/0.33/qiskit.circuit.library.MCMT" + "title": "Qubit", + "url": "/api/qiskit/0.33/qiskit.circuit.Qubit" }, { - "title": "MCMTVChain", - "url": "/api/qiskit/0.33/qiskit.circuit.library.MCMTVChain" + "title": "random_circuit", + "url": "/api/qiskit/0.33/qiskit.circuit.random.random_circuit" }, { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.MCPhaseGate" - }, - { - "title": "MCXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.MCXGate" - }, - { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.33/qiskit.circuit.library.MCXGrayCode" - }, - { - "title": "MCXRecursive", - "url": "/api/qiskit/0.33/qiskit.circuit.library.MCXRecursive" - }, - { - "title": "MCXVChain", - "url": "/api/qiskit/0.33/qiskit.circuit.library.MCXVChain" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.33/qiskit.circuit.Measure" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.33/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.33/qiskit.circuit.library.NLocal" - }, - { - "title": "NormalDistribution", - "url": "/api/qiskit/0.33/qiskit.circuit.library.NormalDistribution" - }, - { - "title": "OR", - "url": "/api/qiskit/0.33/qiskit.circuit.library.OR" - }, - { - "title": "Parameter", - "url": "/api/qiskit/0.33/qiskit.circuit.Parameter" - }, - { - "title": "ParameterExpression", - "url": "/api/qiskit/0.33/qiskit.circuit.ParameterExpression" - }, - { - "title": "ParameterVector", - "url": "/api/qiskit/0.33/qiskit.circuit.ParameterVector" - }, - { - "title": "PauliEvolutionGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.PauliEvolutionGate" - }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.33/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.33/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.33/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.33/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.33/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.33/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.33/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.33/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.33/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.33/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.33/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.33/qiskit.circuit.library.QuadraticForm" - }, - { - "title": "QuantumCircuit", - "url": "/api/qiskit/0.33/qiskit.circuit.QuantumCircuit" - }, - { - "title": "QuantumRegister", - "url": "/api/qiskit/0.33/qiskit.circuit.QuantumRegister" - }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.33/qiskit.circuit.library.QuantumVolume" - }, - { - "title": "Qubit", - "url": "/api/qiskit/0.33/qiskit.circuit.Qubit" - }, - { - "title": "random_circuit", - "url": "/api/qiskit/0.33/qiskit.circuit.random.random_circuit" - }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RealAmplitudes" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.33/qiskit.circuit.Reset" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.33/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.SGate" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.33/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.UGate" - }, - { - "title": "UniformDistribution", - "url": "/api/qiskit/0.33/qiskit.circuit.library.UniformDistribution" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.33/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.33/qiskit.circuit.library.WeightedAdder" + "title": "Reset", + "url": "/api/qiskit/0.33/qiskit.circuit.Reset" }, { "title": "WhileLoopOp", "url": "/api/qiskit/0.33/qiskit.circuit.WhileLoopOp" }, { - "title": "XGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.33/qiskit.circuit.library.XOR" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.33/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.33/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.33/qiskit.circuit.library.ZZFeatureMap" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.33/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.33/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.33/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.33/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.33/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.33/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.33/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.33/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.33/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.33/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExactReciprocal", + "url": "/api/qiskit/0.33/qiskit.circuit.library.ExactReciprocal" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.33/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.33/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.33/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.33/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.33/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.33/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.33/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.33/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.33/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.33/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.33/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.33/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.33/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.33/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.33/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.33/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.33/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "LogNormalDistribution", + "url": "/api/qiskit/0.33/qiskit.circuit.library.LogNormalDistribution" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.33/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.33/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.33/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.33/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.33/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.33/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.33/qiskit.circuit.library.NLocal" + }, + { + "title": "NormalDistribution", + "url": "/api/qiskit/0.33/qiskit.circuit.library.NormalDistribution" + }, + { + "title": "OR", + "url": "/api/qiskit/0.33/qiskit.circuit.library.OR" + }, + { + "title": "PauliEvolutionGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.PauliEvolutionGate" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.33/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.33/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.33/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.33/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.33/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.33/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.33/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.33/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.33/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.33/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.33/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.33/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.33/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.33/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.33/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.SGate" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.33/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.33/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.U1Gate" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.33/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "U2Gate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.U2Gate" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "U3Gate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.U3Gate" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "UGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.UGate" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.33/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "UniformDistribution", + "url": "/api/qiskit/0.33/qiskit.circuit.library.UniformDistribution" + }, + { + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.33/qiskit.circuit.library.VBERippleCarryAdder" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.33/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.33/qiskit.circuit.library.XOR" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.33/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.33/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.33/qiskit.circuit.library.ZZFeatureMap" } ] }, @@ -1668,6 +1690,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.33/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.33/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.33/qiskit.ignis.verification.QOTP" @@ -1731,225 +1757,288 @@ "title": "Overview", "url": "/api/qiskit/0.33/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.33/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.33/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.33/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.33/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.33/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.33/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.33/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.33/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.33/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.33/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.33/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.33/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.33/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.33/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.33/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.33/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.33/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.33/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.33/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.33/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.33/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.33/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.33/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.33/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.33/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.33/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.33/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.33/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.33/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.33/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.33/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.33/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.33/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.33/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.33/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.33/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.33/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.33/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.33/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.33/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.33/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.33/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.33/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.33/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.33/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.33/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.33/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.33/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.33/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.33/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.33/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.33/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.33/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.33/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.33/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.33/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.33/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.33/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.33/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.33/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.33/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.33/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.33/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3054,6 +3143,10 @@ "title": "Play", "url": "/api/qiskit/0.33/qiskit.pulse.instructions.Play" }, + { + "title": "qiskit.pulse.library.discrete", + "url": "/api/qiskit/0.33/qiskit.pulse.library.discrete" + }, { "title": "qubit_channels", "url": "/api/qiskit/0.33/qiskit.pulse.builder.qubit_channels" @@ -3527,6 +3620,14 @@ "title": "Overview", "url": "/api/qiskit/0.33/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.33/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.33/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.33/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.33/circuit_library.md b/docs/api/qiskit/0.33/circuit_library.md index 2dd7c7f0377..2b82fcf009c 100644 --- a/docs/api/qiskit/0.33/circuit_library.md +++ b/docs/api/qiskit/0.33/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -284,3 +296,4 @@ | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.md index e3b583eea1f..52d3e642205 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -68,3 +80,4 @@ The global optimizers are as follows: | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.nlopts.md b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.nlopts.md index f7fb470a11e..b430ce1d9d8 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.nlopts.md +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.nlopts.md @@ -1,3 +1,11 @@ +--- +title: nlopts +description: API reference for qiskit.algorithms.optimizers.nlopts +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.nlopts +--- + # qiskit.algorithms.optimizers.nlopts @@ -26,3 +34,4 @@ export PYTHONPATH=/usr/local/lib/python3.6/site-packages:${PYTHONPATH} ``` The two `export` commands above can be pasted into the `.bash_profile` file in the user’s home directory for automatic execution. Now you can run Qiskit and these optimizers should be available for you to use. + diff --git a/docs/api/qiskit/0.33/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.33/qiskit.ignis.verification.basis.md index e26610b6708..c7c0137e9f8 100644 --- a/docs/api/qiskit/0.33/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.33/qiskit.ignis.verification.basis.md @@ -1,5 +1,14 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # qiskit.ignis.verification.basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.33/qiskit.opflow.converters.md b/docs/api/qiskit/0.33/qiskit.opflow.converters.md index de1cf2608c0..dd5860cb4b8 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, …]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, …]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.md index c1fbc4558e7..35e46f5058d 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.33/qiskit.opflow.expectations.md b/docs/api/qiskit/0.33/qiskit.opflow.expectations.md index 5f7f2c40cb7..9c99521085d 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.33/qiskit.opflow.gradients.md b/docs/api/qiskit/0.33/qiskit.opflow.gradients.md index d47fd11d45b..d19fdc725a5 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, …]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.md index 52e0dc2c824..d0d1b25a032 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.md index 9b8d4929b0c..c1f8f35ade4 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.md index be5505d8a1f..ada961c9425 100644 --- a/docs/api/qiskit/0.33/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.33/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, …]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, …]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.33/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.33/qiskit.pulse.library.discrete.md index 221122be547..efaf843a0aa 100644 --- a/docs/api/qiskit/0.33/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.33/qiskit.pulse.library.discrete.md @@ -1,3 +1,11 @@ +--- +title: discrete +description: API reference for qiskit.pulse.library.discrete +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library.discrete +--- + # qiskit.pulse.library.discrete @@ -23,3 +31,4 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. | `square`(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | | `triangle`(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | | `zero`(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | + diff --git a/docs/api/qiskit/0.33/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.33/qiskit.scheduler.methods.basic.md index a608dbeaf19..9761d8632a5 100644 --- a/docs/api/qiskit/0.33/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.33/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.33/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.33/qiskit.scheduler.schedule_circuit.md index c4adddcabfa..4253a0b99b8 100644 --- a/docs/api/qiskit/0.33/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.33/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | --------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, …]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.35/_toc.json b/docs/api/qiskit/0.35/_toc.json index 25abf8d1c57..9f6545ba5c8 100644 --- a/docs/api/qiskit/0.35/_toc.json +++ b/docs/api/qiskit/0.35/_toc.json @@ -12,14 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.35/algorithms" }, - { - "title": "AbsoluteAverage", - "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.AbsoluteAverage" - }, - { - "title": "ADAM", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.ADAM" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.35/qiskit.algorithms.AlgorithmError" @@ -48,34 +40,6 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.35/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.35/qiskit.algorithms.Eigensolver" @@ -84,10 +48,6 @@ "title": "EigensolverResult", "url": "/api/qiskit/0.35/qiskit.algorithms.EigensolverResult" }, - { - "title": "ESCH", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.ESCH" - }, { "title": "EstimationProblem", "url": "/api/qiskit/0.35/qiskit.algorithms.EstimationProblem" @@ -104,10 +64,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.35/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.GradientDescent" - }, { "title": "Grover", "url": "/api/qiskit/0.35/qiskit.algorithms.Grover" @@ -116,10 +72,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.35/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -128,18 +80,6 @@ "title": "HamiltonianPhaseEstimationResult", "url": "/api/qiskit/0.35/qiskit.algorithms.HamiltonianPhaseEstimationResult" }, - { - "title": "HHL", - "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.HHL" - }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.35/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -152,30 +92,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.35/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.L_BFGS_B" - }, - { - "title": "LinearSolver", - "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolver" - }, - { - "title": "LinearSolverResult", - "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolverResult" - }, - { - "title": "LinearSystemMatrix", - "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemMatrix" - }, - { - "title": "LinearSystemObservable", - "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemObservable" - }, - { - "title": "MatrixFunctional", - "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.MatrixFunctional" - }, { "title": "MaximumLikelihoodAmplitudeEstimation", "url": "/api/qiskit/0.35/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation" @@ -192,46 +108,14 @@ "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.35/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.35/qiskit.algorithms.NumPyEigensolver" }, - { - "title": "NumPyLinearSolver", - "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyLinearSolver" - }, - { - "title": "NumPyMatrix", - "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyMatrix" - }, { "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.35/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerResult", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerResult" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.P_BFGS" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.35/qiskit.algorithms.PhaseEstimation" @@ -244,22 +128,10 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.35/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.POWELL" - }, { "title": "QAOA", "url": "/api/qiskit/0.35/qiskit.algorithms.QAOA" }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.QNSPSA" - }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "Shor", "url": "/api/qiskit/0.35/qiskit.algorithms.Shor" @@ -269,28 +141,178 @@ "url": "/api/qiskit/0.35/qiskit.algorithms.ShorResult" }, { - "title": "SLSQP", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "TNC", - "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.TNC" + "title": "VQE", + "url": "/api/qiskit/0.35/qiskit.algorithms.VQE" }, { - "title": "TridiagonalToeplitz", - "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" + "title": "qiskit.algorithms.linear_solvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers" + }, + { + "title": "AbsoluteAverage", + "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.AbsoluteAverage" + }, + { + "title": "HHL", + "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.HHL" + }, + { + "title": "LinearSolver", + "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolver" + }, + { + "title": "LinearSolverResult", + "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSolverResult" + }, + { + "title": "LinearSystemMatrix", + "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemMatrix" + }, + { + "title": "LinearSystemObservable", + "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.LinearSystemObservable" + }, + { + "title": "MatrixFunctional", + "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.MatrixFunctional" + }, + { + "title": "NumPyLinearSolver", + "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyLinearSolver" + }, + { + "title": "NumPyMatrix", + "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.NumPyMatrix" + }, + { + "title": "TridiagonalToeplitz", + "url": "/api/qiskit/0.35/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" + } + ] }, { - "title": "VQE", - "url": "/api/qiskit/0.35/qiskit.algorithms.VQE" + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerResult", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerResult" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "qiskit.algorithms.optimizers.nlopts", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.nlopts" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.35/qiskit.algorithms.optimizers.TNC" + } + ] } ] }, @@ -334,10 +356,6 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.35/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.35/qiskit.circuit.library.AND" - }, { "title": "Barrier", "url": "/api/qiskit/0.35/qiskit.circuit.Barrier" @@ -346,30 +364,6 @@ "title": "BreakLoopOp", "url": "/api/qiskit/0.35/qiskit.circuit.BreakLoopOp" }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CCXGate" - }, - { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CDKMRippleCarryAdder" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.35/qiskit.circuit.ClassicalRegister" @@ -378,78 +372,6 @@ "title": "Clbit", "url": "/api/qiskit/0.35/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_8_3" - }, { "title": "ContinueLoopOp", "url": "/api/qiskit/0.35/qiskit.circuit.ContinueLoopOp" @@ -463,715 +385,824 @@ "url": "/api/qiskit/0.35/qiskit.circuit.ControlledGate" }, { - "title": "CPhaseGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CSwapGate" + "title": "Delay", + "url": "/api/qiskit/0.35/qiskit.circuit.Delay" }, { - "title": "CSXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CSXGate" + "title": "EquivalenceLibrary", + "url": "/api/qiskit/0.35/qiskit.circuit.EquivalenceLibrary" }, { - "title": "CU1Gate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CU1Gate" + "title": "ForLoopOp", + "url": "/api/qiskit/0.35/qiskit.circuit.ForLoopOp" }, { - "title": "CU3Gate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CU3Gate" + "title": "Gate", + "url": "/api/qiskit/0.35/qiskit.circuit.Gate" }, { - "title": "CUGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CUGate" + "title": "IfElseOp", + "url": "/api/qiskit/0.35/qiskit.circuit.IfElseOp" }, { - "title": "CXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CXGate" + "title": "Instruction", + "url": "/api/qiskit/0.35/qiskit.circuit.Instruction" }, { - "title": "CYGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CYGate" + "title": "InstructionSet", + "url": "/api/qiskit/0.35/qiskit.circuit.InstructionSet" }, { - "title": "CZGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.CZGate" + "title": "Measure", + "url": "/api/qiskit/0.35/qiskit.circuit.Measure" }, { - "title": "DCXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.DCXGate" + "title": "Parameter", + "url": "/api/qiskit/0.35/qiskit.circuit.Parameter" }, { - "title": "Delay", - "url": "/api/qiskit/0.35/qiskit.circuit.Delay" + "title": "ParameterExpression", + "url": "/api/qiskit/0.35/qiskit.circuit.ParameterExpression" }, { - "title": "Diagonal", - "url": "/api/qiskit/0.35/qiskit.circuit.library.Diagonal" + "title": "ParameterVector", + "url": "/api/qiskit/0.35/qiskit.circuit.ParameterVector" }, { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.35/qiskit.circuit.library.DraperQFTAdder" + "title": "QuantumCircuit", + "url": "/api/qiskit/0.35/qiskit.circuit.QuantumCircuit" }, { - "title": "ECRGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.ECRGate" + "title": "QuantumRegister", + "url": "/api/qiskit/0.35/qiskit.circuit.QuantumRegister" }, { - "title": "EfficientSU2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.EfficientSU2" + "title": "Qubit", + "url": "/api/qiskit/0.35/qiskit.circuit.Qubit" }, { - "title": "EquivalenceLibrary", - "url": "/api/qiskit/0.35/qiskit.circuit.EquivalenceLibrary" + "title": "random_circuit", + "url": "/api/qiskit/0.35/qiskit.circuit.random.random_circuit" }, { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.35/qiskit.circuit.library.EvolvedOperatorAnsatz" + "title": "Reset", + "url": "/api/qiskit/0.35/qiskit.circuit.Reset" }, { - "title": "ExactReciprocal", - "url": "/api/qiskit/0.35/qiskit.circuit.library.ExactReciprocal" + "title": "WhileLoopOp", + "url": "/api/qiskit/0.35/qiskit.circuit.WhileLoopOp" }, { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.35/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "ForLoopOp", - "url": "/api/qiskit/0.35/qiskit.circuit.ForLoopOp" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.35/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.35/qiskit.circuit.library.FunctionalPauliRotations" - }, - { - "title": "Gate", - "url": "/api/qiskit/0.35/qiskit.circuit.Gate" - }, - { - "title": "GMS", - "url": "/api/qiskit/0.35/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.35/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.35/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.35/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.35/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.35/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.35/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.35/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.35/qiskit.circuit.library.HRSCumulativeMultiplier" - }, - { - "title": "IfElseOp", - "url": "/api/qiskit/0.35/qiskit.circuit.IfElseOp" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.35/qiskit.circuit.library.InnerProduct" - }, - { - "title": "Instruction", - "url": "/api/qiskit/0.35/qiskit.circuit.Instruction" - }, - { - "title": "InstructionSet", - "url": "/api/qiskit/0.35/qiskit.circuit.InstructionSet" - }, - { - "title": "IntegerComparator", - "url": "/api/qiskit/0.35/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.35/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.35/qiskit.circuit.library.LinearAmplitudeFunction" - }, - { - "title": "LinearFunction", - "url": "/api/qiskit/0.35/qiskit.circuit.library.LinearFunction" - }, - { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.35/qiskit.circuit.library.LinearPauliRotations" - }, - { - "title": "MCMT", - "url": "/api/qiskit/0.35/qiskit.circuit.library.MCMT" - }, - { - "title": "MCMTVChain", - "url": "/api/qiskit/0.35/qiskit.circuit.library.MCMTVChain" - }, - { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.MCPhaseGate" - }, - { - "title": "MCXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.MCXGate" - }, - { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.35/qiskit.circuit.library.MCXGrayCode" - }, - { - "title": "MCXRecursive", - "url": "/api/qiskit/0.35/qiskit.circuit.library.MCXRecursive" - }, - { - "title": "MCXVChain", - "url": "/api/qiskit/0.35/qiskit.circuit.library.MCXVChain" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.35/qiskit.circuit.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.35/qiskit.circuit.library.NLocal" - }, - { - "title": "OR", - "url": "/api/qiskit/0.35/qiskit.circuit.library.OR" - }, - { - "title": "Parameter", - "url": "/api/qiskit/0.35/qiskit.circuit.Parameter" - }, - { - "title": "ParameterExpression", - "url": "/api/qiskit/0.35/qiskit.circuit.ParameterExpression" - }, - { - "title": "ParameterVector", - "url": "/api/qiskit/0.35/qiskit.circuit.ParameterVector" - }, - { - "title": "PauliEvolutionGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.PauliEvolutionGate" - }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.35/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.35/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.35/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.35/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.35/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.35/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.35/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.35/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.35/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.35/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.35/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.35/qiskit.circuit.library.QuadraticForm" - }, - { - "title": "QuantumCircuit", - "url": "/api/qiskit/0.35/qiskit.circuit.QuantumCircuit" - }, - { - "title": "QuantumRegister", - "url": "/api/qiskit/0.35/qiskit.circuit.QuantumRegister" - }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.35/qiskit.circuit.library.QuantumVolume" - }, - { - "title": "Qubit", - "url": "/api/qiskit/0.35/qiskit.circuit.Qubit" - }, - { - "title": "random_circuit", - "url": "/api/qiskit/0.35/qiskit.circuit.random.random_circuit" - }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RealAmplitudes" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.35/qiskit.circuit.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.SGate" - }, - { - "title": "StatePreparation", - "url": "/api/qiskit/0.35/qiskit.circuit.library.StatePreparation" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_4" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.35/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.35/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.35/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.UGate" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.35/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.35/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "WhileLoopOp", - "url": "/api/qiskit/0.35/qiskit.circuit.WhileLoopOp" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.35/qiskit.circuit.library.XOR" - }, - { - "title": "XXMinusYYGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.XXMinusYYGate" - }, - { - "title": "XXPlusYYGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.XXPlusYYGate" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.35/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.35/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.35/qiskit.circuit.library.ZZFeatureMap" - }, - { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.35/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.35/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.35/qiskit.circuit.library.AND" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.35/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.35/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.35/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.35/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExactReciprocal", + "url": "/api/qiskit/0.35/qiskit.circuit.library.ExactReciprocal" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.35/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.35/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.35/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.35/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.35/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.35/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.35/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.35/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.35/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.35/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.35/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.35/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.35/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.35/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.35/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.35/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearFunction", + "url": "/api/qiskit/0.35/qiskit.circuit.library.LinearFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.35/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.35/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.35/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.35/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.35/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.35/qiskit.circuit.library.MCXVChain" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.35/qiskit.circuit.library.NLocal" + }, + { + "title": "OR", + "url": "/api/qiskit/0.35/qiskit.circuit.library.OR" + }, + { + "title": "PauliEvolutionGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.PauliEvolutionGate" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.35/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.35/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.35/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.35/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.35/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.35/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.35/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.35/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.35/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.35/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.35/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.35/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.35/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.35/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.SGate" + }, + { + "title": "StatePreparation", + "url": "/api/qiskit/0.35/qiskit.circuit.library.StatePreparation" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.35/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.35/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.U2Gate" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.35/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "U3Gate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.U3Gate" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "UGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.UGate" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.35/qiskit.circuit.library.VBERippleCarryAdder" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.35/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "WeightedAdder", + "url": "/api/qiskit/0.35/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.35/qiskit.circuit.library.XOR" + }, + { + "title": "XXMinusYYGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.XXMinusYYGate" + }, + { + "title": "XXPlusYYGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.XXPlusYYGate" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.35/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.35/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.35/qiskit.circuit.library.ZZFeatureMap" } ] } @@ -1679,6 +1710,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.35/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.35/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.35/qiskit.ignis.verification.QOTP" @@ -1742,225 +1777,288 @@ "title": "Overview", "url": "/api/qiskit/0.35/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.35/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.35/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.35/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.35/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.35/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.35/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.35/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.35/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.35/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.35/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.35/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.35/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.35/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.35/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.35/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.35/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.35/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.35/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.35/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.35/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.35/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.35/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.35/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.35/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.35/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.35/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.35/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.35/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.35/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.35/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.35/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.35/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.35/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.35/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.35/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.35/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.35/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.35/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.35/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.35/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.35/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.35/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.35/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.35/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.35/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.35/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.35/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.35/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.35/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.35/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.35/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.35/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.35/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.35/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.35/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.35/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.35/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.35/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.35/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.35/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.35/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.35/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.35/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3130,6 +3228,10 @@ "title": "Play", "url": "/api/qiskit/0.35/qiskit.pulse.instructions.Play" }, + { + "title": "qiskit.pulse.library.discrete", + "url": "/api/qiskit/0.35/qiskit.pulse.library.discrete" + }, { "title": "qubit_channels", "url": "/api/qiskit/0.35/qiskit.pulse.builder.qubit_channels" @@ -3641,6 +3743,14 @@ "title": "Overview", "url": "/api/qiskit/0.35/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.35/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.35/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.35/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.35/circuit_library.md b/docs/api/qiskit/0.35/circuit_library.md index 607b0695f85..80dda612d81 100644 --- a/docs/api/qiskit/0.35/circuit_library.md +++ b/docs/api/qiskit/0.35/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -285,3 +297,4 @@ | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.md b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.md index 67c30435992..c48fe803e91 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.linear_solvers.md @@ -1,16 +1,28 @@ +--- +title: linear_solvers +description: API reference for qiskit.algorithms.linear_solvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.linear_solvers +--- + # qiskit.algorithms.linear\_solvers -## Linear solvers ([`qiskit.algorithms.linear_solvers`](#module-qiskit.algorithms.linear_solvers "qiskit.algorithms.linear_solvers")) +## Linear solvers + + + +`qiskit.algorithms.linear_solvers` It contains classical and quantum algorithms to solve systems of linear equations such as `HHL`. Although the quantum algorithm accepts a general Hermitian matrix as input, Qiskit’s default Hamiltonian evolution is exponential in such cases and therefore the quantum linear solver will not achieve an exponential speedup. Furthermore, the quantum algorithm can find a solution exponentially faster in the size of the system than their classical counterparts (i.e. logarithmic complexity instead of polynomial), meaning that reading the full solution vector would kill such speedup (since this would take linear time in the size of the system). Therefore, to achieve an exponential speedup we can only compute functions from the solution vector (the so called observables) to learn information about the solution. Known efficient implementations of Hamiltonian evolutions or observables are contained in the following subfolders: -## [Matrices](#matrices) +**[Matrices](#matrices)** A placeholder for efficient implementations of the Hamiltonian evolution of particular types of matrices. -## [Observables](#observables) +**[Observables](#observables)** A placeholder for efficient implementations of functions that can be computed from the solution vector to a system of linear equations. @@ -38,3 +50,4 @@ A placeholder for efficient implementations of functions that can be computed fr | [`LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.LinearSystemObservable")() | An abstract class for linear system observables in Qiskit. | | [`AbsoluteAverage`](qiskit.algorithms.linear_solvers.AbsoluteAverage "qiskit.algorithms.linear_solvers.AbsoluteAverage")() | An observable for the absolute average of a linear system of equations solution. | | [`MatrixFunctional`](qiskit.algorithms.linear_solvers.MatrixFunctional "qiskit.algorithms.linear_solvers.MatrixFunctional")(main\_diag, off\_diag) | A class for the matrix functional of the vector solution to the linear systems. | + diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.md index e3b583eea1f..52d3e642205 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -68,3 +80,4 @@ The global optimizers are as follows: | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.nlopts.md b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.nlopts.md index f7fb470a11e..b430ce1d9d8 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.nlopts.md +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.nlopts.md @@ -1,3 +1,11 @@ +--- +title: nlopts +description: API reference for qiskit.algorithms.optimizers.nlopts +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.nlopts +--- + # qiskit.algorithms.optimizers.nlopts @@ -26,3 +34,4 @@ export PYTHONPATH=/usr/local/lib/python3.6/site-packages:${PYTHONPATH} ``` The two `export` commands above can be pasted into the `.bash_profile` file in the user’s home directory for automatic execution. Now you can run Qiskit and these optimizers should be available for you to use. + diff --git a/docs/api/qiskit/0.35/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.35/qiskit.ignis.verification.basis.md index e26610b6708..c7c0137e9f8 100644 --- a/docs/api/qiskit/0.35/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.35/qiskit.ignis.verification.basis.md @@ -1,5 +1,14 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # qiskit.ignis.verification.basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.35/qiskit.opflow.converters.md b/docs/api/qiskit/0.35/qiskit.opflow.converters.md index de1cf2608c0..dd5860cb4b8 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, …]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, …]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.md index c1fbc4558e7..35e46f5058d 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.35/qiskit.opflow.expectations.md b/docs/api/qiskit/0.35/qiskit.opflow.expectations.md index 5f7f2c40cb7..9c99521085d 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.35/qiskit.opflow.gradients.md b/docs/api/qiskit/0.35/qiskit.opflow.gradients.md index d47fd11d45b..d19fdc725a5 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, …]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.md index 52e0dc2c824..d0d1b25a032 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.md index 901891dfed3..396a648f364 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.md index be5505d8a1f..ada961c9425 100644 --- a/docs/api/qiskit/0.35/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.35/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, …]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, …]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.35/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.35/qiskit.pulse.library.discrete.md index 221122be547..efaf843a0aa 100644 --- a/docs/api/qiskit/0.35/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.35/qiskit.pulse.library.discrete.md @@ -1,3 +1,11 @@ +--- +title: discrete +description: API reference for qiskit.pulse.library.discrete +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library.discrete +--- + # qiskit.pulse.library.discrete @@ -23,3 +31,4 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. | `square`(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | | `triangle`(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | | `zero`(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | + diff --git a/docs/api/qiskit/0.35/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.35/qiskit.scheduler.methods.basic.md index a608dbeaf19..9761d8632a5 100644 --- a/docs/api/qiskit/0.35/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.35/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.35/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.35/qiskit.scheduler.schedule_circuit.md index c4adddcabfa..4253a0b99b8 100644 --- a/docs/api/qiskit/0.35/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.35/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | --------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, …]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.36/_toc.json b/docs/api/qiskit/0.36/_toc.json index 3685cc88c49..b70b0750720 100644 --- a/docs/api/qiskit/0.36/_toc.json +++ b/docs/api/qiskit/0.36/_toc.json @@ -12,14 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.36/algorithms" }, - { - "title": "AbsoluteAverage", - "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.AbsoluteAverage" - }, - { - "title": "ADAM", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.ADAM" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.36/qiskit.algorithms.AlgorithmError" @@ -48,34 +40,6 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.36/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.36/qiskit.algorithms.Eigensolver" @@ -84,10 +48,6 @@ "title": "EigensolverResult", "url": "/api/qiskit/0.36/qiskit.algorithms.EigensolverResult" }, - { - "title": "ESCH", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.ESCH" - }, { "title": "EstimationProblem", "url": "/api/qiskit/0.36/qiskit.algorithms.EstimationProblem" @@ -104,10 +64,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.36/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.GradientDescent" - }, { "title": "Grover", "url": "/api/qiskit/0.36/qiskit.algorithms.Grover" @@ -116,10 +72,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.36/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -128,18 +80,6 @@ "title": "HamiltonianPhaseEstimationResult", "url": "/api/qiskit/0.36/qiskit.algorithms.HamiltonianPhaseEstimationResult" }, - { - "title": "HHL", - "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.HHL" - }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.36/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -152,30 +92,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.36/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.L_BFGS_B" - }, - { - "title": "LinearSolver", - "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolver" - }, - { - "title": "LinearSolverResult", - "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolverResult" - }, - { - "title": "LinearSystemMatrix", - "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemMatrix" - }, - { - "title": "LinearSystemObservable", - "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemObservable" - }, - { - "title": "MatrixFunctional", - "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.MatrixFunctional" - }, { "title": "MaximumLikelihoodAmplitudeEstimation", "url": "/api/qiskit/0.36/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation" @@ -192,46 +108,14 @@ "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.36/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.36/qiskit.algorithms.NumPyEigensolver" }, - { - "title": "NumPyLinearSolver", - "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyLinearSolver" - }, - { - "title": "NumPyMatrix", - "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyMatrix" - }, { "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.36/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerResult", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerResult" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.P_BFGS" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.36/qiskit.algorithms.PhaseEstimation" @@ -244,22 +128,10 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.36/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.POWELL" - }, { "title": "QAOA", "url": "/api/qiskit/0.36/qiskit.algorithms.QAOA" }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.QNSPSA" - }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "Shor", "url": "/api/qiskit/0.36/qiskit.algorithms.Shor" @@ -269,28 +141,178 @@ "url": "/api/qiskit/0.36/qiskit.algorithms.ShorResult" }, { - "title": "SLSQP", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "TNC", - "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.TNC" + "title": "VQE", + "url": "/api/qiskit/0.36/qiskit.algorithms.VQE" }, { - "title": "TridiagonalToeplitz", - "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" + "title": "qiskit.algorithms.linear_solvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers" + }, + { + "title": "AbsoluteAverage", + "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.AbsoluteAverage" + }, + { + "title": "HHL", + "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.HHL" + }, + { + "title": "LinearSolver", + "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolver" + }, + { + "title": "LinearSolverResult", + "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSolverResult" + }, + { + "title": "LinearSystemMatrix", + "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemMatrix" + }, + { + "title": "LinearSystemObservable", + "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.LinearSystemObservable" + }, + { + "title": "MatrixFunctional", + "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.MatrixFunctional" + }, + { + "title": "NumPyLinearSolver", + "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyLinearSolver" + }, + { + "title": "NumPyMatrix", + "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.NumPyMatrix" + }, + { + "title": "TridiagonalToeplitz", + "url": "/api/qiskit/0.36/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" + } + ] }, { - "title": "VQE", - "url": "/api/qiskit/0.36/qiskit.algorithms.VQE" + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerResult", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerResult" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "qiskit.algorithms.optimizers.nlopts", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.nlopts" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.36/qiskit.algorithms.optimizers.TNC" + } + ] } ] }, @@ -334,10 +356,6 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.36/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.36/qiskit.circuit.library.AND" - }, { "title": "Barrier", "url": "/api/qiskit/0.36/qiskit.circuit.Barrier" @@ -346,30 +364,6 @@ "title": "BreakLoopOp", "url": "/api/qiskit/0.36/qiskit.circuit.BreakLoopOp" }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CCXGate" - }, - { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CDKMRippleCarryAdder" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CHGate" - }, { "title": "ClassicalRegister", "url": "/api/qiskit/0.36/qiskit.circuit.ClassicalRegister" @@ -378,78 +372,6 @@ "title": "Clbit", "url": "/api/qiskit/0.36/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_8_3" - }, { "title": "ContinueLoopOp", "url": "/api/qiskit/0.36/qiskit.circuit.ContinueLoopOp" @@ -463,715 +385,824 @@ "url": "/api/qiskit/0.36/qiskit.circuit.ControlledGate" }, { - "title": "CPhaseGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CSwapGate" + "title": "Delay", + "url": "/api/qiskit/0.36/qiskit.circuit.Delay" }, { - "title": "CSXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CSXGate" + "title": "EquivalenceLibrary", + "url": "/api/qiskit/0.36/qiskit.circuit.EquivalenceLibrary" }, { - "title": "CU1Gate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CU1Gate" + "title": "ForLoopOp", + "url": "/api/qiskit/0.36/qiskit.circuit.ForLoopOp" }, { - "title": "CU3Gate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CU3Gate" + "title": "Gate", + "url": "/api/qiskit/0.36/qiskit.circuit.Gate" }, { - "title": "CUGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CUGate" + "title": "IfElseOp", + "url": "/api/qiskit/0.36/qiskit.circuit.IfElseOp" }, { - "title": "CXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CXGate" + "title": "Instruction", + "url": "/api/qiskit/0.36/qiskit.circuit.Instruction" }, { - "title": "CYGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CYGate" + "title": "InstructionSet", + "url": "/api/qiskit/0.36/qiskit.circuit.InstructionSet" }, { - "title": "CZGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.CZGate" + "title": "Measure", + "url": "/api/qiskit/0.36/qiskit.circuit.Measure" }, { - "title": "DCXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.DCXGate" + "title": "Parameter", + "url": "/api/qiskit/0.36/qiskit.circuit.Parameter" }, { - "title": "Delay", - "url": "/api/qiskit/0.36/qiskit.circuit.Delay" + "title": "ParameterExpression", + "url": "/api/qiskit/0.36/qiskit.circuit.ParameterExpression" }, { - "title": "Diagonal", - "url": "/api/qiskit/0.36/qiskit.circuit.library.Diagonal" + "title": "ParameterVector", + "url": "/api/qiskit/0.36/qiskit.circuit.ParameterVector" }, { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.36/qiskit.circuit.library.DraperQFTAdder" + "title": "QuantumCircuit", + "url": "/api/qiskit/0.36/qiskit.circuit.QuantumCircuit" }, { - "title": "ECRGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.ECRGate" + "title": "QuantumRegister", + "url": "/api/qiskit/0.36/qiskit.circuit.QuantumRegister" }, { - "title": "EfficientSU2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.EfficientSU2" + "title": "Qubit", + "url": "/api/qiskit/0.36/qiskit.circuit.Qubit" }, { - "title": "EquivalenceLibrary", - "url": "/api/qiskit/0.36/qiskit.circuit.EquivalenceLibrary" + "title": "random_circuit", + "url": "/api/qiskit/0.36/qiskit.circuit.random.random_circuit" }, { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.36/qiskit.circuit.library.EvolvedOperatorAnsatz" + "title": "Reset", + "url": "/api/qiskit/0.36/qiskit.circuit.Reset" }, { - "title": "ExactReciprocal", - "url": "/api/qiskit/0.36/qiskit.circuit.library.ExactReciprocal" + "title": "WhileLoopOp", + "url": "/api/qiskit/0.36/qiskit.circuit.WhileLoopOp" }, { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.36/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "ForLoopOp", - "url": "/api/qiskit/0.36/qiskit.circuit.ForLoopOp" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.36/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.36/qiskit.circuit.library.FunctionalPauliRotations" - }, - { - "title": "Gate", - "url": "/api/qiskit/0.36/qiskit.circuit.Gate" - }, - { - "title": "GMS", - "url": "/api/qiskit/0.36/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.36/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.36/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.36/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.36/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.36/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.36/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.36/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.36/qiskit.circuit.library.HRSCumulativeMultiplier" - }, - { - "title": "IfElseOp", - "url": "/api/qiskit/0.36/qiskit.circuit.IfElseOp" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.36/qiskit.circuit.library.InnerProduct" - }, - { - "title": "Instruction", - "url": "/api/qiskit/0.36/qiskit.circuit.Instruction" - }, - { - "title": "InstructionSet", - "url": "/api/qiskit/0.36/qiskit.circuit.InstructionSet" - }, - { - "title": "IntegerComparator", - "url": "/api/qiskit/0.36/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.36/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.36/qiskit.circuit.library.LinearAmplitudeFunction" - }, - { - "title": "LinearFunction", - "url": "/api/qiskit/0.36/qiskit.circuit.library.LinearFunction" - }, - { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.36/qiskit.circuit.library.LinearPauliRotations" - }, - { - "title": "MCMT", - "url": "/api/qiskit/0.36/qiskit.circuit.library.MCMT" - }, - { - "title": "MCMTVChain", - "url": "/api/qiskit/0.36/qiskit.circuit.library.MCMTVChain" - }, - { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.MCPhaseGate" - }, - { - "title": "MCXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.MCXGate" - }, - { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.36/qiskit.circuit.library.MCXGrayCode" - }, - { - "title": "MCXRecursive", - "url": "/api/qiskit/0.36/qiskit.circuit.library.MCXRecursive" - }, - { - "title": "MCXVChain", - "url": "/api/qiskit/0.36/qiskit.circuit.library.MCXVChain" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.36/qiskit.circuit.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.36/qiskit.circuit.library.NLocal" - }, - { - "title": "OR", - "url": "/api/qiskit/0.36/qiskit.circuit.library.OR" - }, - { - "title": "Parameter", - "url": "/api/qiskit/0.36/qiskit.circuit.Parameter" - }, - { - "title": "ParameterExpression", - "url": "/api/qiskit/0.36/qiskit.circuit.ParameterExpression" - }, - { - "title": "ParameterVector", - "url": "/api/qiskit/0.36/qiskit.circuit.ParameterVector" - }, - { - "title": "PauliEvolutionGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.PauliEvolutionGate" - }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.36/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.36/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.36/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.36/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.36/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.36/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.36/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.36/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.36/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.36/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.36/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.36/qiskit.circuit.library.QuadraticForm" - }, - { - "title": "QuantumCircuit", - "url": "/api/qiskit/0.36/qiskit.circuit.QuantumCircuit" - }, - { - "title": "QuantumRegister", - "url": "/api/qiskit/0.36/qiskit.circuit.QuantumRegister" - }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.36/qiskit.circuit.library.QuantumVolume" - }, - { - "title": "Qubit", - "url": "/api/qiskit/0.36/qiskit.circuit.Qubit" - }, - { - "title": "random_circuit", - "url": "/api/qiskit/0.36/qiskit.circuit.random.random_circuit" - }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RealAmplitudes" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.36/qiskit.circuit.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.SGate" - }, - { - "title": "StatePreparation", - "url": "/api/qiskit/0.36/qiskit.circuit.library.StatePreparation" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_4" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.36/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.36/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.36/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.UGate" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.36/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.36/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "WhileLoopOp", - "url": "/api/qiskit/0.36/qiskit.circuit.WhileLoopOp" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.36/qiskit.circuit.library.XOR" - }, - { - "title": "XXMinusYYGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.XXMinusYYGate" - }, - { - "title": "XXPlusYYGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.XXPlusYYGate" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.36/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.36/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.36/qiskit.circuit.library.ZZFeatureMap" - }, - { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.36/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.36/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.36/qiskit.circuit.library.AND" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.36/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.36/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.36/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.36/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExactReciprocal", + "url": "/api/qiskit/0.36/qiskit.circuit.library.ExactReciprocal" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.36/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.36/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.36/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.36/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.36/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.36/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.36/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.36/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.36/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.36/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.36/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.36/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.36/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.36/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.36/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.36/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearFunction", + "url": "/api/qiskit/0.36/qiskit.circuit.library.LinearFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.36/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.36/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.36/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.36/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.36/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.36/qiskit.circuit.library.MCXVChain" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.36/qiskit.circuit.library.NLocal" + }, + { + "title": "OR", + "url": "/api/qiskit/0.36/qiskit.circuit.library.OR" + }, + { + "title": "PauliEvolutionGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.PauliEvolutionGate" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.36/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.36/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.36/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.36/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.36/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.36/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.36/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.36/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.36/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.36/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.36/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.36/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.36/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.36/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.SGate" + }, + { + "title": "StatePreparation", + "url": "/api/qiskit/0.36/qiskit.circuit.library.StatePreparation" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.36/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.36/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.U2Gate" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.36/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "U3Gate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.U3Gate" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "UGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.UGate" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.36/qiskit.circuit.library.VBERippleCarryAdder" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.36/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "WeightedAdder", + "url": "/api/qiskit/0.36/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.36/qiskit.circuit.library.XOR" + }, + { + "title": "XXMinusYYGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.XXMinusYYGate" + }, + { + "title": "XXPlusYYGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.XXPlusYYGate" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.36/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.36/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.36/qiskit.circuit.library.ZZFeatureMap" } ] } @@ -1679,6 +1710,10 @@ "title": "PurityRBFitter", "url": "/api/qiskit/0.36/qiskit.ignis.verification.PurityRBFitter" }, + { + "title": "qiskit.ignis.verification.basis", + "url": "/api/qiskit/0.36/qiskit.ignis.verification.basis" + }, { "title": "QOTP", "url": "/api/qiskit/0.36/qiskit.ignis.verification.QOTP" @@ -1742,225 +1777,288 @@ "title": "Overview", "url": "/api/qiskit/0.36/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.36/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.36/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.36/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.36/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.36/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.36/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.36/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.36/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.36/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.36/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.36/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.36/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.36/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.36/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.36/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.36/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.36/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.36/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.36/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.36/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.36/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.36/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.36/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.36/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.36/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.36/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.36/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.36/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.36/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.36/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.36/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.36/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.36/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.36/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.36/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.36/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.36/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.36/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.36/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.36/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.36/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.36/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.36/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.36/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.36/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.36/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.36/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.36/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.36/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.36/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.36/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.36/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.36/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.36/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.36/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.36/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.36/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.36/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.36/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.36/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.36/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.36/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.36/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3113,6 +3211,10 @@ "title": "Play", "url": "/api/qiskit/0.36/qiskit.pulse.instructions.Play" }, + { + "title": "qiskit.pulse.library.discrete", + "url": "/api/qiskit/0.36/qiskit.pulse.library.discrete" + }, { "title": "qubit_channels", "url": "/api/qiskit/0.36/qiskit.pulse.builder.qubit_channels" @@ -3624,6 +3726,14 @@ "title": "Overview", "url": "/api/qiskit/0.36/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.36/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.36/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.36/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.36/circuit_library.md b/docs/api/qiskit/0.36/circuit_library.md index 607b0695f85..80dda612d81 100644 --- a/docs/api/qiskit/0.36/circuit_library.md +++ b/docs/api/qiskit/0.36/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` ### Standard Gates @@ -285,3 +297,4 @@ | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.md b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.md index 67c30435992..c48fe803e91 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.linear_solvers.md @@ -1,16 +1,28 @@ +--- +title: linear_solvers +description: API reference for qiskit.algorithms.linear_solvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.linear_solvers +--- + # qiskit.algorithms.linear\_solvers -## Linear solvers ([`qiskit.algorithms.linear_solvers`](#module-qiskit.algorithms.linear_solvers "qiskit.algorithms.linear_solvers")) +## Linear solvers + + + +`qiskit.algorithms.linear_solvers` It contains classical and quantum algorithms to solve systems of linear equations such as `HHL`. Although the quantum algorithm accepts a general Hermitian matrix as input, Qiskit’s default Hamiltonian evolution is exponential in such cases and therefore the quantum linear solver will not achieve an exponential speedup. Furthermore, the quantum algorithm can find a solution exponentially faster in the size of the system than their classical counterparts (i.e. logarithmic complexity instead of polynomial), meaning that reading the full solution vector would kill such speedup (since this would take linear time in the size of the system). Therefore, to achieve an exponential speedup we can only compute functions from the solution vector (the so called observables) to learn information about the solution. Known efficient implementations of Hamiltonian evolutions or observables are contained in the following subfolders: -## [Matrices](#matrices) +**[Matrices](#matrices)** A placeholder for efficient implementations of the Hamiltonian evolution of particular types of matrices. -## [Observables](#observables) +**[Observables](#observables)** A placeholder for efficient implementations of functions that can be computed from the solution vector to a system of linear equations. @@ -38,3 +50,4 @@ A placeholder for efficient implementations of functions that can be computed fr | [`LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.LinearSystemObservable")() | An abstract class for linear system observables in Qiskit. | | [`AbsoluteAverage`](qiskit.algorithms.linear_solvers.AbsoluteAverage "qiskit.algorithms.linear_solvers.AbsoluteAverage")() | An observable for the absolute average of a linear system of equations solution. | | [`MatrixFunctional`](qiskit.algorithms.linear_solvers.MatrixFunctional "qiskit.algorithms.linear_solvers.MatrixFunctional")(main\_diag, off\_diag) | A class for the matrix functional of the vector solution to the linear systems. | + diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.md index e3b583eea1f..52d3e642205 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -68,3 +80,4 @@ The global optimizers are as follows: | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.nlopts.md b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.nlopts.md index f7fb470a11e..b430ce1d9d8 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.nlopts.md +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.nlopts.md @@ -1,3 +1,11 @@ +--- +title: nlopts +description: API reference for qiskit.algorithms.optimizers.nlopts +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.nlopts +--- + # qiskit.algorithms.optimizers.nlopts @@ -26,3 +34,4 @@ export PYTHONPATH=/usr/local/lib/python3.6/site-packages:${PYTHONPATH} ``` The two `export` commands above can be pasted into the `.bash_profile` file in the user’s home directory for automatic execution. Now you can run Qiskit and these optimizers should be available for you to use. + diff --git a/docs/api/qiskit/0.36/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.36/qiskit.ignis.verification.basis.md index e26610b6708..c7c0137e9f8 100644 --- a/docs/api/qiskit/0.36/qiskit.ignis.verification.basis.md +++ b/docs/api/qiskit/0.36/qiskit.ignis.verification.basis.md @@ -1,5 +1,14 @@ +--- +title: basis +description: API reference for qiskit.ignis.verification.basis +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.ignis.verification.basis +--- + # qiskit.ignis.verification.basis Quantum tomography basis + diff --git a/docs/api/qiskit/0.36/qiskit.opflow.converters.md b/docs/api/qiskit/0.36/qiskit.opflow.converters.md index de1cf2608c0..dd5860cb4b8 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, …]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, …]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.md index c1fbc4558e7..35e46f5058d 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.36/qiskit.opflow.expectations.md b/docs/api/qiskit/0.36/qiskit.opflow.expectations.md index 5f7f2c40cb7..9c99521085d 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.36/qiskit.opflow.gradients.md b/docs/api/qiskit/0.36/qiskit.opflow.gradients.md index d47fd11d45b..d19fdc725a5 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, …]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.md index 52e0dc2c824..d0d1b25a032 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.md index 901891dfed3..396a648f364 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.md index be5505d8a1f..ada961c9425 100644 --- a/docs/api/qiskit/0.36/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.36/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, …]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, …]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.36/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.36/qiskit.pulse.library.discrete.md index 221122be547..efaf843a0aa 100644 --- a/docs/api/qiskit/0.36/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.36/qiskit.pulse.library.discrete.md @@ -1,3 +1,11 @@ +--- +title: discrete +description: API reference for qiskit.pulse.library.discrete +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.pulse.library.discrete +--- + # qiskit.pulse.library.discrete @@ -23,3 +31,4 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. | `square`(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | | `triangle`(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | | `zero`(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | + diff --git a/docs/api/qiskit/0.36/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.36/qiskit.scheduler.methods.basic.md index a608dbeaf19..9761d8632a5 100644 --- a/docs/api/qiskit/0.36/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.36/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.36/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.36/qiskit.scheduler.schedule_circuit.md index c4adddcabfa..4253a0b99b8 100644 --- a/docs/api/qiskit/0.36/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.36/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | --------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, …]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.37/_toc.json b/docs/api/qiskit/0.37/_toc.json index 9d0ac4e45a5..fe548543602 100644 --- a/docs/api/qiskit/0.37/_toc.json +++ b/docs/api/qiskit/0.37/_toc.json @@ -12,14 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.37/algorithms" }, - { - "title": "AbsoluteAverage", - "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.AbsoluteAverage" - }, - { - "title": "ADAM", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.ADAM" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.37/qiskit.algorithms.AlgorithmError" @@ -48,34 +40,6 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.37/qiskit.algorithms.Eigensolver" @@ -84,10 +48,6 @@ "title": "EigensolverResult", "url": "/api/qiskit/0.37/qiskit.algorithms.EigensolverResult" }, - { - "title": "ESCH", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.ESCH" - }, { "title": "EstimationProblem", "url": "/api/qiskit/0.37/qiskit.algorithms.EstimationProblem" @@ -112,10 +72,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.37/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.GradientDescent" - }, { "title": "Grover", "url": "/api/qiskit/0.37/qiskit.algorithms.Grover" @@ -124,10 +80,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.37/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -136,22 +88,10 @@ "title": "HamiltonianPhaseEstimationResult", "url": "/api/qiskit/0.37/qiskit.algorithms.HamiltonianPhaseEstimationResult" }, - { - "title": "HHL", - "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.HHL" - }, { "title": "ImaginaryEvolver", "url": "/api/qiskit/0.37/qiskit.algorithms.ImaginaryEvolver" }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.37/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -164,30 +104,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.37/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.L_BFGS_B" - }, - { - "title": "LinearSolver", - "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolver" - }, - { - "title": "LinearSolverResult", - "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolverResult" - }, - { - "title": "LinearSystemMatrix", - "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemMatrix" - }, - { - "title": "LinearSystemObservable", - "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemObservable" - }, - { - "title": "MatrixFunctional", - "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.MatrixFunctional" - }, { "title": "MaximumLikelihoodAmplitudeEstimation", "url": "/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation" @@ -196,10 +112,6 @@ "title": "MaximumLikelihoodAmplitudeEstimationResult", "url": "/api/qiskit/0.37/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult" }, - { - "title": "Minimizer", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.Minimizer" - }, { "title": "MinimumEigensolver", "url": "/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolver" @@ -208,46 +120,14 @@ "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.37/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.37/qiskit.algorithms.NumPyEigensolver" }, - { - "title": "NumPyLinearSolver", - "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyLinearSolver" - }, - { - "title": "NumPyMatrix", - "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyMatrix" - }, { "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.37/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerResult", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerResult" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.P_BFGS" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.37/qiskit.algorithms.PhaseEstimation" @@ -260,26 +140,14 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.37/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.POWELL" - }, { "title": "QAOA", "url": "/api/qiskit/0.37/qiskit.algorithms.QAOA" }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.QNSPSA" - }, { "title": "RealEvolver", "url": "/api/qiskit/0.37/qiskit.algorithms.RealEvolver" }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "Shor", "url": "/api/qiskit/0.37/qiskit.algorithms.Shor" @@ -288,34 +156,10 @@ "title": "ShorResult", "url": "/api/qiskit/0.37/qiskit.algorithms.ShorResult" }, - { - "title": "SLSQP", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "TNC", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.TNC" - }, - { - "title": "TridiagonalToeplitz", - "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" - }, { "title": "TrotterQRTE", "url": "/api/qiskit/0.37/qiskit.algorithms.TrotterQRTE" }, - { - "title": "UMDA", - "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.UMDA" - }, { "title": "VQD", "url": "/api/qiskit/0.37/qiskit.algorithms.VQD" @@ -323,6 +167,184 @@ { "title": "VQE", "url": "/api/qiskit/0.37/qiskit.algorithms.VQE" + }, + { + "title": "qiskit.algorithms.linear_solvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers" + }, + { + "title": "AbsoluteAverage", + "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.AbsoluteAverage" + }, + { + "title": "HHL", + "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.HHL" + }, + { + "title": "LinearSolver", + "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolver" + }, + { + "title": "LinearSolverResult", + "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSolverResult" + }, + { + "title": "LinearSystemMatrix", + "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemMatrix" + }, + { + "title": "LinearSystemObservable", + "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.LinearSystemObservable" + }, + { + "title": "MatrixFunctional", + "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.MatrixFunctional" + }, + { + "title": "NumPyLinearSolver", + "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyLinearSolver" + }, + { + "title": "NumPyMatrix", + "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.NumPyMatrix" + }, + { + "title": "TridiagonalToeplitz", + "url": "/api/qiskit/0.37/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" + } + ] + }, + { + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "Minimizer", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.Minimizer" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerResult", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerResult" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "qiskit.algorithms.optimizers.nlopts", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.nlopts" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.TNC" + }, + { + "title": "UMDA", + "url": "/api/qiskit/0.37/qiskit.algorithms.optimizers.UMDA" + } + ] } ] }, @@ -366,42 +388,10 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.37/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.37/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.37/qiskit.circuit.library.Barrier" - }, { "title": "BreakLoopOp", "url": "/api/qiskit/0.37/qiskit.circuit.BreakLoopOp" }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CCXGate" - }, - { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CDKMRippleCarryAdder" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CHGate" - }, { "title": "CircuitInstruction", "url": "/api/qiskit/0.37/qiskit.circuit.CircuitInstruction" @@ -414,78 +404,6 @@ "title": "Clbit", "url": "/api/qiskit/0.37/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_8_3" - }, { "title": "ContinueLoopOp", "url": "/api/qiskit/0.37/qiskit.circuit.ContinueLoopOp" @@ -499,715 +417,828 @@ "url": "/api/qiskit/0.37/qiskit.circuit.ControlledGate" }, { - "title": "CPhaseGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CPhaseGate" + "title": "Delay", + "url": "/api/qiskit/0.37/qiskit.circuit.Delay" }, { - "title": "CRXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CRXGate" + "title": "EquivalenceLibrary", + "url": "/api/qiskit/0.37/qiskit.circuit.EquivalenceLibrary" }, { - "title": "CRYGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CRYGate" + "title": "ForLoopOp", + "url": "/api/qiskit/0.37/qiskit.circuit.ForLoopOp" }, { - "title": "CRZGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CRZGate" + "title": "Gate", + "url": "/api/qiskit/0.37/qiskit.circuit.Gate" }, { - "title": "CSwapGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CSwapGate" + "title": "IfElseOp", + "url": "/api/qiskit/0.37/qiskit.circuit.IfElseOp" }, { - "title": "CSXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CSXGate" + "title": "Instruction", + "url": "/api/qiskit/0.37/qiskit.circuit.Instruction" }, { - "title": "CU1Gate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CU1Gate" + "title": "InstructionSet", + "url": "/api/qiskit/0.37/qiskit.circuit.InstructionSet" }, { - "title": "CU3Gate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CU3Gate" + "title": "Parameter", + "url": "/api/qiskit/0.37/qiskit.circuit.Parameter" }, { - "title": "CUGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CUGate" + "title": "ParameterExpression", + "url": "/api/qiskit/0.37/qiskit.circuit.ParameterExpression" }, { - "title": "CXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CXGate" + "title": "ParameterVector", + "url": "/api/qiskit/0.37/qiskit.circuit.ParameterVector" }, { - "title": "CYGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CYGate" + "title": "QuantumCircuit", + "url": "/api/qiskit/0.37/qiskit.circuit.QuantumCircuit" }, { - "title": "CZGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.CZGate" + "title": "QuantumRegister", + "url": "/api/qiskit/0.37/qiskit.circuit.QuantumRegister" }, { - "title": "DCXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.DCXGate" + "title": "Qubit", + "url": "/api/qiskit/0.37/qiskit.circuit.Qubit" }, { - "title": "Delay", - "url": "/api/qiskit/0.37/qiskit.circuit.Delay" + "title": "random_circuit", + "url": "/api/qiskit/0.37/qiskit.circuit.random.random_circuit" }, { - "title": "Diagonal", - "url": "/api/qiskit/0.37/qiskit.circuit.library.Diagonal" + "title": "WhileLoopOp", + "url": "/api/qiskit/0.37/qiskit.circuit.WhileLoopOp" }, { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.37/qiskit.circuit.library.DraperQFTAdder" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.EfficientSU2" - }, - { - "title": "EquivalenceLibrary", - "url": "/api/qiskit/0.37/qiskit.circuit.EquivalenceLibrary" - }, - { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.37/qiskit.circuit.library.EvolvedOperatorAnsatz" - }, - { - "title": "ExactReciprocal", - "url": "/api/qiskit/0.37/qiskit.circuit.library.ExactReciprocal" - }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.37/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "ForLoopOp", - "url": "/api/qiskit/0.37/qiskit.circuit.ForLoopOp" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.37/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.37/qiskit.circuit.library.FunctionalPauliRotations" - }, - { - "title": "Gate", - "url": "/api/qiskit/0.37/qiskit.circuit.Gate" - }, - { - "title": "GMS", - "url": "/api/qiskit/0.37/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.37/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.37/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.37/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.37/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.37/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.37/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.37/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.37/qiskit.circuit.library.HRSCumulativeMultiplier" - }, - { - "title": "IfElseOp", - "url": "/api/qiskit/0.37/qiskit.circuit.IfElseOp" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.37/qiskit.circuit.library.InnerProduct" - }, - { - "title": "Instruction", - "url": "/api/qiskit/0.37/qiskit.circuit.Instruction" - }, - { - "title": "InstructionSet", - "url": "/api/qiskit/0.37/qiskit.circuit.InstructionSet" - }, - { - "title": "IntegerComparator", - "url": "/api/qiskit/0.37/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.37/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.37/qiskit.circuit.library.LinearAmplitudeFunction" - }, - { - "title": "LinearFunction", - "url": "/api/qiskit/0.37/qiskit.circuit.library.LinearFunction" - }, - { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.37/qiskit.circuit.library.LinearPauliRotations" - }, - { - "title": "MCMT", - "url": "/api/qiskit/0.37/qiskit.circuit.library.MCMT" - }, - { - "title": "MCMTVChain", - "url": "/api/qiskit/0.37/qiskit.circuit.library.MCMTVChain" - }, - { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.MCPhaseGate" - }, - { - "title": "MCXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.MCXGate" - }, - { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.37/qiskit.circuit.library.MCXGrayCode" - }, - { - "title": "MCXRecursive", - "url": "/api/qiskit/0.37/qiskit.circuit.library.MCXRecursive" - }, - { - "title": "MCXVChain", - "url": "/api/qiskit/0.37/qiskit.circuit.library.MCXVChain" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.37/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.37/qiskit.circuit.library.NLocal" - }, - { - "title": "OR", - "url": "/api/qiskit/0.37/qiskit.circuit.library.OR" - }, - { - "title": "Parameter", - "url": "/api/qiskit/0.37/qiskit.circuit.Parameter" - }, - { - "title": "ParameterExpression", - "url": "/api/qiskit/0.37/qiskit.circuit.ParameterExpression" - }, - { - "title": "ParameterVector", - "url": "/api/qiskit/0.37/qiskit.circuit.ParameterVector" - }, - { - "title": "PauliEvolutionGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.PauliEvolutionGate" - }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.37/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.37/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.37/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.37/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.37/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.37/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.37/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.37/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.37/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.37/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.37/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.37/qiskit.circuit.library.QuadraticForm" - }, - { - "title": "QuantumCircuit", - "url": "/api/qiskit/0.37/qiskit.circuit.QuantumCircuit" - }, - { - "title": "QuantumRegister", - "url": "/api/qiskit/0.37/qiskit.circuit.QuantumRegister" - }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.37/qiskit.circuit.library.QuantumVolume" - }, - { - "title": "Qubit", - "url": "/api/qiskit/0.37/qiskit.circuit.Qubit" - }, - { - "title": "random_circuit", - "url": "/api/qiskit/0.37/qiskit.circuit.random.random_circuit" - }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RealAmplitudes" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.37/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.SGate" - }, - { - "title": "StatePreparation", - "url": "/api/qiskit/0.37/qiskit.circuit.library.StatePreparation" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_3" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.37/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.37/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.37/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.UGate" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.37/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.37/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "WhileLoopOp", - "url": "/api/qiskit/0.37/qiskit.circuit.WhileLoopOp" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.37/qiskit.circuit.library.XOR" - }, - { - "title": "XXMinusYYGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.XXMinusYYGate" - }, - { - "title": "XXPlusYYGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.XXPlusYYGate" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.37/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.37/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.37/qiskit.circuit.library.ZZFeatureMap" - }, - { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.37/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.37/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.37/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.37/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.37/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.37/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.37/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.37/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExactReciprocal", + "url": "/api/qiskit/0.37/qiskit.circuit.library.ExactReciprocal" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.37/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.37/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.37/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.37/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.37/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.37/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.37/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.37/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.37/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.37/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.37/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.37/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.37/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.37/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.37/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.37/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearFunction", + "url": "/api/qiskit/0.37/qiskit.circuit.library.LinearFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.37/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.37/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.37/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.37/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.37/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.37/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.37/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.37/qiskit.circuit.library.NLocal" + }, + { + "title": "OR", + "url": "/api/qiskit/0.37/qiskit.circuit.library.OR" + }, + { + "title": "PauliEvolutionGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.PauliEvolutionGate" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.37/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.37/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.37/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.37/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.37/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.37/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.37/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.37/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.37/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.37/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.37/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.37/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.37/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.37/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.37/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.SGate" + }, + { + "title": "StatePreparation", + "url": "/api/qiskit/0.37/qiskit.circuit.library.StatePreparation" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.37/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.37/qiskit.circuit.library.TwoLocal" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.37/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "U1Gate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.U1Gate" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "U2Gate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.U2Gate" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "U3Gate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.U3Gate" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.37/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "UGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.UGate" + }, + { + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.37/qiskit.circuit.library.VBERippleCarryAdder" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.37/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.37/qiskit.circuit.library.XOR" + }, + { + "title": "XXMinusYYGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.XXMinusYYGate" + }, + { + "title": "XXPlusYYGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.XXPlusYYGate" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.37/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.37/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.37/qiskit.circuit.library.ZZFeatureMap" } ] } @@ -1380,225 +1411,288 @@ "title": "Overview", "url": "/api/qiskit/0.37/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.37/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.37/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.37/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.37/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.37/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.37/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.37/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.37/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.37/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.37/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.37/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.37/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.37/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.37/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.37/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.37/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.37/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.37/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.37/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.37/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.37/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.37/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.37/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.37/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.37/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.37/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.37/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.37/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.37/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.37/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.37/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.37/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.37/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.37/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.37/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.37/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.37/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.37/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.37/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.37/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.37/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.37/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.37/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.37/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.37/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.37/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.37/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.37/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.37/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.37/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.37/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.37/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.37/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.37/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.37/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.37/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.37/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.37/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.37/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.37/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.37/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.37/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.37/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3683,6 +3777,14 @@ "title": "Overview", "url": "/api/qiskit/0.37/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.37/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.37/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.37/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.37/circuit_library.md b/docs/api/qiskit/0.37/circuit_library.md index 65fa5c21a4d..87a0995fee6 100644 --- a/docs/api/qiskit/0.37/circuit_library.md +++ b/docs/api/qiskit/0.37/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` The circuit library is a collection of well-studied and valuable circuits, directives, and gates. We call them valuable for different reasons, for instance they can serve as building blocks for algorithms or they are circuits that we think are hard to simulate classically. @@ -385,3 +397,4 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.md b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.md index 67c30435992..c48fe803e91 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.linear_solvers.md @@ -1,16 +1,28 @@ +--- +title: linear_solvers +description: API reference for qiskit.algorithms.linear_solvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.linear_solvers +--- + # qiskit.algorithms.linear\_solvers -## Linear solvers ([`qiskit.algorithms.linear_solvers`](#module-qiskit.algorithms.linear_solvers "qiskit.algorithms.linear_solvers")) +## Linear solvers + + + +`qiskit.algorithms.linear_solvers` It contains classical and quantum algorithms to solve systems of linear equations such as `HHL`. Although the quantum algorithm accepts a general Hermitian matrix as input, Qiskit’s default Hamiltonian evolution is exponential in such cases and therefore the quantum linear solver will not achieve an exponential speedup. Furthermore, the quantum algorithm can find a solution exponentially faster in the size of the system than their classical counterparts (i.e. logarithmic complexity instead of polynomial), meaning that reading the full solution vector would kill such speedup (since this would take linear time in the size of the system). Therefore, to achieve an exponential speedup we can only compute functions from the solution vector (the so called observables) to learn information about the solution. Known efficient implementations of Hamiltonian evolutions or observables are contained in the following subfolders: -## [Matrices](#matrices) +**[Matrices](#matrices)** A placeholder for efficient implementations of the Hamiltonian evolution of particular types of matrices. -## [Observables](#observables) +**[Observables](#observables)** A placeholder for efficient implementations of functions that can be computed from the solution vector to a system of linear equations. @@ -38,3 +50,4 @@ A placeholder for efficient implementations of functions that can be computed fr | [`LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.LinearSystemObservable")() | An abstract class for linear system observables in Qiskit. | | [`AbsoluteAverage`](qiskit.algorithms.linear_solvers.AbsoluteAverage "qiskit.algorithms.linear_solvers.AbsoluteAverage")() | An observable for the absolute average of a linear system of equations solution. | | [`MatrixFunctional`](qiskit.algorithms.linear_solvers.MatrixFunctional "qiskit.algorithms.linear_solvers.MatrixFunctional")(main\_diag, off\_diag) | A class for the matrix functional of the vector solution to the linear systems. | + diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.md index 866de55e25a..e498d441b9e 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -70,3 +82,4 @@ The global optimizers are as follows: | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.nlopts.md b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.nlopts.md index f7fb470a11e..b430ce1d9d8 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.nlopts.md +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.nlopts.md @@ -1,3 +1,11 @@ +--- +title: nlopts +description: API reference for qiskit.algorithms.optimizers.nlopts +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.nlopts +--- + # qiskit.algorithms.optimizers.nlopts @@ -26,3 +34,4 @@ export PYTHONPATH=/usr/local/lib/python3.6/site-packages:${PYTHONPATH} ``` The two `export` commands above can be pasted into the `.bash_profile` file in the user’s home directory for automatic execution. Now you can run Qiskit and these optimizers should be available for you to use. + diff --git a/docs/api/qiskit/0.37/qiskit.opflow.converters.md b/docs/api/qiskit/0.37/qiskit.opflow.converters.md index 78c8d772f6c..fd81b2d76b6 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, ...]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, ...]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.md index 901c1a93987..56d09f9e3a1 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive "bookends" strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.37/qiskit.opflow.expectations.md b/docs/api/qiskit/0.37/qiskit.opflow.expectations.md index 40f57dfa261..df598260d9d 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.37/qiskit.opflow.gradients.md b/docs/api/qiskit/0.37/qiskit.opflow.gradients.md index e4558f4e2ea..af71ebe3bf7 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, ...]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.md index 71b2cd119a1..51994b092bd 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.md index 356f54afb31..49e0db5a490 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.md index 2ffffc20990..e374b0766ed 100644 --- a/docs/api/qiskit/0.37/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.37/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, ...]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, ...]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.37/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.37/qiskit.scheduler.methods.basic.md index 6d0ab513269..6bef8c60c54 100644 --- a/docs/api/qiskit/0.37/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.37/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as late as possible" (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as soon as possible" (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.37/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.37/qiskit.scheduler.schedule_circuit.md index a9e2086d690..36e4ab21f18 100644 --- a/docs/api/qiskit/0.37/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.37/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | ----------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, ...]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.38/_toc.json b/docs/api/qiskit/0.38/_toc.json index b861129ec9f..efcc5e8169d 100644 --- a/docs/api/qiskit/0.38/_toc.json +++ b/docs/api/qiskit/0.38/_toc.json @@ -12,14 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.38/algorithms" }, - { - "title": "AbsoluteAverage", - "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.AbsoluteAverage" - }, - { - "title": "ADAM", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.ADAM" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.38/qiskit.algorithms.AlgorithmError" @@ -48,34 +40,6 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.38/qiskit.algorithms.Eigensolver" @@ -84,10 +48,6 @@ "title": "EigensolverResult", "url": "/api/qiskit/0.38/qiskit.algorithms.EigensolverResult" }, - { - "title": "ESCH", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.ESCH" - }, { "title": "EstimationProblem", "url": "/api/qiskit/0.38/qiskit.algorithms.EstimationProblem" @@ -112,10 +72,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.38/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.GradientDescent" - }, { "title": "Grover", "url": "/api/qiskit/0.38/qiskit.algorithms.Grover" @@ -124,10 +80,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.38/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -136,22 +88,10 @@ "title": "HamiltonianPhaseEstimationResult", "url": "/api/qiskit/0.38/qiskit.algorithms.HamiltonianPhaseEstimationResult" }, - { - "title": "HHL", - "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.HHL" - }, { "title": "ImaginaryEvolver", "url": "/api/qiskit/0.38/qiskit.algorithms.ImaginaryEvolver" }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.38/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -164,30 +104,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.38/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.L_BFGS_B" - }, - { - "title": "LinearSolver", - "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolver" - }, - { - "title": "LinearSolverResult", - "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolverResult" - }, - { - "title": "LinearSystemMatrix", - "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemMatrix" - }, - { - "title": "LinearSystemObservable", - "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemObservable" - }, - { - "title": "MatrixFunctional", - "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.MatrixFunctional" - }, { "title": "MaximumLikelihoodAmplitudeEstimation", "url": "/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation" @@ -196,10 +112,6 @@ "title": "MaximumLikelihoodAmplitudeEstimationResult", "url": "/api/qiskit/0.38/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult" }, - { - "title": "Minimizer", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.Minimizer" - }, { "title": "MinimumEigensolver", "url": "/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolver" @@ -208,46 +120,14 @@ "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.38/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.38/qiskit.algorithms.NumPyEigensolver" }, - { - "title": "NumPyLinearSolver", - "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyLinearSolver" - }, - { - "title": "NumPyMatrix", - "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyMatrix" - }, { "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.38/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerResult", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerResult" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.P_BFGS" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.38/qiskit.algorithms.PhaseEstimation" @@ -260,26 +140,14 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.38/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.POWELL" - }, { "title": "QAOA", "url": "/api/qiskit/0.38/qiskit.algorithms.QAOA" }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.QNSPSA" - }, { "title": "RealEvolver", "url": "/api/qiskit/0.38/qiskit.algorithms.RealEvolver" }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "Shor", "url": "/api/qiskit/0.38/qiskit.algorithms.Shor" @@ -288,34 +156,10 @@ "title": "ShorResult", "url": "/api/qiskit/0.38/qiskit.algorithms.ShorResult" }, - { - "title": "SLSQP", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "TNC", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.TNC" - }, - { - "title": "TridiagonalToeplitz", - "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" - }, { "title": "TrotterQRTE", "url": "/api/qiskit/0.38/qiskit.algorithms.TrotterQRTE" }, - { - "title": "UMDA", - "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.UMDA" - }, { "title": "VQD", "url": "/api/qiskit/0.38/qiskit.algorithms.VQD" @@ -323,6 +167,184 @@ { "title": "VQE", "url": "/api/qiskit/0.38/qiskit.algorithms.VQE" + }, + { + "title": "qiskit.algorithms.linear_solvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers" + }, + { + "title": "AbsoluteAverage", + "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.AbsoluteAverage" + }, + { + "title": "HHL", + "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.HHL" + }, + { + "title": "LinearSolver", + "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolver" + }, + { + "title": "LinearSolverResult", + "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSolverResult" + }, + { + "title": "LinearSystemMatrix", + "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemMatrix" + }, + { + "title": "LinearSystemObservable", + "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.LinearSystemObservable" + }, + { + "title": "MatrixFunctional", + "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.MatrixFunctional" + }, + { + "title": "NumPyLinearSolver", + "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyLinearSolver" + }, + { + "title": "NumPyMatrix", + "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.NumPyMatrix" + }, + { + "title": "TridiagonalToeplitz", + "url": "/api/qiskit/0.38/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" + } + ] + }, + { + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "Minimizer", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.Minimizer" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerResult", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerResult" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "qiskit.algorithms.optimizers.nlopts", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.nlopts" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.TNC" + }, + { + "title": "UMDA", + "url": "/api/qiskit/0.38/qiskit.algorithms.optimizers.UMDA" + } + ] } ] }, @@ -366,42 +388,10 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.38/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.38/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.38/qiskit.circuit.library.Barrier" - }, { "title": "BreakLoopOp", "url": "/api/qiskit/0.38/qiskit.circuit.BreakLoopOp" }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CCXGate" - }, - { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CDKMRippleCarryAdder" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CHGate" - }, { "title": "CircuitInstruction", "url": "/api/qiskit/0.38/qiskit.circuit.CircuitInstruction" @@ -414,78 +404,6 @@ "title": "Clbit", "url": "/api/qiskit/0.38/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_8_3" - }, { "title": "ContinueLoopOp", "url": "/api/qiskit/0.38/qiskit.circuit.ContinueLoopOp" @@ -499,715 +417,828 @@ "url": "/api/qiskit/0.38/qiskit.circuit.ControlledGate" }, { - "title": "CPhaseGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CPhaseGate" + "title": "Delay", + "url": "/api/qiskit/0.38/qiskit.circuit.Delay" }, { - "title": "CRXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CRXGate" + "title": "EquivalenceLibrary", + "url": "/api/qiskit/0.38/qiskit.circuit.EquivalenceLibrary" }, { - "title": "CRYGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CRYGate" + "title": "ForLoopOp", + "url": "/api/qiskit/0.38/qiskit.circuit.ForLoopOp" }, { - "title": "CRZGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CRZGate" + "title": "Gate", + "url": "/api/qiskit/0.38/qiskit.circuit.Gate" }, { - "title": "CSwapGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CSwapGate" + "title": "IfElseOp", + "url": "/api/qiskit/0.38/qiskit.circuit.IfElseOp" }, { - "title": "CSXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CSXGate" + "title": "Instruction", + "url": "/api/qiskit/0.38/qiskit.circuit.Instruction" }, { - "title": "CU1Gate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CU1Gate" + "title": "InstructionSet", + "url": "/api/qiskit/0.38/qiskit.circuit.InstructionSet" }, { - "title": "CU3Gate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CU3Gate" + "title": "Parameter", + "url": "/api/qiskit/0.38/qiskit.circuit.Parameter" }, { - "title": "CUGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CUGate" + "title": "ParameterExpression", + "url": "/api/qiskit/0.38/qiskit.circuit.ParameterExpression" }, { - "title": "CXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CXGate" + "title": "ParameterVector", + "url": "/api/qiskit/0.38/qiskit.circuit.ParameterVector" }, { - "title": "CYGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CYGate" + "title": "QuantumCircuit", + "url": "/api/qiskit/0.38/qiskit.circuit.QuantumCircuit" }, { - "title": "CZGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.CZGate" + "title": "QuantumRegister", + "url": "/api/qiskit/0.38/qiskit.circuit.QuantumRegister" }, { - "title": "DCXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.DCXGate" + "title": "Qubit", + "url": "/api/qiskit/0.38/qiskit.circuit.Qubit" }, { - "title": "Delay", - "url": "/api/qiskit/0.38/qiskit.circuit.Delay" + "title": "random_circuit", + "url": "/api/qiskit/0.38/qiskit.circuit.random.random_circuit" }, { - "title": "Diagonal", - "url": "/api/qiskit/0.38/qiskit.circuit.library.Diagonal" + "title": "WhileLoopOp", + "url": "/api/qiskit/0.38/qiskit.circuit.WhileLoopOp" }, { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.38/qiskit.circuit.library.DraperQFTAdder" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.EfficientSU2" - }, - { - "title": "EquivalenceLibrary", - "url": "/api/qiskit/0.38/qiskit.circuit.EquivalenceLibrary" - }, - { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.38/qiskit.circuit.library.EvolvedOperatorAnsatz" - }, - { - "title": "ExactReciprocal", - "url": "/api/qiskit/0.38/qiskit.circuit.library.ExactReciprocal" - }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.38/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "ForLoopOp", - "url": "/api/qiskit/0.38/qiskit.circuit.ForLoopOp" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.38/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.38/qiskit.circuit.library.FunctionalPauliRotations" - }, - { - "title": "Gate", - "url": "/api/qiskit/0.38/qiskit.circuit.Gate" - }, - { - "title": "GMS", - "url": "/api/qiskit/0.38/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.38/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.38/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.38/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.38/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.38/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.38/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.38/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.38/qiskit.circuit.library.HRSCumulativeMultiplier" - }, - { - "title": "IfElseOp", - "url": "/api/qiskit/0.38/qiskit.circuit.IfElseOp" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.38/qiskit.circuit.library.InnerProduct" - }, - { - "title": "Instruction", - "url": "/api/qiskit/0.38/qiskit.circuit.Instruction" - }, - { - "title": "InstructionSet", - "url": "/api/qiskit/0.38/qiskit.circuit.InstructionSet" - }, - { - "title": "IntegerComparator", - "url": "/api/qiskit/0.38/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.38/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.38/qiskit.circuit.library.LinearAmplitudeFunction" - }, - { - "title": "LinearFunction", - "url": "/api/qiskit/0.38/qiskit.circuit.library.LinearFunction" - }, - { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.38/qiskit.circuit.library.LinearPauliRotations" - }, - { - "title": "MCMT", - "url": "/api/qiskit/0.38/qiskit.circuit.library.MCMT" - }, - { - "title": "MCMTVChain", - "url": "/api/qiskit/0.38/qiskit.circuit.library.MCMTVChain" - }, - { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.MCPhaseGate" - }, - { - "title": "MCXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.MCXGate" - }, - { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.38/qiskit.circuit.library.MCXGrayCode" - }, - { - "title": "MCXRecursive", - "url": "/api/qiskit/0.38/qiskit.circuit.library.MCXRecursive" - }, - { - "title": "MCXVChain", - "url": "/api/qiskit/0.38/qiskit.circuit.library.MCXVChain" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.38/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.38/qiskit.circuit.library.NLocal" - }, - { - "title": "OR", - "url": "/api/qiskit/0.38/qiskit.circuit.library.OR" - }, - { - "title": "Parameter", - "url": "/api/qiskit/0.38/qiskit.circuit.Parameter" - }, - { - "title": "ParameterExpression", - "url": "/api/qiskit/0.38/qiskit.circuit.ParameterExpression" - }, - { - "title": "ParameterVector", - "url": "/api/qiskit/0.38/qiskit.circuit.ParameterVector" - }, - { - "title": "PauliEvolutionGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.PauliEvolutionGate" - }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.38/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.38/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.38/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.38/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.38/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.38/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.38/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.38/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.38/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.38/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.38/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.38/qiskit.circuit.library.QuadraticForm" - }, - { - "title": "QuantumCircuit", - "url": "/api/qiskit/0.38/qiskit.circuit.QuantumCircuit" - }, - { - "title": "QuantumRegister", - "url": "/api/qiskit/0.38/qiskit.circuit.QuantumRegister" - }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.38/qiskit.circuit.library.QuantumVolume" - }, - { - "title": "Qubit", - "url": "/api/qiskit/0.38/qiskit.circuit.Qubit" - }, - { - "title": "random_circuit", - "url": "/api/qiskit/0.38/qiskit.circuit.random.random_circuit" - }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RealAmplitudes" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.38/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.SGate" - }, - { - "title": "StatePreparation", - "url": "/api/qiskit/0.38/qiskit.circuit.library.StatePreparation" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_3" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.38/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.38/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.38/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.UGate" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.38/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.38/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "WhileLoopOp", - "url": "/api/qiskit/0.38/qiskit.circuit.WhileLoopOp" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.38/qiskit.circuit.library.XOR" - }, - { - "title": "XXMinusYYGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.XXMinusYYGate" - }, - { - "title": "XXPlusYYGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.XXPlusYYGate" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.38/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.38/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.38/qiskit.circuit.library.ZZFeatureMap" - }, - { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.38/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.38/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.38/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.38/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.38/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.38/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.38/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.38/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExactReciprocal", + "url": "/api/qiskit/0.38/qiskit.circuit.library.ExactReciprocal" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.38/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.38/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.38/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.38/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.38/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.38/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.38/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.38/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.38/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.38/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.38/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.38/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.38/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.38/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.38/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.38/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearFunction", + "url": "/api/qiskit/0.38/qiskit.circuit.library.LinearFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.38/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.38/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.38/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.38/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.38/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.38/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.38/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.38/qiskit.circuit.library.NLocal" + }, + { + "title": "OR", + "url": "/api/qiskit/0.38/qiskit.circuit.library.OR" + }, + { + "title": "PauliEvolutionGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.PauliEvolutionGate" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.38/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.38/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.38/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.38/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.38/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.38/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.38/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.38/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.38/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.38/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.38/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.38/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.38/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.38/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.38/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.SGate" + }, + { + "title": "StatePreparation", + "url": "/api/qiskit/0.38/qiskit.circuit.library.StatePreparation" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.38/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.38/qiskit.circuit.library.TwoLocal" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.38/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "U1Gate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.U1Gate" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "U2Gate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.U2Gate" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "U3Gate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.U3Gate" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.38/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "UGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.UGate" + }, + { + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.38/qiskit.circuit.library.VBERippleCarryAdder" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.38/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.38/qiskit.circuit.library.XOR" + }, + { + "title": "XXMinusYYGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.XXMinusYYGate" + }, + { + "title": "XXPlusYYGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.XXPlusYYGate" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.38/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.38/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.38/qiskit.circuit.library.ZZFeatureMap" } ] } @@ -1380,225 +1411,288 @@ "title": "Overview", "url": "/api/qiskit/0.38/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.38/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.38/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.38/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.38/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.38/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.38/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.38/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.38/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.38/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.38/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.38/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.38/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.38/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.38/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.38/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.38/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.38/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.38/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.38/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.38/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.38/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.38/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.38/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.38/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.38/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.38/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.38/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.38/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.38/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.38/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.38/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.38/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.38/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.38/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.38/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.38/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.38/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.38/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.38/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.38/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.38/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.38/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.38/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.38/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.38/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.38/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.38/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.38/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.38/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.38/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.38/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.38/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.38/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.38/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.38/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.38/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.38/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.38/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.38/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.38/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.38/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.38/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.38/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3264,6 +3358,14 @@ "title": "Overview", "url": "/api/qiskit/0.38/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.38/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.38/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.38/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.38/circuit_library.md b/docs/api/qiskit/0.38/circuit_library.md index bc9b44c6e5a..9116f7c9451 100644 --- a/docs/api/qiskit/0.38/circuit_library.md +++ b/docs/api/qiskit/0.38/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` The circuit library is a collection of well-studied and valuable circuits, directives, and gates. We call them valuable for different reasons, for instance they can serve as building blocks for algorithms or they are circuits that we think are hard to simulate classically. @@ -385,3 +397,4 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.md b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.md index 67c30435992..c48fe803e91 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.linear_solvers.md @@ -1,16 +1,28 @@ +--- +title: linear_solvers +description: API reference for qiskit.algorithms.linear_solvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.linear_solvers +--- + # qiskit.algorithms.linear\_solvers -## Linear solvers ([`qiskit.algorithms.linear_solvers`](#module-qiskit.algorithms.linear_solvers "qiskit.algorithms.linear_solvers")) +## Linear solvers + + + +`qiskit.algorithms.linear_solvers` It contains classical and quantum algorithms to solve systems of linear equations such as `HHL`. Although the quantum algorithm accepts a general Hermitian matrix as input, Qiskit’s default Hamiltonian evolution is exponential in such cases and therefore the quantum linear solver will not achieve an exponential speedup. Furthermore, the quantum algorithm can find a solution exponentially faster in the size of the system than their classical counterparts (i.e. logarithmic complexity instead of polynomial), meaning that reading the full solution vector would kill such speedup (since this would take linear time in the size of the system). Therefore, to achieve an exponential speedup we can only compute functions from the solution vector (the so called observables) to learn information about the solution. Known efficient implementations of Hamiltonian evolutions or observables are contained in the following subfolders: -## [Matrices](#matrices) +**[Matrices](#matrices)** A placeholder for efficient implementations of the Hamiltonian evolution of particular types of matrices. -## [Observables](#observables) +**[Observables](#observables)** A placeholder for efficient implementations of functions that can be computed from the solution vector to a system of linear equations. @@ -38,3 +50,4 @@ A placeholder for efficient implementations of functions that can be computed fr | [`LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.LinearSystemObservable")() | An abstract class for linear system observables in Qiskit. | | [`AbsoluteAverage`](qiskit.algorithms.linear_solvers.AbsoluteAverage "qiskit.algorithms.linear_solvers.AbsoluteAverage")() | An observable for the absolute average of a linear system of equations solution. | | [`MatrixFunctional`](qiskit.algorithms.linear_solvers.MatrixFunctional "qiskit.algorithms.linear_solvers.MatrixFunctional")(main\_diag, off\_diag) | A class for the matrix functional of the vector solution to the linear systems. | + diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.md index 866de55e25a..e498d441b9e 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -70,3 +82,4 @@ The global optimizers are as follows: | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.nlopts.md b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.nlopts.md index f7fb470a11e..b430ce1d9d8 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.nlopts.md +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.nlopts.md @@ -1,3 +1,11 @@ +--- +title: nlopts +description: API reference for qiskit.algorithms.optimizers.nlopts +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.nlopts +--- + # qiskit.algorithms.optimizers.nlopts @@ -26,3 +34,4 @@ export PYTHONPATH=/usr/local/lib/python3.6/site-packages:${PYTHONPATH} ``` The two `export` commands above can be pasted into the `.bash_profile` file in the user’s home directory for automatic execution. Now you can run Qiskit and these optimizers should be available for you to use. + diff --git a/docs/api/qiskit/0.38/qiskit.opflow.converters.md b/docs/api/qiskit/0.38/qiskit.opflow.converters.md index 78c8d772f6c..fd81b2d76b6 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, ...]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, ...]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.md index 901c1a93987..56d09f9e3a1 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive "bookends" strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.38/qiskit.opflow.expectations.md b/docs/api/qiskit/0.38/qiskit.opflow.expectations.md index 40f57dfa261..df598260d9d 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.38/qiskit.opflow.gradients.md b/docs/api/qiskit/0.38/qiskit.opflow.gradients.md index e4558f4e2ea..af71ebe3bf7 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, ...]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.md index 71b2cd119a1..51994b092bd 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.md index 356f54afb31..49e0db5a490 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.md index 2ffffc20990..e374b0766ed 100644 --- a/docs/api/qiskit/0.38/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.38/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, ...]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, ...]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.38/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.38/qiskit.scheduler.methods.basic.md index 6d0ab513269..6bef8c60c54 100644 --- a/docs/api/qiskit/0.38/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.38/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as late as possible" (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as soon as possible" (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.38/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.38/qiskit.scheduler.schedule_circuit.md index a9e2086d690..36e4ab21f18 100644 --- a/docs/api/qiskit/0.38/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.38/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | ----------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, ...]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.39/_toc.json b/docs/api/qiskit/0.39/_toc.json index 7da3442a800..53b5b0f4cc6 100644 --- a/docs/api/qiskit/0.39/_toc.json +++ b/docs/api/qiskit/0.39/_toc.json @@ -12,22 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.39/algorithms" }, - { - "title": "AbsoluteAverage", - "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.AbsoluteAverage" - }, - { - "title": "ADAM", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.ADAM" - }, - { - "title": "AdaptVQE", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQE" - }, - { - "title": "AdaptVQEResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.39/qiskit.algorithms.AlgorithmError" @@ -60,74 +44,14 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.39/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "AskData", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.AskData" - }, - { - "title": "BaseEstimatorGradient", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.BaseEstimatorGradient" - }, - { - "title": "BaseSamplerGradient", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.BaseSamplerGradient" - }, - { - "title": "BaseStateFidelity", - "url": "/api/qiskit/0.39/qiskit.algorithms.state_fidelities.BaseStateFidelity" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "ComputeUncompute", - "url": "/api/qiskit/0.39/qiskit.algorithms.state_fidelities.ComputeUncompute" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.39/qiskit.algorithms.Eigensolver" }, - { - "title": "Eigensolver", - "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.Eigensolver" - }, { "title": "EigensolverResult", "url": "/api/qiskit/0.39/qiskit.algorithms.EigensolverResult" }, - { - "title": "EigensolverResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.EigensolverResult" - }, - { - "title": "ESCH", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.ESCH" - }, { "title": "estimate_observables", "url": "/api/qiskit/0.39/qiskit.algorithms.estimate_observables" @@ -136,10 +60,6 @@ "title": "EstimationProblem", "url": "/api/qiskit/0.39/qiskit.algorithms.EstimationProblem" }, - { - "title": "EstimatorGradientResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.EstimatorGradientResult" - }, { "title": "eval_observables", "url": "/api/qiskit/0.39/qiskit.algorithms.eval_observables" @@ -160,22 +80,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.39/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "FiniteDiffEstimatorGradient", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient" - }, - { - "title": "FiniteDiffSamplerGradient", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffSamplerGradient" - }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescent" - }, - { - "title": "GradientDescentState", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescentState" - }, { "title": "Grover", "url": "/api/qiskit/0.39/qiskit.algorithms.Grover" @@ -184,10 +88,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.39/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -196,10 +96,6 @@ "title": "HamiltonianPhaseEstimationResult", "url": "/api/qiskit/0.39/qiskit.algorithms.HamiltonianPhaseEstimationResult" }, - { - "title": "HHL", - "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.HHL" - }, { "title": "ImaginaryEvolver", "url": "/api/qiskit/0.39/qiskit.algorithms.ImaginaryEvolver" @@ -208,14 +104,6 @@ "title": "ImaginaryTimeEvolver", "url": "/api/qiskit/0.39/qiskit.algorithms.ImaginaryTimeEvolver" }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.39/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -228,42 +116,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.39/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.L_BFGS_B" - }, - { - "title": "LearningRate", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.LearningRate" - }, - { - "title": "LinCombEstimatorGradient", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombEstimatorGradient" - }, - { - "title": "LinCombSamplerGradient", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombSamplerGradient" - }, - { - "title": "LinearSolver", - "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolver" - }, - { - "title": "LinearSolverResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolverResult" - }, - { - "title": "LinearSystemMatrix", - "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemMatrix" - }, - { - "title": "LinearSystemObservable", - "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemObservable" - }, - { - "title": "MatrixFunctional", - "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.MatrixFunctional" - }, { "title": "MaximumLikelihoodAmplitudeEstimation", "url": "/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation" @@ -272,94 +124,22 @@ "title": "MaximumLikelihoodAmplitudeEstimationResult", "url": "/api/qiskit/0.39/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult" }, - { - "title": "Minimizer", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.Minimizer" - }, { "title": "MinimumEigensolver", "url": "/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolver" }, - { - "title": "MinimumEigensolver", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver" - }, { "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.39/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "MinimumEigensolverResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult" - }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.39/qiskit.algorithms.NumPyEigensolver" }, - { - "title": "NumPyEigensolver", - "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolver" - }, - { - "title": "NumPyEigensolverResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolverResult" - }, - { - "title": "NumPyLinearSolver", - "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyLinearSolver" - }, - { - "title": "NumPyMatrix", - "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyMatrix" - }, { "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.39/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "NumPyMinimumEigensolver", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver" - }, - { - "title": "NumPyMinimumEigensolverResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult" - }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerResult" - }, - { - "title": "OptimizerState", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerState" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.P_BFGS" - }, - { - "title": "ParamShiftEstimatorGradient", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftEstimatorGradient" - }, - { - "title": "ParamShiftSamplerGradient", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftSamplerGradient" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.39/qiskit.algorithms.PhaseEstimation" @@ -372,10 +152,6 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.39/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.POWELL" - }, { "title": "PVQD", "url": "/api/qiskit/0.39/qiskit.algorithms.PVQD" @@ -388,14 +164,6 @@ "title": "QAOA", "url": "/api/qiskit/0.39/qiskit.algorithms.QAOA" }, - { - "title": "QAOA", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.QAOA" - }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.QNSPSA" - }, { "title": "RealEvolver", "url": "/api/qiskit/0.39/qiskit.algorithms.RealEvolver" @@ -404,30 +172,6 @@ "title": "RealTimeEvolver", "url": "/api/qiskit/0.39/qiskit.algorithms.RealTimeEvolver" }, - { - "title": "SamplerGradientResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.SamplerGradientResult" - }, - { - "title": "SamplingMinimumEigensolver", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver" - }, - { - "title": "SamplingMinimumEigensolverResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult" - }, - { - "title": "SamplingVQE", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQE" - }, - { - "title": "SamplingVQEResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult" - }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "Shor", "url": "/api/qiskit/0.39/qiskit.algorithms.Shor" @@ -436,38 +180,6 @@ "title": "ShorResult", "url": "/api/qiskit/0.39/qiskit.algorithms.ShorResult" }, - { - "title": "SLSQP", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "SPSAEstimatorGradient", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.SPSAEstimatorGradient" - }, - { - "title": "SPSASamplerGradient", - "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.SPSASamplerGradient" - }, - { - "title": "StateFidelityResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.state_fidelities.StateFidelityResult" - }, - { - "title": "SteppableOptimizer", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.SteppableOptimizer" - }, - { - "title": "TellData", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.TellData" - }, { "title": "TimeEvolutionProblem", "url": "/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionProblem" @@ -476,75 +188,435 @@ "title": "TimeEvolutionResult", "url": "/api/qiskit/0.39/qiskit.algorithms.TimeEvolutionResult" }, - { - "title": "TNC", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.TNC" - }, - { - "title": "TridiagonalToeplitz", - "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" - }, { "title": "TrotterQRTE", "url": "/api/qiskit/0.39/qiskit.algorithms.TrotterQRTE" }, - { - "title": "TrotterQRTE", - "url": "/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE" - }, - { - "title": "UMDA", - "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.UMDA" - }, { "title": "VQD", "url": "/api/qiskit/0.39/qiskit.algorithms.VQD" }, - { - "title": "VQD", - "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQD" - }, { "title": "VQDResult", "url": "/api/qiskit/0.39/qiskit.algorithms.VQDResult" }, - { - "title": "VQDResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQDResult" - }, { "title": "VQE", "url": "/api/qiskit/0.39/qiskit.algorithms.VQE" }, { - "title": "VQE", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQE" - }, - { - "title": "VQEResult", - "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQEResult" - } - ] - }, - { - "title": "qiskit.assembler", - "children": [ - { - "title": "Overview", - "url": "/api/qiskit/0.39/assembler" + "title": "qiskit.algorithms.eigensolvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers" + }, + { + "title": "Eigensolver", + "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.Eigensolver" + }, + { + "title": "EigensolverResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.EigensolverResult" + }, + { + "title": "NumPyEigensolver", + "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolver" + }, + { + "title": "NumPyEigensolverResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.NumPyEigensolverResult" + }, + { + "title": "VQD", + "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQD" + }, + { + "title": "VQDResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.eigensolvers.VQDResult" + } + ] }, { - "title": "assemble_circuits", - "url": "/api/qiskit/0.39/qiskit.assembler.assemble_circuits" + "title": "qiskit.algorithms.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients" + }, + { + "title": "BaseEstimatorGradient", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.BaseEstimatorGradient" + }, + { + "title": "BaseSamplerGradient", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.BaseSamplerGradient" + }, + { + "title": "EstimatorGradientResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.EstimatorGradientResult" + }, + { + "title": "FiniteDiffEstimatorGradient", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient" + }, + { + "title": "FiniteDiffSamplerGradient", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.FiniteDiffSamplerGradient" + }, + { + "title": "LinCombEstimatorGradient", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombEstimatorGradient" + }, + { + "title": "LinCombSamplerGradient", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.LinCombSamplerGradient" + }, + { + "title": "ParamShiftEstimatorGradient", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftEstimatorGradient" + }, + { + "title": "ParamShiftSamplerGradient", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.ParamShiftSamplerGradient" + }, + { + "title": "SamplerGradientResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.SamplerGradientResult" + }, + { + "title": "SPSAEstimatorGradient", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.SPSAEstimatorGradient" + }, + { + "title": "SPSASamplerGradient", + "url": "/api/qiskit/0.39/qiskit.algorithms.gradients.SPSASamplerGradient" + } + ] }, { - "title": "assemble_schedules", - "url": "/api/qiskit/0.39/qiskit.assembler.assemble_schedules" + "title": "qiskit.algorithms.linear_solvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers" + }, + { + "title": "AbsoluteAverage", + "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.AbsoluteAverage" + }, + { + "title": "HHL", + "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.HHL" + }, + { + "title": "LinearSolver", + "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolver" + }, + { + "title": "LinearSolverResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSolverResult" + }, + { + "title": "LinearSystemMatrix", + "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemMatrix" + }, + { + "title": "LinearSystemObservable", + "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.LinearSystemObservable" + }, + { + "title": "MatrixFunctional", + "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.MatrixFunctional" + }, + { + "title": "NumPyLinearSolver", + "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyLinearSolver" + }, + { + "title": "NumPyMatrix", + "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.NumPyMatrix" + }, + { + "title": "TridiagonalToeplitz", + "url": "/api/qiskit/0.39/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" + } + ] }, { - "title": "disassemble", - "url": "/api/qiskit/0.39/qiskit.assembler.disassemble" - }, + "title": "qiskit.algorithms.minimum_eigensolvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers" + }, + { + "title": "AdaptVQE", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQE" + }, + { + "title": "AdaptVQEResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult" + }, + { + "title": "MinimumEigensolver", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver" + }, + { + "title": "MinimumEigensolverResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult" + }, + { + "title": "NumPyMinimumEigensolver", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver" + }, + { + "title": "NumPyMinimumEigensolverResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult" + }, + { + "title": "QAOA", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.QAOA" + }, + { + "title": "SamplingMinimumEigensolver", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver" + }, + { + "title": "SamplingMinimumEigensolverResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult" + }, + { + "title": "SamplingVQE", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQE" + }, + { + "title": "SamplingVQEResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult" + }, + { + "title": "VQE", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQE" + }, + { + "title": "VQEResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.VQEResult" + } + ] + }, + { + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "AskData", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.AskData" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GradientDescentState", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.GradientDescentState" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "Minimizer", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.Minimizer" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerResult" + }, + { + "title": "OptimizerState", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerState" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "SteppableOptimizer", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.SteppableOptimizer" + }, + { + "title": "TellData", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.TellData" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.TNC" + }, + { + "title": "UMDA", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.UMDA" + }, + { + "title": "qiskit.algorithms.optimizers.optimizer_utils", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils" + }, + { + "title": "LearningRate", + "url": "/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.LearningRate" + } + ] + } + ] + }, + { + "title": "qiskit.algorithms.state_fidelities", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.algorithms.state_fidelities" + }, + { + "title": "BaseStateFidelity", + "url": "/api/qiskit/0.39/qiskit.algorithms.state_fidelities.BaseStateFidelity" + }, + { + "title": "ComputeUncompute", + "url": "/api/qiskit/0.39/qiskit.algorithms.state_fidelities.ComputeUncompute" + }, + { + "title": "StateFidelityResult", + "url": "/api/qiskit/0.39/qiskit.algorithms.state_fidelities.StateFidelityResult" + } + ] + }, + { + "title": "qiskit.algorithms.time_evolvers.trotterization", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization" + }, + { + "title": "TrotterQRTE", + "url": "/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE" + } + ] + } + ] + }, + { + "title": "qiskit.assembler", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/assembler" + }, + { + "title": "assemble_circuits", + "url": "/api/qiskit/0.39/qiskit.assembler.assemble_circuits" + }, + { + "title": "assemble_schedules", + "url": "/api/qiskit/0.39/qiskit.assembler.assemble_schedules" + }, + { + "title": "disassemble", + "url": "/api/qiskit/0.39/qiskit.assembler.disassemble" + }, { "title": "RunConfig", "url": "/api/qiskit/0.39/qiskit.assembler.RunConfig" @@ -566,46 +638,10 @@ "title": "AncillaRegister", "url": "/api/qiskit/0.39/qiskit.circuit.AncillaRegister" }, - { - "title": "AND", - "url": "/api/qiskit/0.39/qiskit.circuit.library.AND" - }, - { - "title": "Barrier", - "url": "/api/qiskit/0.39/qiskit.circuit.library.Barrier" - }, { "title": "BreakLoopOp", "url": "/api/qiskit/0.39/qiskit.circuit.BreakLoopOp" }, - { - "title": "C3SXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.C3SXGate" - }, - { - "title": "C3XGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.C3XGate" - }, - { - "title": "C4XGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.C4XGate" - }, - { - "title": "CCXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CCXGate" - }, - { - "title": "CCZGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CCZGate" - }, - { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CDKMRippleCarryAdder" - }, - { - "title": "CHGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CHGate" - }, { "title": "CircuitInstruction", "url": "/api/qiskit/0.39/qiskit.circuit.CircuitInstruction" @@ -618,78 +654,6 @@ "title": "Clbit", "url": "/api/qiskit/0.39/qiskit.circuit.Clbit" }, - { - "title": "clifford_2_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_2_1" - }, - { - "title": "clifford_2_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_2_2" - }, - { - "title": "clifford_2_3", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_2_3" - }, - { - "title": "clifford_2_4", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_6_5" - }, - { - "title": "clifford_8_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_8_1" - }, - { - "title": "clifford_8_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_8_2" - }, - { - "title": "clifford_8_3", - "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_8_3" - }, { "title": "CommutationChecker", "url": "/api/qiskit/0.39/qiskit.circuit.CommutationChecker" @@ -707,727 +671,844 @@ "url": "/api/qiskit/0.39/qiskit.circuit.ControlledGate" }, { - "title": "CPhaseGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSdgGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CSdgGate" + "title": "Delay", + "url": "/api/qiskit/0.39/qiskit.circuit.Delay" }, { - "title": "CSGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CSGate" + "title": "EquivalenceLibrary", + "url": "/api/qiskit/0.39/qiskit.circuit.EquivalenceLibrary" }, { - "title": "CSwapGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CSwapGate" + "title": "ForLoopOp", + "url": "/api/qiskit/0.39/qiskit.circuit.ForLoopOp" }, { - "title": "CSXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CSXGate" + "title": "Gate", + "url": "/api/qiskit/0.39/qiskit.circuit.Gate" }, { - "title": "CU1Gate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CU1Gate" + "title": "IfElseOp", + "url": "/api/qiskit/0.39/qiskit.circuit.IfElseOp" }, { - "title": "CU3Gate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CU3Gate" + "title": "Instruction", + "url": "/api/qiskit/0.39/qiskit.circuit.Instruction" }, { - "title": "CUGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CUGate" + "title": "InstructionSet", + "url": "/api/qiskit/0.39/qiskit.circuit.InstructionSet" }, { - "title": "CXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CXGate" + "title": "Operation", + "url": "/api/qiskit/0.39/qiskit.circuit.Operation" }, { - "title": "CYGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CYGate" + "title": "Parameter", + "url": "/api/qiskit/0.39/qiskit.circuit.Parameter" }, { - "title": "CZGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.CZGate" + "title": "ParameterExpression", + "url": "/api/qiskit/0.39/qiskit.circuit.ParameterExpression" }, { - "title": "DCXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.DCXGate" + "title": "ParameterVector", + "url": "/api/qiskit/0.39/qiskit.circuit.ParameterVector" }, { - "title": "Delay", - "url": "/api/qiskit/0.39/qiskit.circuit.Delay" + "title": "QuantumCircuit", + "url": "/api/qiskit/0.39/qiskit.circuit.QuantumCircuit" }, { - "title": "Diagonal", - "url": "/api/qiskit/0.39/qiskit.circuit.library.Diagonal" + "title": "QuantumRegister", + "url": "/api/qiskit/0.39/qiskit.circuit.QuantumRegister" }, { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.39/qiskit.circuit.library.DraperQFTAdder" + "title": "Qubit", + "url": "/api/qiskit/0.39/qiskit.circuit.Qubit" }, { - "title": "ECRGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.ECRGate" + "title": "random_circuit", + "url": "/api/qiskit/0.39/qiskit.circuit.random.random_circuit" }, { - "title": "EfficientSU2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.EfficientSU2" + "title": "WhileLoopOp", + "url": "/api/qiskit/0.39/qiskit.circuit.WhileLoopOp" }, { - "title": "EquivalenceLibrary", - "url": "/api/qiskit/0.39/qiskit.circuit.EquivalenceLibrary" - }, - { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.39/qiskit.circuit.library.EvolvedOperatorAnsatz" - }, - { - "title": "ExactReciprocal", - "url": "/api/qiskit/0.39/qiskit.circuit.library.ExactReciprocal" - }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.39/qiskit.circuit.library.ExcitationPreserving" - }, - { - "title": "ForLoopOp", - "url": "/api/qiskit/0.39/qiskit.circuit.ForLoopOp" - }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.39/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.39/qiskit.circuit.library.FunctionalPauliRotations" - }, - { - "title": "Gate", - "url": "/api/qiskit/0.39/qiskit.circuit.Gate" - }, - { - "title": "GMS", - "url": "/api/qiskit/0.39/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.39/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.39/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.39/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.39/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.39/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.39/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.39/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.39/qiskit.circuit.library.HRSCumulativeMultiplier" - }, - { - "title": "IfElseOp", - "url": "/api/qiskit/0.39/qiskit.circuit.IfElseOp" - }, - { - "title": "IGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.39/qiskit.circuit.library.InnerProduct" - }, - { - "title": "Instruction", - "url": "/api/qiskit/0.39/qiskit.circuit.Instruction" - }, - { - "title": "InstructionSet", - "url": "/api/qiskit/0.39/qiskit.circuit.InstructionSet" - }, - { - "title": "IntegerComparator", - "url": "/api/qiskit/0.39/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.39/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.39/qiskit.circuit.library.LinearAmplitudeFunction" - }, - { - "title": "LinearFunction", - "url": "/api/qiskit/0.39/qiskit.circuit.library.LinearFunction" - }, - { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.39/qiskit.circuit.library.LinearPauliRotations" - }, - { - "title": "MCMT", - "url": "/api/qiskit/0.39/qiskit.circuit.library.MCMT" - }, - { - "title": "MCMTVChain", - "url": "/api/qiskit/0.39/qiskit.circuit.library.MCMTVChain" - }, - { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.MCPhaseGate" - }, - { - "title": "MCXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.MCXGate" - }, - { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.39/qiskit.circuit.library.MCXGrayCode" - }, - { - "title": "MCXRecursive", - "url": "/api/qiskit/0.39/qiskit.circuit.library.MCXRecursive" - }, - { - "title": "MCXVChain", - "url": "/api/qiskit/0.39/qiskit.circuit.library.MCXVChain" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.39/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.39/qiskit.circuit.library.NLocal" - }, - { - "title": "Operation", - "url": "/api/qiskit/0.39/qiskit.circuit.Operation" - }, - { - "title": "OR", - "url": "/api/qiskit/0.39/qiskit.circuit.library.OR" - }, - { - "title": "Parameter", - "url": "/api/qiskit/0.39/qiskit.circuit.Parameter" - }, - { - "title": "ParameterExpression", - "url": "/api/qiskit/0.39/qiskit.circuit.ParameterExpression" - }, - { - "title": "ParameterVector", - "url": "/api/qiskit/0.39/qiskit.circuit.ParameterVector" - }, - { - "title": "PauliEvolutionGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.PauliEvolutionGate" - }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.39/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.39/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.39/qiskit.circuit.library.Permutation" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.39/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.39/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.39/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.39/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.39/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.39/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.39/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.39/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.39/qiskit.circuit.library.QuadraticForm" - }, - { - "title": "QuantumCircuit", - "url": "/api/qiskit/0.39/qiskit.circuit.QuantumCircuit" - }, - { - "title": "QuantumRegister", - "url": "/api/qiskit/0.39/qiskit.circuit.QuantumRegister" - }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.39/qiskit.circuit.library.QuantumVolume" - }, - { - "title": "Qubit", - "url": "/api/qiskit/0.39/qiskit.circuit.Qubit" - }, - { - "title": "random_circuit", - "url": "/api/qiskit/0.39/qiskit.circuit.random.random_circuit" - }, - { - "title": "RC3XGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RealAmplitudes" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.39/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.SGate" - }, - { - "title": "StatePreparation", - "url": "/api/qiskit/0.39/qiskit.circuit.library.StatePreparation" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_3" - }, - { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_1" - }, - { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_4" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.39/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.39/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.UGate" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.39/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.39/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "WhileLoopOp", - "url": "/api/qiskit/0.39/qiskit.circuit.WhileLoopOp" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.39/qiskit.circuit.library.XOR" - }, - { - "title": "XXMinusYYGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.XXMinusYYGate" - }, - { - "title": "XXPlusYYGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.XXPlusYYGate" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.39/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.39/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.39/qiskit.circuit.library.ZZFeatureMap" - }, - { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.39/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.39/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.39/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.39/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CCXGate" + }, + { + "title": "CCZGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CCZGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.39/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSdgGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CSdgGate" + }, + { + "title": "CSGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CSGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.39/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.39/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.39/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExactReciprocal", + "url": "/api/qiskit/0.39/qiskit.circuit.library.ExactReciprocal" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.39/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.39/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.39/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.39/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.39/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.39/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.39/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.39/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.39/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.39/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.39/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.39/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.39/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.39/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.39/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.39/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearFunction", + "url": "/api/qiskit/0.39/qiskit.circuit.library.LinearFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.39/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.39/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.39/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.39/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.39/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.39/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.39/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.39/qiskit.circuit.library.NLocal" + }, + { + "title": "OR", + "url": "/api/qiskit/0.39/qiskit.circuit.library.OR" + }, + { + "title": "PauliEvolutionGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.PauliEvolutionGate" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.39/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.39/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.39/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.39/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.39/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.39/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.39/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.39/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.39/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.39/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.39/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.39/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.39/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.39/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.39/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.SGate" + }, + { + "title": "StatePreparation", + "url": "/api/qiskit/0.39/qiskit.circuit.library.StatePreparation" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.39/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.39/qiskit.circuit.library.TwoLocal" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.39/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "U1Gate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.U1Gate" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "U2Gate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.U2Gate" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "U3Gate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.U3Gate" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.39/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "UGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.UGate" + }, + { + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.39/qiskit.circuit.library.VBERippleCarryAdder" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.39/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.39/qiskit.circuit.library.XOR" + }, + { + "title": "XXMinusYYGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.XXMinusYYGate" + }, + { + "title": "XXPlusYYGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.XXPlusYYGate" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.39/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.39/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.39/qiskit.circuit.library.ZZFeatureMap" } ] } @@ -1600,225 +1681,288 @@ "title": "Overview", "url": "/api/qiskit/0.39/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.39/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.39/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.39/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.39/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.39/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.39/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.39/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.39/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.39/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.39/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.39/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.39/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.39/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.39/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.39/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.39/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.39/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.39/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.39/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.39/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.39/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.39/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.39/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.39/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.39/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.39/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.39/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.39/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.39/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.39/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.39/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.39/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.39/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.39/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.39/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.39/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.39/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.39/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.39/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.39/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.39/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.39/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.39/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.39/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.39/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.39/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.39/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.39/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.39/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.39/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.39/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.39/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.39/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.39/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.39/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.39/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.39/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.39/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3520,6 +3664,14 @@ "title": "Overview", "url": "/api/qiskit/0.39/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.39/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.39/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.39/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.39/circuit_library.md b/docs/api/qiskit/0.39/circuit_library.md index e42309d22a6..15356cd04b9 100644 --- a/docs/api/qiskit/0.39/circuit_library.md +++ b/docs/api/qiskit/0.39/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` The circuit library is a collection of well-studied and valuable circuits, directives, and gates. We call them valuable for different reasons, for instance they can serve as building blocks for algorithms or they are circuits that we think are hard to simulate classically. @@ -388,3 +400,4 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.md b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.md index 85b4bee7c28..d226b69b4b1 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.eigensolvers.md @@ -1,8 +1,20 @@ +--- +title: eigensolvers +description: API reference for qiskit.algorithms.eigensolvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.eigensolvers +--- + # qiskit.algorithms.eigensolvers -## Eigensolvers Package ([`qiskit.algorithms.eigensolvers`](#module-qiskit.algorithms.eigensolvers "qiskit.algorithms.eigensolvers")) +## Eigensolvers Package + + + +`qiskit.algorithms.eigensolvers` ### Eigensolvers @@ -19,3 +31,4 @@ > | [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.EigensolverResult")() | Eigensolver result. | > | [`NumPyEigensolverResult`](qiskit.algorithms.eigensolvers.NumPyEigensolverResult "qiskit.algorithms.eigensolvers.NumPyEigensolverResult")() | NumPy eigensolver result. | > | [`VQDResult`](qiskit.algorithms.eigensolvers.VQDResult "qiskit.algorithms.eigensolvers.VQDResult")() | VQD Result. | + diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.md b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.md index e571ea7b57c..b2e459f5afe 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.gradients.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.algorithms.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.gradients +--- + # qiskit.algorithms.gradients -## Gradients ([`qiskit.algorithms.gradients`](#module-qiskit.algorithms.gradients "qiskit.algorithms.gradients")) +## Gradients + + + +`qiskit.algorithms.gradients` ### Base Classes @@ -35,3 +47,4 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | | [`EstimatorGradientResult`](qiskit.algorithms.gradients.EstimatorGradientResult "qiskit.algorithms.gradients.EstimatorGradientResult")(gradients, metadata, ...) | Result of EstimatorGradient. | | [`SamplerGradientResult`](qiskit.algorithms.gradients.SamplerGradientResult "qiskit.algorithms.gradients.SamplerGradientResult")(gradients, metadata, ...) | Result of SamplerGradient. | + diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.md b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.md index 572c4585cea..7503a96b25d 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.linear_solvers.md @@ -1,16 +1,28 @@ +--- +title: linear_solvers +description: API reference for qiskit.algorithms.linear_solvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.linear_solvers +--- + # qiskit.algorithms.linear\_solvers -## The deprecated Linear solvers ([`qiskit.algorithms.linear_solvers`](#module-qiskit.algorithms.linear_solvers "qiskit.algorithms.linear_solvers")) +## The deprecated Linear solvers + + + +`qiskit.algorithms.linear_solvers` It contains classical and quantum algorithms to solve systems of linear equations such as `HHL`. Although the quantum algorithm accepts a general Hermitian matrix as input, Qiskit’s default Hamiltonian evolution is exponential in such cases and therefore the quantum linear solver will not achieve an exponential speedup. Furthermore, the quantum algorithm can find a solution exponentially faster in the size of the system than their classical counterparts (i.e. logarithmic complexity instead of polynomial), meaning that reading the full solution vector would kill such speedup (since this would take linear time in the size of the system). Therefore, to achieve an exponential speedup we can only compute functions from the solution vector (the so called observables) to learn information about the solution. Known efficient implementations of Hamiltonian evolutions or observables are contained in the following subfolders: -## [Matrices](#matrices) +**[Matrices](#matrices)** A placeholder for efficient implementations of the Hamiltonian evolution of particular types of matrices. -## [Observables](#observables) +**[Observables](#observables)** A placeholder for efficient implementations of functions that can be computed from the solution vector to a system of linear equations. @@ -38,3 +50,4 @@ A placeholder for efficient implementations of functions that can be computed fr | [`LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.LinearSystemObservable")() | The deprecated abstract class for linear system observables in Qiskit. | | [`AbsoluteAverage`](qiskit.algorithms.linear_solvers.AbsoluteAverage "qiskit.algorithms.linear_solvers.AbsoluteAverage")() | The deprecated observable for the absolute average of a linear system of equations solution. | | [`MatrixFunctional`](qiskit.algorithms.linear_solvers.MatrixFunctional "qiskit.algorithms.linear_solvers.MatrixFunctional")(main\_diag, off\_diag) | The deprecated class for the matrix functional of the vector solution to the linear systems. | + diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.md b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.md index 618bfe92c3d..4b56d4a91d1 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.minimum_eigensolvers.md @@ -1,8 +1,20 @@ +--- +title: minimum_eigensolvers +description: API reference for qiskit.algorithms.minimum_eigensolvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.minimum_eigensolvers +--- + # qiskit.algorithms.minimum\_eigensolvers -## Minimum Eigensolvers Package ([`qiskit.algorithms.minimum_eigensolvers`](#module-qiskit.algorithms.minimum_eigensolvers "qiskit.algorithms.minimum_eigensolvers")) +## Minimum Eigensolvers Package + + + +`qiskit.algorithms.minimum_eigensolvers` ### Minimum Eigensolvers @@ -24,3 +36,4 @@ | [`AdaptVQEResult`](qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult "qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult")() | AdaptVQE Result. | | [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult")() | Sampling Minimum Eigensolver Result. | | [`SamplingVQEResult`](qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult "qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult")() | VQE Result. | + diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.md index 4f7358a6dd6..3d91ef1d6be 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -78,3 +90,4 @@ The global optimizers here all use NLopt for their core function and can only be | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.md b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.md index e0bb9c1fc0b..843dbcc62db 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.optimizer_utils.md @@ -1,11 +1,24 @@ +--- +title: optimizer_utils +description: API reference for qiskit.algorithms.optimizers.optimizer_utils +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.optimizer_utils +--- + # qiskit.algorithms.optimizers.optimizer\_utils Utils for optimizers -## Optimizer Utils ([`qiskit.algorithms.optimizers.optimizer_utils`](#module-qiskit.algorithms.optimizers.optimizer_utils "qiskit.algorithms.optimizers.optimizer_utils")) +## Optimizer Utils + + + +`qiskit.algorithms.optimizers.optimizer_utils` | | | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | [`LearningRate`](qiskit.algorithms.optimizers.optimizer_utils.LearningRate "qiskit.algorithms.optimizers.optimizer_utils.LearningRate") | Represents a Learning Rate. | + diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.md b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.md index 4e8e2b3fccd..40b08327fe3 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.state_fidelities.md @@ -1,8 +1,20 @@ +--- +title: state_fidelities +description: API reference for qiskit.algorithms.state_fidelities +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.state_fidelities +--- + # qiskit.algorithms.state\_fidelities -## State Fidelity Interfaces ([`qiskit.algorithms.state_fidelities`](#module-qiskit.algorithms.state_fidelities "qiskit.algorithms.state_fidelities")) +## State Fidelity Interfaces + + + +`qiskit.algorithms.state_fidelities` ### State Fidelities @@ -16,3 +28,4 @@ > | | | > | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | > | [`StateFidelityResult`](qiskit.algorithms.state_fidelities.StateFidelityResult "qiskit.algorithms.state_fidelities.StateFidelityResult")(fidelities, ...) | This class stores the result of StateFidelity computations. | + diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.md b/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.md index 8f7eab51946..72b5e31139c 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.md +++ b/docs/api/qiskit/0.39/qiskit.algorithms.time_evolvers.trotterization.md @@ -1,3 +1,11 @@ +--- +title: trotterization +description: API reference for qiskit.algorithms.time_evolvers.trotterization +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.time_evolvers.trotterization +--- + # qiskit.algorithms.time\_evolvers.trotterization @@ -9,3 +17,4 @@ This package contains Trotterization-based Quantum Real Time Evolution algorithm | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | | [`TrotterQRTE`](qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE "qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE") | Quantum Real Time Evolution using Trotterization. | + diff --git a/docs/api/qiskit/0.39/qiskit.opflow.converters.md b/docs/api/qiskit/0.39/qiskit.opflow.converters.md index 78c8d772f6c..fd81b2d76b6 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, ...]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, ...]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.md index 901c1a93987..56d09f9e3a1 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive "bookends" strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.39/qiskit.opflow.expectations.md b/docs/api/qiskit/0.39/qiskit.opflow.expectations.md index 40f57dfa261..df598260d9d 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.39/qiskit.opflow.gradients.md b/docs/api/qiskit/0.39/qiskit.opflow.gradients.md index e4558f4e2ea..af71ebe3bf7 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, ...]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.md index 71b2cd119a1..51994b092bd 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.md index 356f54afb31..49e0db5a490 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.md index 2ffffc20990..e374b0766ed 100644 --- a/docs/api/qiskit/0.39/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.39/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, ...]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, ...]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.39/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.39/qiskit.scheduler.methods.basic.md index 6d0ab513269..6bef8c60c54 100644 --- a/docs/api/qiskit/0.39/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.39/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as late as possible" (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as soon as possible" (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.39/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.39/qiskit.scheduler.schedule_circuit.md index a9e2086d690..36e4ab21f18 100644 --- a/docs/api/qiskit/0.39/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.39/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | ----------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, ...]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.40/_toc.json b/docs/api/qiskit/0.40/_toc.json index a105ad0118b..2415d47c0e6 100644 --- a/docs/api/qiskit/0.40/_toc.json +++ b/docs/api/qiskit/0.40/_toc.json @@ -12,22 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.40/algorithms" }, - { - "title": "AbsoluteAverage", - "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.AbsoluteAverage" - }, - { - "title": "ADAM", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.ADAM" - }, - { - "title": "AdaptVQE", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQE" - }, - { - "title": "AdaptVQEResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.40/qiskit.algorithms.AlgorithmError" @@ -60,82 +44,14 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.40/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "AskData", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.AskData" - }, - { - "title": "BaseEstimatorGradient", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.BaseEstimatorGradient" - }, - { - "title": "BaseQGT", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.BaseQGT" - }, - { - "title": "BaseSamplerGradient", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.BaseSamplerGradient" - }, - { - "title": "BaseStateFidelity", - "url": "/api/qiskit/0.40/qiskit.algorithms.state_fidelities.BaseStateFidelity" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "ComputeUncompute", - "url": "/api/qiskit/0.40/qiskit.algorithms.state_fidelities.ComputeUncompute" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DerivativeType", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.DerivativeType" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.40/qiskit.algorithms.Eigensolver" }, - { - "title": "Eigensolver", - "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.Eigensolver" - }, { "title": "EigensolverResult", "url": "/api/qiskit/0.40/qiskit.algorithms.EigensolverResult" }, - { - "title": "EigensolverResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.EigensolverResult" - }, - { - "title": "ESCH", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.ESCH" - }, { "title": "estimate_observables", "url": "/api/qiskit/0.40/qiskit.algorithms.estimate_observables" @@ -144,10 +60,6 @@ "title": "EstimationProblem", "url": "/api/qiskit/0.40/qiskit.algorithms.EstimationProblem" }, - { - "title": "EstimatorGradientResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.EstimatorGradientResult" - }, { "title": "eval_observables", "url": "/api/qiskit/0.40/qiskit.algorithms.eval_observables" @@ -168,26 +80,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.40/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "FiniteDiffEstimatorGradient", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient" - }, - { - "title": "FiniteDiffSamplerGradient", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffSamplerGradient" - }, - { - "title": "ForwardEulerSolver", - "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver" - }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescent" - }, - { - "title": "GradientDescentState", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescentState" - }, { "title": "Grover", "url": "/api/qiskit/0.40/qiskit.algorithms.Grover" @@ -196,10 +88,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.40/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -208,34 +96,14 @@ "title": "HamiltonianPhaseEstimationResult", "url": "/api/qiskit/0.40/qiskit.algorithms.HamiltonianPhaseEstimationResult" }, - { - "title": "HHL", - "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.HHL" - }, { "title": "ImaginaryEvolver", "url": "/api/qiskit/0.40/qiskit.algorithms.ImaginaryEvolver" }, - { - "title": "ImaginaryMcLachlanPrinciple", - "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple" - }, { "title": "ImaginaryTimeEvolver", "url": "/api/qiskit/0.40/qiskit.algorithms.ImaginaryTimeEvolver" }, - { - "title": "ImaginaryVariationalPrinciple", - "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple" - }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.40/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -248,46 +116,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.40/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.L_BFGS_B" - }, - { - "title": "LearningRate", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.LearningRate" - }, - { - "title": "LinCombEstimatorGradient", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombEstimatorGradient" - }, - { - "title": "LinCombQGT", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombQGT" - }, - { - "title": "LinCombSamplerGradient", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombSamplerGradient" - }, - { - "title": "LinearSolver", - "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolver" - }, - { - "title": "LinearSolverResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolverResult" - }, - { - "title": "LinearSystemMatrix", - "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemMatrix" - }, - { - "title": "LinearSystemObservable", - "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemObservable" - }, - { - "title": "MatrixFunctional", - "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.MatrixFunctional" - }, { "title": "MaximumLikelihoodAmplitudeEstimation", "url": "/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation" @@ -296,94 +124,22 @@ "title": "MaximumLikelihoodAmplitudeEstimationResult", "url": "/api/qiskit/0.40/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult" }, - { - "title": "Minimizer", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.Minimizer" - }, { "title": "MinimumEigensolver", "url": "/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolver" }, - { - "title": "MinimumEigensolver", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver" - }, { "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.40/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "MinimumEigensolverResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult" - }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.40/qiskit.algorithms.NumPyEigensolver" }, - { - "title": "NumPyEigensolver", - "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolver" - }, - { - "title": "NumPyEigensolverResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolverResult" - }, - { - "title": "NumPyLinearSolver", - "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyLinearSolver" - }, - { - "title": "NumPyMatrix", - "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyMatrix" - }, { "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.40/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "NumPyMinimumEigensolver", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver" - }, - { - "title": "NumPyMinimumEigensolverResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult" - }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerResult" - }, - { - "title": "OptimizerState", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerState" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.P_BFGS" - }, - { - "title": "ParamShiftEstimatorGradient", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftEstimatorGradient" - }, - { - "title": "ParamShiftSamplerGradient", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftSamplerGradient" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.40/qiskit.algorithms.PhaseEstimation" @@ -396,10 +152,6 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.40/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.POWELL" - }, { "title": "PVQD", "url": "/api/qiskit/0.40/qiskit.algorithms.PVQD" @@ -412,78 +164,18 @@ "title": "QAOA", "url": "/api/qiskit/0.40/qiskit.algorithms.QAOA" }, - { - "title": "QAOA", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.QAOA" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.QFI" - }, - { - "title": "QFIResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.QFIResult" - }, - { - "title": "QGTResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.QGTResult" - }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.QNSPSA" - }, { "title": "RealEvolver", "url": "/api/qiskit/0.40/qiskit.algorithms.RealEvolver" }, - { - "title": "RealMcLachlanPrinciple", - "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple" - }, { "title": "RealTimeEvolver", "url": "/api/qiskit/0.40/qiskit.algorithms.RealTimeEvolver" }, - { - "title": "RealVariationalPrinciple", - "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple" - }, - { - "title": "ReverseEstimatorGradient", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseEstimatorGradient" - }, - { - "title": "ReverseQGT", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseQGT" - }, - { - "title": "SamplerGradientResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.SamplerGradientResult" - }, - { - "title": "SamplingMinimumEigensolver", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver" - }, - { - "title": "SamplingMinimumEigensolverResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult" - }, - { - "title": "SamplingVQE", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQE" - }, - { - "title": "SamplingVQEResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult" - }, { "title": "SciPyImaginaryEvolver", "url": "/api/qiskit/0.40/qiskit.algorithms.SciPyImaginaryEvolver" }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "SciPyRealEvolver", "url": "/api/qiskit/0.40/qiskit.algorithms.SciPyRealEvolver" @@ -496,38 +188,6 @@ "title": "ShorResult", "url": "/api/qiskit/0.40/qiskit.algorithms.ShorResult" }, - { - "title": "SLSQP", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "SPSAEstimatorGradient", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.SPSAEstimatorGradient" - }, - { - "title": "SPSASamplerGradient", - "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.SPSASamplerGradient" - }, - { - "title": "StateFidelityResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.state_fidelities.StateFidelityResult" - }, - { - "title": "SteppableOptimizer", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.SteppableOptimizer" - }, - { - "title": "TellData", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.TellData" - }, { "title": "TimeEvolutionProblem", "url": "/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionProblem" @@ -536,30 +196,10 @@ "title": "TimeEvolutionResult", "url": "/api/qiskit/0.40/qiskit.algorithms.TimeEvolutionResult" }, - { - "title": "TNC", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.TNC" - }, - { - "title": "TridiagonalToeplitz", - "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" - }, { "title": "TrotterQRTE", "url": "/api/qiskit/0.40/qiskit.algorithms.TrotterQRTE" }, - { - "title": "TrotterQRTE", - "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE" - }, - { - "title": "UMDA", - "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.UMDA" - }, - { - "title": "VariationalPrinciple", - "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple" - }, { "title": "VarQITE", "url": "/api/qiskit/0.40/qiskit.algorithms.VarQITE" @@ -572,191 +212,528 @@ "title": "VQD", "url": "/api/qiskit/0.40/qiskit.algorithms.VQD" }, - { - "title": "VQD", - "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQD" - }, { "title": "VQDResult", "url": "/api/qiskit/0.40/qiskit.algorithms.VQDResult" }, - { - "title": "VQDResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQDResult" - }, { "title": "VQE", "url": "/api/qiskit/0.40/qiskit.algorithms.VQE" }, { - "title": "VQE", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQE" - }, - { - "title": "VQEResult", - "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQEResult" - } - ] - }, - { - "title": "qiskit.assembler", - "children": [ - { - "title": "Overview", - "url": "/api/qiskit/0.40/assembler" - }, - { - "title": "assemble_circuits", - "url": "/api/qiskit/0.40/qiskit.assembler.assemble_circuits" - }, - { - "title": "assemble_schedules", - "url": "/api/qiskit/0.40/qiskit.assembler.assemble_schedules" - }, - { - "title": "disassemble", - "url": "/api/qiskit/0.40/qiskit.assembler.disassemble" - }, - { - "title": "RunConfig", - "url": "/api/qiskit/0.40/qiskit.assembler.RunConfig" - } - ] - }, - { - "title": "qiskit.circuit", - "children": [ - { - "title": "Overview", - "url": "/api/qiskit/0.40/circuit" - }, - { - "title": "AncillaQubit", - "url": "/api/qiskit/0.40/qiskit.circuit.AncillaQubit" - }, - { - "title": "AncillaRegister", - "url": "/api/qiskit/0.40/qiskit.circuit.AncillaRegister" + "title": "qiskit.algorithms.eigensolvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers" + }, + { + "title": "Eigensolver", + "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.Eigensolver" + }, + { + "title": "EigensolverResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.EigensolverResult" + }, + { + "title": "NumPyEigensolver", + "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolver" + }, + { + "title": "NumPyEigensolverResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.NumPyEigensolverResult" + }, + { + "title": "VQD", + "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQD" + }, + { + "title": "VQDResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.eigensolvers.VQDResult" + } + ] }, { - "title": "AND", - "url": "/api/qiskit/0.40/qiskit.circuit.library.AND" + "title": "qiskit.algorithms.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients" + }, + { + "title": "BaseEstimatorGradient", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.BaseEstimatorGradient" + }, + { + "title": "BaseQGT", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.BaseQGT" + }, + { + "title": "BaseSamplerGradient", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.BaseSamplerGradient" + }, + { + "title": "DerivativeType", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.DerivativeType" + }, + { + "title": "EstimatorGradientResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.EstimatorGradientResult" + }, + { + "title": "FiniteDiffEstimatorGradient", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient" + }, + { + "title": "FiniteDiffSamplerGradient", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.FiniteDiffSamplerGradient" + }, + { + "title": "LinCombEstimatorGradient", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombEstimatorGradient" + }, + { + "title": "LinCombQGT", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombQGT" + }, + { + "title": "LinCombSamplerGradient", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.LinCombSamplerGradient" + }, + { + "title": "ParamShiftEstimatorGradient", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftEstimatorGradient" + }, + { + "title": "ParamShiftSamplerGradient", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.ParamShiftSamplerGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.QFI" + }, + { + "title": "QFIResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.QFIResult" + }, + { + "title": "QGTResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.QGTResult" + }, + { + "title": "ReverseEstimatorGradient", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseEstimatorGradient" + }, + { + "title": "ReverseQGT", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.ReverseQGT" + }, + { + "title": "SamplerGradientResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.SamplerGradientResult" + }, + { + "title": "SPSAEstimatorGradient", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.SPSAEstimatorGradient" + }, + { + "title": "SPSASamplerGradient", + "url": "/api/qiskit/0.40/qiskit.algorithms.gradients.SPSASamplerGradient" + } + ] }, { - "title": "Barrier", - "url": "/api/qiskit/0.40/qiskit.circuit.library.Barrier" + "title": "qiskit.algorithms.linear_solvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers" + }, + { + "title": "AbsoluteAverage", + "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.AbsoluteAverage" + }, + { + "title": "HHL", + "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.HHL" + }, + { + "title": "LinearSolver", + "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolver" + }, + { + "title": "LinearSolverResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSolverResult" + }, + { + "title": "LinearSystemMatrix", + "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemMatrix" + }, + { + "title": "LinearSystemObservable", + "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.LinearSystemObservable" + }, + { + "title": "MatrixFunctional", + "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.MatrixFunctional" + }, + { + "title": "NumPyLinearSolver", + "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyLinearSolver" + }, + { + "title": "NumPyMatrix", + "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.NumPyMatrix" + }, + { + "title": "TridiagonalToeplitz", + "url": "/api/qiskit/0.40/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" + } + ] }, { - "title": "BreakLoopOp", - "url": "/api/qiskit/0.40/qiskit.circuit.BreakLoopOp" + "title": "qiskit.algorithms.minimum_eigensolvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers" + }, + { + "title": "AdaptVQE", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQE" + }, + { + "title": "AdaptVQEResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult" + }, + { + "title": "MinimumEigensolver", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver" + }, + { + "title": "MinimumEigensolverResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult" + }, + { + "title": "NumPyMinimumEigensolver", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver" + }, + { + "title": "NumPyMinimumEigensolverResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult" + }, + { + "title": "QAOA", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.QAOA" + }, + { + "title": "SamplingMinimumEigensolver", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver" + }, + { + "title": "SamplingMinimumEigensolverResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult" + }, + { + "title": "SamplingVQE", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQE" + }, + { + "title": "SamplingVQEResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult" + }, + { + "title": "VQE", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQE" + }, + { + "title": "VQEResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.VQEResult" + } + ] }, { - "title": "C3SXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.C3SXGate" + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "AskData", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.AskData" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GradientDescentState", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.GradientDescentState" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "Minimizer", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.Minimizer" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerResult" + }, + { + "title": "OptimizerState", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerState" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "SteppableOptimizer", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.SteppableOptimizer" + }, + { + "title": "TellData", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.TellData" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.TNC" + }, + { + "title": "UMDA", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.UMDA" + }, + { + "title": "qiskit.algorithms.optimizers.optimizer_utils", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils" + }, + { + "title": "LearningRate", + "url": "/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.LearningRate" + } + ] + } + ] }, { - "title": "C3XGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.C3XGate" + "title": "qiskit.algorithms.state_fidelities", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.algorithms.state_fidelities" + }, + { + "title": "BaseStateFidelity", + "url": "/api/qiskit/0.40/qiskit.algorithms.state_fidelities.BaseStateFidelity" + }, + { + "title": "ComputeUncompute", + "url": "/api/qiskit/0.40/qiskit.algorithms.state_fidelities.ComputeUncompute" + }, + { + "title": "StateFidelityResult", + "url": "/api/qiskit/0.40/qiskit.algorithms.state_fidelities.StateFidelityResult" + } + ] }, { - "title": "C4XGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.C4XGate" + "title": "qiskit.algorithms.time_evolvers.trotterization", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization" + }, + { + "title": "TrotterQRTE", + "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE" + } + ] }, { - "title": "CCXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CCXGate" - }, + "title": "qiskit.algorithms.time_evolvers.variational", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational" + }, + { + "title": "ForwardEulerSolver", + "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver" + }, + { + "title": "ImaginaryMcLachlanPrinciple", + "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple" + }, + { + "title": "ImaginaryVariationalPrinciple", + "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple" + }, + { + "title": "RealMcLachlanPrinciple", + "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple" + }, + { + "title": "RealVariationalPrinciple", + "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple" + }, + { + "title": "VariationalPrinciple", + "url": "/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple" + } + ] + } + ] + }, + { + "title": "qiskit.assembler", + "children": [ { - "title": "CDKMRippleCarryAdder", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CDKMRippleCarryAdder" + "title": "Overview", + "url": "/api/qiskit/0.40/assembler" }, { - "title": "CHGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CHGate" + "title": "assemble_circuits", + "url": "/api/qiskit/0.40/qiskit.assembler.assemble_circuits" }, { - "title": "CircuitInstruction", - "url": "/api/qiskit/0.40/qiskit.circuit.CircuitInstruction" + "title": "assemble_schedules", + "url": "/api/qiskit/0.40/qiskit.assembler.assemble_schedules" }, { - "title": "ClassicalRegister", - "url": "/api/qiskit/0.40/qiskit.circuit.ClassicalRegister" + "title": "disassemble", + "url": "/api/qiskit/0.40/qiskit.assembler.disassemble" }, { - "title": "Clbit", - "url": "/api/qiskit/0.40/qiskit.circuit.Clbit" - }, + "title": "RunConfig", + "url": "/api/qiskit/0.40/qiskit.assembler.RunConfig" + } + ] + }, + { + "title": "qiskit.circuit", + "children": [ { - "title": "clifford_2_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_2_1" + "title": "Overview", + "url": "/api/qiskit/0.40/circuit" }, { - "title": "clifford_2_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_2_2" + "title": "AncillaQubit", + "url": "/api/qiskit/0.40/qiskit.circuit.AncillaQubit" }, { - "title": "clifford_2_3", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_2_3" + "title": "AncillaRegister", + "url": "/api/qiskit/0.40/qiskit.circuit.AncillaRegister" }, { - "title": "clifford_2_4", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_2_4" - }, - { - "title": "clifford_3_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_3_1" - }, - { - "title": "clifford_4_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_4_1" - }, - { - "title": "clifford_4_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_4_2" - }, - { - "title": "clifford_4_3", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_4_3" - }, - { - "title": "clifford_4_4", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_4_4" - }, - { - "title": "clifford_5_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_5_1" - }, - { - "title": "clifford_6_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_6_1" - }, - { - "title": "clifford_6_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_6_2" - }, - { - "title": "clifford_6_3", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_6_3" - }, - { - "title": "clifford_6_4", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_6_4" - }, - { - "title": "clifford_6_5", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_6_5" + "title": "BreakLoopOp", + "url": "/api/qiskit/0.40/qiskit.circuit.BreakLoopOp" }, { - "title": "clifford_8_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_8_1" + "title": "CircuitInstruction", + "url": "/api/qiskit/0.40/qiskit.circuit.CircuitInstruction" }, { - "title": "clifford_8_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_8_2" + "title": "ClassicalRegister", + "url": "/api/qiskit/0.40/qiskit.circuit.ClassicalRegister" }, { - "title": "clifford_8_3", - "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_8_3" + "title": "Clbit", + "url": "/api/qiskit/0.40/qiskit.circuit.Clbit" }, { "title": "ContinueLoopOp", @@ -770,162 +747,26 @@ "title": "ControlledGate", "url": "/api/qiskit/0.40/qiskit.circuit.ControlledGate" }, - { - "title": "CPhaseGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CPhaseGate" - }, - { - "title": "CRXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CRXGate" - }, - { - "title": "CRYGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CRYGate" - }, - { - "title": "CRZGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CRZGate" - }, - { - "title": "CSwapGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CSwapGate" - }, - { - "title": "CSXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CSXGate" - }, - { - "title": "CU1Gate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CU1Gate" - }, - { - "title": "CU3Gate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CU3Gate" - }, - { - "title": "CUGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CUGate" - }, - { - "title": "CXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CXGate" - }, - { - "title": "CYGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CYGate" - }, - { - "title": "CZGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.CZGate" - }, - { - "title": "DCXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.DCXGate" - }, { "title": "Delay", "url": "/api/qiskit/0.40/qiskit.circuit.Delay" }, - { - "title": "Diagonal", - "url": "/api/qiskit/0.40/qiskit.circuit.library.Diagonal" - }, - { - "title": "DraperQFTAdder", - "url": "/api/qiskit/0.40/qiskit.circuit.library.DraperQFTAdder" - }, - { - "title": "ECRGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.ECRGate" - }, - { - "title": "EfficientSU2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.EfficientSU2" - }, { "title": "EquivalenceLibrary", "url": "/api/qiskit/0.40/qiskit.circuit.EquivalenceLibrary" }, - { - "title": "EvolvedOperatorAnsatz", - "url": "/api/qiskit/0.40/qiskit.circuit.library.EvolvedOperatorAnsatz" - }, - { - "title": "ExactReciprocal", - "url": "/api/qiskit/0.40/qiskit.circuit.library.ExactReciprocal" - }, - { - "title": "ExcitationPreserving", - "url": "/api/qiskit/0.40/qiskit.circuit.library.ExcitationPreserving" - }, { "title": "ForLoopOp", "url": "/api/qiskit/0.40/qiskit.circuit.ForLoopOp" }, - { - "title": "FourierChecking", - "url": "/api/qiskit/0.40/qiskit.circuit.library.FourierChecking" - }, - { - "title": "FunctionalPauliRotations", - "url": "/api/qiskit/0.40/qiskit.circuit.library.FunctionalPauliRotations" - }, { "title": "Gate", "url": "/api/qiskit/0.40/qiskit.circuit.Gate" }, - { - "title": "GMS", - "url": "/api/qiskit/0.40/qiskit.circuit.library.GMS" - }, - { - "title": "GR", - "url": "/api/qiskit/0.40/qiskit.circuit.library.GR" - }, - { - "title": "GraphState", - "url": "/api/qiskit/0.40/qiskit.circuit.library.GraphState" - }, - { - "title": "GroverOperator", - "url": "/api/qiskit/0.40/qiskit.circuit.library.GroverOperator" - }, - { - "title": "GRX", - "url": "/api/qiskit/0.40/qiskit.circuit.library.GRX" - }, - { - "title": "GRY", - "url": "/api/qiskit/0.40/qiskit.circuit.library.GRY" - }, - { - "title": "GRZ", - "url": "/api/qiskit/0.40/qiskit.circuit.library.GRZ" - }, - { - "title": "HGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.HGate" - }, - { - "title": "HiddenLinearFunction", - "url": "/api/qiskit/0.40/qiskit.circuit.library.HiddenLinearFunction" - }, - { - "title": "HRSCumulativeMultiplier", - "url": "/api/qiskit/0.40/qiskit.circuit.library.HRSCumulativeMultiplier" - }, { "title": "IfElseOp", "url": "/api/qiskit/0.40/qiskit.circuit.IfElseOp" }, - { - "title": "IGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.IGate" - }, - { - "title": "InnerProduct", - "url": "/api/qiskit/0.40/qiskit.circuit.library.InnerProduct" - }, { "title": "Instruction", "url": "/api/qiskit/0.40/qiskit.circuit.Instruction" @@ -934,78 +775,10 @@ "title": "InstructionSet", "url": "/api/qiskit/0.40/qiskit.circuit.InstructionSet" }, - { - "title": "IntegerComparator", - "url": "/api/qiskit/0.40/qiskit.circuit.library.IntegerComparator" - }, - { - "title": "IQP", - "url": "/api/qiskit/0.40/qiskit.circuit.library.IQP" - }, - { - "title": "iSwapGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.iSwapGate" - }, - { - "title": "LinearAmplitudeFunction", - "url": "/api/qiskit/0.40/qiskit.circuit.library.LinearAmplitudeFunction" - }, - { - "title": "LinearFunction", - "url": "/api/qiskit/0.40/qiskit.circuit.library.LinearFunction" - }, - { - "title": "LinearPauliRotations", - "url": "/api/qiskit/0.40/qiskit.circuit.library.LinearPauliRotations" - }, - { - "title": "MCMT", - "url": "/api/qiskit/0.40/qiskit.circuit.library.MCMT" - }, - { - "title": "MCMTVChain", - "url": "/api/qiskit/0.40/qiskit.circuit.library.MCMTVChain" - }, - { - "title": "MCPhaseGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.MCPhaseGate" - }, - { - "title": "MCXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.MCXGate" - }, - { - "title": "MCXGrayCode", - "url": "/api/qiskit/0.40/qiskit.circuit.library.MCXGrayCode" - }, - { - "title": "MCXRecursive", - "url": "/api/qiskit/0.40/qiskit.circuit.library.MCXRecursive" - }, - { - "title": "MCXVChain", - "url": "/api/qiskit/0.40/qiskit.circuit.library.MCXVChain" - }, - { - "title": "Measure", - "url": "/api/qiskit/0.40/qiskit.circuit.library.Measure" - }, - { - "title": "MSGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.MSGate" - }, - { - "title": "NLocal", - "url": "/api/qiskit/0.40/qiskit.circuit.library.NLocal" - }, { "title": "Operation", "url": "/api/qiskit/0.40/qiskit.circuit.Operation" }, - { - "title": "OR", - "url": "/api/qiskit/0.40/qiskit.circuit.library.OR" - }, { "title": "Parameter", "url": "/api/qiskit/0.40/qiskit.circuit.Parameter" @@ -1018,70 +791,6 @@ "title": "ParameterVector", "url": "/api/qiskit/0.40/qiskit.circuit.ParameterVector" }, - { - "title": "PauliEvolutionGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PauliEvolutionGate" - }, - { - "title": "PauliFeatureMap", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PauliFeatureMap" - }, - { - "title": "PauliGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PauliGate" - }, - { - "title": "PauliTwoDesign", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PauliTwoDesign" - }, - { - "title": "Permutation", - "url": "/api/qiskit/0.40/qiskit.circuit.library.Permutation" - }, - { - "title": "PermutationGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PermutationGate" - }, - { - "title": "PhaseEstimation", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PhaseEstimation" - }, - { - "title": "PhaseGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PhaseGate" - }, - { - "title": "PhaseOracle", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PhaseOracle" - }, - { - "title": "PiecewiseChebyshev", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PiecewiseChebyshev" - }, - { - "title": "PiecewiseLinearPauliRotations", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PiecewiseLinearPauliRotations" - }, - { - "title": "PiecewisePolynomialPauliRotations", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PiecewisePolynomialPauliRotations" - }, - { - "title": "PolynomialPauliRotations", - "url": "/api/qiskit/0.40/qiskit.circuit.library.PolynomialPauliRotations" - }, - { - "title": "QAOAAnsatz", - "url": "/api/qiskit/0.40/qiskit.circuit.library.QAOAAnsatz" - }, - { - "title": "QFT", - "url": "/api/qiskit/0.40/qiskit.circuit.library.QFT" - }, - { - "title": "QuadraticForm", - "url": "/api/qiskit/0.40/qiskit.circuit.library.QuadraticForm" - }, { "title": "QuantumCircuit", "url": "/api/qiskit/0.40/qiskit.circuit.QuantumCircuit" @@ -1090,10 +799,6 @@ "title": "QuantumRegister", "url": "/api/qiskit/0.40/qiskit.circuit.QuantumRegister" }, - { - "title": "QuantumVolume", - "url": "/api/qiskit/0.40/qiskit.circuit.library.QuantumVolume" - }, { "title": "Qubit", "url": "/api/qiskit/0.40/qiskit.circuit.Qubit" @@ -1103,391 +808,776 @@ "url": "/api/qiskit/0.40/qiskit.circuit.random.random_circuit" }, { - "title": "RC3XGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RC3XGate" - }, - { - "title": "RCCXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RCCXGate" - }, - { - "title": "RealAmplitudes", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RealAmplitudes" - }, - { - "title": "Reset", - "url": "/api/qiskit/0.40/qiskit.circuit.library.Reset" - }, - { - "title": "RGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RGate" - }, - { - "title": "RGQFTMultiplier", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RGQFTMultiplier" - }, - { - "title": "RVGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RVGate" - }, - { - "title": "RXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RXGate" - }, - { - "title": "RXXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RXXGate" - }, - { - "title": "RYGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RYGate" - }, - { - "title": "RYYGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RYYGate" - }, - { - "title": "RZGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RZGate" - }, - { - "title": "rzx_cy", - "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_cy" - }, - { - "title": "rzx_xz", - "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_xz" - }, - { - "title": "rzx_yz", - "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_yz" - }, - { - "title": "rzx_zz1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_zz1" - }, - { - "title": "rzx_zz2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_zz2" - }, - { - "title": "rzx_zz3", - "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_zz3" - }, - { - "title": "RZXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RZXGate" - }, - { - "title": "RZZGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.RZZGate" - }, - { - "title": "SdgGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.SdgGate" - }, - { - "title": "SGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.SGate" - }, - { - "title": "StatePreparation", - "url": "/api/qiskit/0.40/qiskit.circuit.library.StatePreparation" - }, - { - "title": "SwapGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.SwapGate" - }, - { - "title": "SXdgGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.SXdgGate" - }, - { - "title": "SXGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.SXGate" - }, - { - "title": "TdgGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.TdgGate" - }, - { - "title": "template_nct_2a_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_1" - }, - { - "title": "template_nct_2a_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_2" - }, - { - "title": "template_nct_2a_3", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_3" - }, - { - "title": "template_nct_4a_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_1" - }, - { - "title": "template_nct_4a_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_2" - }, - { - "title": "template_nct_4a_3", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_3" + "title": "WhileLoopOp", + "url": "/api/qiskit/0.40/qiskit.circuit.WhileLoopOp" }, { - "title": "template_nct_4b_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_1" + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.40/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] }, { - "title": "template_nct_4b_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_2" - }, - { - "title": "template_nct_5a_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_1" - }, - { - "title": "template_nct_5a_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_2" - }, - { - "title": "template_nct_5a_3", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_3" - }, - { - "title": "template_nct_5a_4", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_4" - }, - { - "title": "template_nct_6a_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_1" - }, - { - "title": "template_nct_6a_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_2" - }, - { - "title": "template_nct_6a_3", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_3" - }, - { - "title": "template_nct_6a_4", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_4" - }, - { - "title": "template_nct_6b_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_1" - }, - { - "title": "template_nct_6b_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_2" - }, - { - "title": "template_nct_6c_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6c_1" - }, - { - "title": "template_nct_7a_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7a_1" - }, - { - "title": "template_nct_7b_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7b_1" - }, - { - "title": "template_nct_7c_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7c_1" - }, - { - "title": "template_nct_7d_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7d_1" - }, - { - "title": "template_nct_7e_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7e_1" - }, - { - "title": "template_nct_9a_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9a_1" - }, - { - "title": "template_nct_9c_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_1" - }, - { - "title": "template_nct_9c_10", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_10" - }, - { - "title": "template_nct_9c_11", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_11" - }, - { - "title": "template_nct_9c_12", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_12" - }, - { - "title": "template_nct_9c_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_2" - }, - { - "title": "template_nct_9c_3", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_3" - }, - { - "title": "template_nct_9c_4", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_4" - }, - { - "title": "template_nct_9c_5", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_5" - }, - { - "title": "template_nct_9c_6", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_6" - }, - { - "title": "template_nct_9c_7", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_7" - }, - { - "title": "template_nct_9c_8", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_8" - }, - { - "title": "template_nct_9c_9", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_9" - }, - { - "title": "template_nct_9d_1", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_1" - }, - { - "title": "template_nct_9d_10", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_10" - }, - { - "title": "template_nct_9d_2", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_2" - }, - { - "title": "template_nct_9d_3", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_3" - }, - { - "title": "template_nct_9d_4", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_4" - }, - { - "title": "template_nct_9d_5", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_5" - }, - { - "title": "template_nct_9d_6", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_6" - }, - { - "title": "template_nct_9d_7", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_7" - }, - { - "title": "template_nct_9d_8", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_8" - }, - { - "title": "template_nct_9d_9", - "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_9" - }, - { - "title": "TGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.TGate" - }, - { - "title": "TwoLocal", - "url": "/api/qiskit/0.40/qiskit.circuit.library.TwoLocal" - }, - { - "title": "U1Gate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.U1Gate" - }, - { - "title": "U2Gate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.U2Gate" - }, - { - "title": "U3Gate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.U3Gate" - }, - { - "title": "UGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.UGate" - }, - { - "title": "VBERippleCarryAdder", - "url": "/api/qiskit/0.40/qiskit.circuit.library.VBERippleCarryAdder" - }, - { - "title": "WeightedAdder", - "url": "/api/qiskit/0.40/qiskit.circuit.library.WeightedAdder" - }, - { - "title": "WhileLoopOp", - "url": "/api/qiskit/0.40/qiskit.circuit.WhileLoopOp" - }, - { - "title": "XGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.XGate" - }, - { - "title": "XOR", - "url": "/api/qiskit/0.40/qiskit.circuit.library.XOR" - }, - { - "title": "XXMinusYYGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.XXMinusYYGate" - }, - { - "title": "XXPlusYYGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.XXPlusYYGate" - }, - { - "title": "YGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.YGate" - }, - { - "title": "ZFeatureMap", - "url": "/api/qiskit/0.40/qiskit.circuit.library.ZFeatureMap" - }, - { - "title": "ZGate", - "url": "/api/qiskit/0.40/qiskit.circuit.library.ZGate" - }, - { - "title": "ZZFeatureMap", - "url": "/api/qiskit/0.40/qiskit.circuit.library.ZZFeatureMap" - }, - { - "title": "qiskit.circuit.classicalfunction", + "title": "qiskit.circuit.library", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.40/classicalfunction" + "title": "Overview", + "url": "/api/qiskit/0.40/circuit_library" + }, + { + "title": "AND", + "url": "/api/qiskit/0.40/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.40/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CHGate" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.40/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.DCXGate" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.40/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.40/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.40/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExactReciprocal", + "url": "/api/qiskit/0.40/qiskit.circuit.library.ExactReciprocal" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.40/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.40/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.40/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.40/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.40/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.40/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.40/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.40/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.40/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.40/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.40/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.40/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.40/qiskit.circuit.library.InnerProduct" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.40/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.40/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.40/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearFunction", + "url": "/api/qiskit/0.40/qiskit.circuit.library.LinearFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.40/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.40/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.40/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.40/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.40/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.40/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.40/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.40/qiskit.circuit.library.NLocal" + }, + { + "title": "OR", + "url": "/api/qiskit/0.40/qiskit.circuit.library.OR" + }, + { + "title": "PauliEvolutionGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PauliEvolutionGate" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.40/qiskit.circuit.library.Permutation" + }, + { + "title": "PermutationGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PermutationGate" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.40/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.40/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.40/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.40/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.40/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.40/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.40/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.SGate" + }, + { + "title": "StatePreparation", + "url": "/api/qiskit/0.40/qiskit.circuit.library.StatePreparation" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.40/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.40/qiskit.circuit.library.TwoLocal" }, { - "title": "BooleanExpression", - "url": "/api/qiskit/0.40/qiskit.circuit.classicalfunction.BooleanExpression" + "title": "U1Gate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.U1Gate" }, { - "title": "ClassicalFunction", - "url": "/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunction" + "title": "U2Gate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.U2Gate" }, { - "title": "ClassicalFunctionCompilerTypeError", - "url": "/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + "title": "U3Gate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.U3Gate" }, { - "title": "ClassicalFunctionParseError", - "url": "/api/qiskit/0.40/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + "title": "UGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.UGate" + }, + { + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.40/qiskit.circuit.library.VBERippleCarryAdder" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.40/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.40/qiskit.circuit.library.XOR" + }, + { + "title": "XXMinusYYGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.XXMinusYYGate" + }, + { + "title": "XXPlusYYGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.XXPlusYYGate" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.40/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.40/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.40/qiskit.circuit.library.ZZFeatureMap" } ] } @@ -1668,225 +1758,288 @@ "title": "Overview", "url": "/api/qiskit/0.40/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.40/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.40/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.40/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.40/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.40/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.40/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.40/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.40/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.40/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.40/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.40/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.40/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.40/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.40/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.40/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.40/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.40/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.40/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.40/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.40/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.40/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.40/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.40/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.40/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.40/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.40/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.40/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.40/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.40/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.40/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.40/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.40/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.40/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.40/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.40/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.40/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.40/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.40/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.40/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.40/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.40/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.40/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.40/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.40/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.40/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.40/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.40/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.40/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.40/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.40/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.40/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.40/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.40/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.40/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.40/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.40/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.40/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.40/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3595,6 +3748,14 @@ "title": "Overview", "url": "/api/qiskit/0.40/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.40/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.40/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.40/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.40/circuit_library.md b/docs/api/qiskit/0.40/circuit_library.md index b6c90c9d576..243a6d4c0ed 100644 --- a/docs/api/qiskit/0.40/circuit_library.md +++ b/docs/api/qiskit/0.40/circuit_library.md @@ -1,8 +1,20 @@ +--- +title: library +description: API reference for qiskit.circuit.library +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.circuit.library +--- + # Circuit Library -## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library")) +## Circuit Library + + + +`qiskit.circuit.library` The circuit library is a collection of well-studied and valuable circuits, directives, and gates. We call them valuable for different reasons, for instance they can serve as building blocks for algorithms or they are circuits that we think are hard to simulate classically. @@ -384,3 +396,4 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui | [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | | [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | + diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.md b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.md index 85b4bee7c28..d226b69b4b1 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.eigensolvers.md @@ -1,8 +1,20 @@ +--- +title: eigensolvers +description: API reference for qiskit.algorithms.eigensolvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.eigensolvers +--- + # qiskit.algorithms.eigensolvers -## Eigensolvers Package ([`qiskit.algorithms.eigensolvers`](#module-qiskit.algorithms.eigensolvers "qiskit.algorithms.eigensolvers")) +## Eigensolvers Package + + + +`qiskit.algorithms.eigensolvers` ### Eigensolvers @@ -19,3 +31,4 @@ > | [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.EigensolverResult")() | Eigensolver result. | > | [`NumPyEigensolverResult`](qiskit.algorithms.eigensolvers.NumPyEigensolverResult "qiskit.algorithms.eigensolvers.NumPyEigensolverResult")() | NumPy eigensolver result. | > | [`VQDResult`](qiskit.algorithms.eigensolvers.VQDResult "qiskit.algorithms.eigensolvers.VQDResult")() | VQD Result. | + diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.md b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.md index 7b8988f878a..ccaf77374e8 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.gradients.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.algorithms.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.gradients +--- + # qiskit.algorithms.gradients -## Gradients ([`qiskit.algorithms.gradients`](#module-qiskit.algorithms.gradients "qiskit.algorithms.gradients")) +## Gradients + + + +`qiskit.algorithms.gradients` ### Estimator Gradients @@ -43,3 +55,4 @@ | [`QFIResult`](qiskit.algorithms.gradients.QFIResult "qiskit.algorithms.gradients.QFIResult")(qfis, metadata, options) | Result of QFI. | | [`QGTResult`](qiskit.algorithms.gradients.QGTResult "qiskit.algorithms.gradients.QGTResult")(qgts, derivative\_type, metadata, ...) | Result of QGT. | | [`SamplerGradientResult`](qiskit.algorithms.gradients.SamplerGradientResult "qiskit.algorithms.gradients.SamplerGradientResult")(gradients, metadata, ...) | Result of SamplerGradient. | + diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.md b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.md index 572c4585cea..7503a96b25d 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.linear_solvers.md @@ -1,16 +1,28 @@ +--- +title: linear_solvers +description: API reference for qiskit.algorithms.linear_solvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.linear_solvers +--- + # qiskit.algorithms.linear\_solvers -## The deprecated Linear solvers ([`qiskit.algorithms.linear_solvers`](#module-qiskit.algorithms.linear_solvers "qiskit.algorithms.linear_solvers")) +## The deprecated Linear solvers + + + +`qiskit.algorithms.linear_solvers` It contains classical and quantum algorithms to solve systems of linear equations such as `HHL`. Although the quantum algorithm accepts a general Hermitian matrix as input, Qiskit’s default Hamiltonian evolution is exponential in such cases and therefore the quantum linear solver will not achieve an exponential speedup. Furthermore, the quantum algorithm can find a solution exponentially faster in the size of the system than their classical counterparts (i.e. logarithmic complexity instead of polynomial), meaning that reading the full solution vector would kill such speedup (since this would take linear time in the size of the system). Therefore, to achieve an exponential speedup we can only compute functions from the solution vector (the so called observables) to learn information about the solution. Known efficient implementations of Hamiltonian evolutions or observables are contained in the following subfolders: -## [Matrices](#matrices) +**[Matrices](#matrices)** A placeholder for efficient implementations of the Hamiltonian evolution of particular types of matrices. -## [Observables](#observables) +**[Observables](#observables)** A placeholder for efficient implementations of functions that can be computed from the solution vector to a system of linear equations. @@ -38,3 +50,4 @@ A placeholder for efficient implementations of functions that can be computed fr | [`LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.LinearSystemObservable")() | The deprecated abstract class for linear system observables in Qiskit. | | [`AbsoluteAverage`](qiskit.algorithms.linear_solvers.AbsoluteAverage "qiskit.algorithms.linear_solvers.AbsoluteAverage")() | The deprecated observable for the absolute average of a linear system of equations solution. | | [`MatrixFunctional`](qiskit.algorithms.linear_solvers.MatrixFunctional "qiskit.algorithms.linear_solvers.MatrixFunctional")(main\_diag, off\_diag) | The deprecated class for the matrix functional of the vector solution to the linear systems. | + diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.md b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.md index 618bfe92c3d..4b56d4a91d1 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.minimum_eigensolvers.md @@ -1,8 +1,20 @@ +--- +title: minimum_eigensolvers +description: API reference for qiskit.algorithms.minimum_eigensolvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.minimum_eigensolvers +--- + # qiskit.algorithms.minimum\_eigensolvers -## Minimum Eigensolvers Package ([`qiskit.algorithms.minimum_eigensolvers`](#module-qiskit.algorithms.minimum_eigensolvers "qiskit.algorithms.minimum_eigensolvers")) +## Minimum Eigensolvers Package + + + +`qiskit.algorithms.minimum_eigensolvers` ### Minimum Eigensolvers @@ -24,3 +36,4 @@ | [`AdaptVQEResult`](qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult "qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult")() | AdaptVQE Result. | | [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult")() | Sampling Minimum Eigensolver Result. | | [`SamplingVQEResult`](qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult "qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult")() | VQE Result. | + diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.md index 4f7358a6dd6..3d91ef1d6be 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -78,3 +90,4 @@ The global optimizers here all use NLopt for their core function and can only be | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.md b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.md index e0bb9c1fc0b..843dbcc62db 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.optimizer_utils.md @@ -1,11 +1,24 @@ +--- +title: optimizer_utils +description: API reference for qiskit.algorithms.optimizers.optimizer_utils +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.optimizer_utils +--- + # qiskit.algorithms.optimizers.optimizer\_utils Utils for optimizers -## Optimizer Utils ([`qiskit.algorithms.optimizers.optimizer_utils`](#module-qiskit.algorithms.optimizers.optimizer_utils "qiskit.algorithms.optimizers.optimizer_utils")) +## Optimizer Utils + + + +`qiskit.algorithms.optimizers.optimizer_utils` | | | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | [`LearningRate`](qiskit.algorithms.optimizers.optimizer_utils.LearningRate "qiskit.algorithms.optimizers.optimizer_utils.LearningRate") | Represents a Learning Rate. | + diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.md b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.md index 4e8e2b3fccd..40b08327fe3 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.state_fidelities.md @@ -1,8 +1,20 @@ +--- +title: state_fidelities +description: API reference for qiskit.algorithms.state_fidelities +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.state_fidelities +--- + # qiskit.algorithms.state\_fidelities -## State Fidelity Interfaces ([`qiskit.algorithms.state_fidelities`](#module-qiskit.algorithms.state_fidelities "qiskit.algorithms.state_fidelities")) +## State Fidelity Interfaces + + + +`qiskit.algorithms.state_fidelities` ### State Fidelities @@ -16,3 +28,4 @@ > | | | > | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | > | [`StateFidelityResult`](qiskit.algorithms.state_fidelities.StateFidelityResult "qiskit.algorithms.state_fidelities.StateFidelityResult")(fidelities, ...) | This class stores the result of StateFidelity computations. | + diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.md b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.md index 8f7eab51946..72b5e31139c 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.trotterization.md @@ -1,3 +1,11 @@ +--- +title: trotterization +description: API reference for qiskit.algorithms.time_evolvers.trotterization +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.time_evolvers.trotterization +--- + # qiskit.algorithms.time\_evolvers.trotterization @@ -9,3 +17,4 @@ This package contains Trotterization-based Quantum Real Time Evolution algorithm | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | | [`TrotterQRTE`](qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE "qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE") | Quantum Real Time Evolution using Trotterization. | + diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.md b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.md index 7d3be939619..73c7be14052 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.md +++ b/docs/api/qiskit/0.40/qiskit.algorithms.time_evolvers.variational.md @@ -1,8 +1,20 @@ +--- +title: variational +description: API reference for qiskit.algorithms.time_evolvers.variational +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.time_evolvers.variational +--- + # qiskit.algorithms.time\_evolvers.variational -## Variational Quantum Time Evolutions ([`qiskit.algorithms.time_evolvers.variational`](#module-qiskit.algorithms.time_evolvers.variational "qiskit.algorithms.time_evolvers.variational")) +## Variational Quantum Time Evolutions + + + +`qiskit.algorithms.time_evolvers.variational` Algorithms for performing Variational Quantum Time Evolution of quantum states, which can be tailored to near-term devices. `VarQTE` base class exposes an interface, compliant with the Quantum Time Evolution Framework in Qiskit Terra, that is implemented by [`VarQRTE`](qiskit.algorithms.VarQRTE "qiskit.algorithms.VarQRTE") and [`VarQITE`](qiskit.algorithms.VarQITE "qiskit.algorithms.VarQITE") classes for real and imaginary time evolution respectively. The variational approach is taken according to a variational principle chosen by a user. @@ -59,3 +71,4 @@ ODE solvers that implement the SciPy ODE Solver interface. The Forward Euler Sol | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | [`ForwardEulerSolver`](qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver "qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver")(function, t0, y0, t\_bound) | Forward Euler ODE solver. | + diff --git a/docs/api/qiskit/0.40/qiskit.opflow.converters.md b/docs/api/qiskit/0.40/qiskit.opflow.converters.md index 78c8d772f6c..fd81b2d76b6 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, ...]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, ...]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.md index 901c1a93987..56d09f9e3a1 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive "bookends" strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.40/qiskit.opflow.expectations.md b/docs/api/qiskit/0.40/qiskit.opflow.expectations.md index 40f57dfa261..df598260d9d 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.40/qiskit.opflow.gradients.md b/docs/api/qiskit/0.40/qiskit.opflow.gradients.md index e4558f4e2ea..af71ebe3bf7 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, ...]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.md index 71b2cd119a1..51994b092bd 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.md index 356f54afb31..49e0db5a490 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.md index 2ffffc20990..e374b0766ed 100644 --- a/docs/api/qiskit/0.40/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.40/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, ...]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, ...]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.40/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.40/qiskit.scheduler.methods.basic.md index 6d0ab513269..6bef8c60c54 100644 --- a/docs/api/qiskit/0.40/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.40/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as late as possible" (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as soon as possible" (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.40/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.40/qiskit.scheduler.schedule_circuit.md index a9e2086d690..36e4ab21f18 100644 --- a/docs/api/qiskit/0.40/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.40/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | ----------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, ...]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.41/_toc.json b/docs/api/qiskit/0.41/_toc.json index 96e4791af6e..b8e4d219ec2 100644 --- a/docs/api/qiskit/0.41/_toc.json +++ b/docs/api/qiskit/0.41/_toc.json @@ -12,22 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.41/algorithms" }, - { - "title": "AbsoluteAverage", - "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage" - }, - { - "title": "ADAM", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM" - }, - { - "title": "AdaptVQE", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE" - }, - { - "title": "AdaptVQEResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.41/qiskit.algorithms.AlgorithmError" @@ -60,82 +44,14 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "AskData", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData" - }, - { - "title": "BaseEstimatorGradient", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient" - }, - { - "title": "BaseQGT", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT" - }, - { - "title": "BaseSamplerGradient", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient" - }, - { - "title": "BaseStateFidelity", - "url": "/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "ComputeUncompute", - "url": "/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DerivativeType", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.41/qiskit.algorithms.Eigensolver" }, - { - "title": "Eigensolver", - "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver" - }, { "title": "EigensolverResult", "url": "/api/qiskit/0.41/qiskit.algorithms.EigensolverResult" }, - { - "title": "EigensolverResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult" - }, - { - "title": "ESCH", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH" - }, { "title": "estimate_observables", "url": "/api/qiskit/0.41/qiskit.algorithms.estimate_observables" @@ -144,10 +60,6 @@ "title": "EstimationProblem", "url": "/api/qiskit/0.41/qiskit.algorithms.EstimationProblem" }, - { - "title": "EstimatorGradientResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult" - }, { "title": "eval_observables", "url": "/api/qiskit/0.41/qiskit.algorithms.eval_observables" @@ -168,26 +80,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "FiniteDiffEstimatorGradient", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient" - }, - { - "title": "FiniteDiffSamplerGradient", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient" - }, - { - "title": "ForwardEulerSolver", - "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver" - }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent" - }, - { - "title": "GradientDescentState", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState" - }, { "title": "Grover", "url": "/api/qiskit/0.41/qiskit.algorithms.Grover" @@ -196,10 +88,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.41/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -208,34 +96,14 @@ "title": "HamiltonianPhaseEstimationResult", "url": "/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult" }, - { - "title": "HHL", - "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL" - }, { "title": "ImaginaryEvolver", "url": "/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver" }, - { - "title": "ImaginaryMcLachlanPrinciple", - "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple" - }, { "title": "ImaginaryTimeEvolver", "url": "/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver" }, - { - "title": "ImaginaryVariationalPrinciple", - "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple" - }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -248,46 +116,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B" - }, - { - "title": "LearningRate", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate" - }, - { - "title": "LinCombEstimatorGradient", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient" - }, - { - "title": "LinCombQGT", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT" - }, - { - "title": "LinCombSamplerGradient", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient" - }, - { - "title": "LinearSolver", - "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver" - }, - { - "title": "LinearSolverResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult" - }, - { - "title": "LinearSystemMatrix", - "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix" - }, - { - "title": "LinearSystemObservable", - "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable" - }, - { - "title": "MatrixFunctional", - "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional" - }, { "title": "MaximumLikelihoodAmplitudeEstimation", "url": "/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation" @@ -296,94 +124,22 @@ "title": "MaximumLikelihoodAmplitudeEstimationResult", "url": "/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult" }, - { - "title": "Minimizer", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer" - }, { "title": "MinimumEigensolver", "url": "/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver" }, - { - "title": "MinimumEigensolver", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver" - }, { "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "MinimumEigensolverResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult" - }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver" }, - { - "title": "NumPyEigensolver", - "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver" - }, - { - "title": "NumPyEigensolverResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult" - }, - { - "title": "NumPyLinearSolver", - "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver" - }, - { - "title": "NumPyMatrix", - "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix" - }, { "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "NumPyMinimumEigensolver", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver" - }, - { - "title": "NumPyMinimumEigensolverResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult" - }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult" - }, - { - "title": "OptimizerState", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS" - }, - { - "title": "ParamShiftEstimatorGradient", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient" - }, - { - "title": "ParamShiftSamplerGradient", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation" @@ -396,10 +152,6 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL" - }, { "title": "PVQD", "url": "/api/qiskit/0.41/qiskit.algorithms.PVQD" @@ -412,78 +164,18 @@ "title": "QAOA", "url": "/api/qiskit/0.41/qiskit.algorithms.QAOA" }, - { - "title": "QAOA", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.QFI" - }, - { - "title": "QFIResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult" - }, - { - "title": "QGTResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult" - }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA" - }, { "title": "RealEvolver", "url": "/api/qiskit/0.41/qiskit.algorithms.RealEvolver" }, - { - "title": "RealMcLachlanPrinciple", - "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple" - }, { "title": "RealTimeEvolver", "url": "/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver" }, - { - "title": "RealVariationalPrinciple", - "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple" - }, - { - "title": "ReverseEstimatorGradient", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient" - }, - { - "title": "ReverseQGT", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT" - }, - { - "title": "SamplerGradientResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult" - }, - { - "title": "SamplingMinimumEigensolver", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver" - }, - { - "title": "SamplingMinimumEigensolverResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult" - }, - { - "title": "SamplingVQE", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE" - }, - { - "title": "SamplingVQEResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult" - }, { "title": "SciPyImaginaryEvolver", "url": "/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver" }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "SciPyRealEvolver", "url": "/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver" @@ -496,38 +188,6 @@ "title": "ShorResult", "url": "/api/qiskit/0.41/qiskit.algorithms.ShorResult" }, - { - "title": "SLSQP", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "SPSAEstimatorGradient", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient" - }, - { - "title": "SPSASamplerGradient", - "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient" - }, - { - "title": "StateFidelityResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult" - }, - { - "title": "SteppableOptimizer", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer" - }, - { - "title": "TellData", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData" - }, { "title": "TimeEvolutionProblem", "url": "/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem" @@ -536,30 +196,10 @@ "title": "TimeEvolutionResult", "url": "/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult" }, - { - "title": "TNC", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC" - }, - { - "title": "TridiagonalToeplitz", - "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" - }, { "title": "TrotterQRTE", "url": "/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE" }, - { - "title": "TrotterQRTE", - "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE" - }, - { - "title": "UMDA", - "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA" - }, - { - "title": "VariationalPrinciple", - "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple" - }, { "title": "VarQITE", "url": "/api/qiskit/0.41/qiskit.algorithms.VarQITE" @@ -572,29 +212,470 @@ "title": "VQD", "url": "/api/qiskit/0.41/qiskit.algorithms.VQD" }, - { - "title": "VQD", - "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD" - }, { "title": "VQDResult", "url": "/api/qiskit/0.41/qiskit.algorithms.VQDResult" }, - { - "title": "VQDResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult" - }, { "title": "VQE", "url": "/api/qiskit/0.41/qiskit.algorithms.VQE" }, { - "title": "VQE", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE" + "title": "qiskit.algorithms.eigensolvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers" + }, + { + "title": "Eigensolver", + "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver" + }, + { + "title": "EigensolverResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult" + }, + { + "title": "NumPyEigensolver", + "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver" + }, + { + "title": "NumPyEigensolverResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult" + }, + { + "title": "VQD", + "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD" + }, + { + "title": "VQDResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult" + } + ] + }, + { + "title": "qiskit.algorithms.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients" + }, + { + "title": "BaseEstimatorGradient", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient" + }, + { + "title": "BaseQGT", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT" + }, + { + "title": "BaseSamplerGradient", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient" + }, + { + "title": "DerivativeType", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType" + }, + { + "title": "EstimatorGradientResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult" + }, + { + "title": "FiniteDiffEstimatorGradient", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient" + }, + { + "title": "FiniteDiffSamplerGradient", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient" + }, + { + "title": "LinCombEstimatorGradient", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient" + }, + { + "title": "LinCombQGT", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT" + }, + { + "title": "LinCombSamplerGradient", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient" + }, + { + "title": "ParamShiftEstimatorGradient", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient" + }, + { + "title": "ParamShiftSamplerGradient", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.QFI" + }, + { + "title": "QFIResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult" + }, + { + "title": "QGTResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult" + }, + { + "title": "ReverseEstimatorGradient", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient" + }, + { + "title": "ReverseQGT", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT" + }, + { + "title": "SamplerGradientResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult" + }, + { + "title": "SPSAEstimatorGradient", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient" + }, + { + "title": "SPSASamplerGradient", + "url": "/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient" + } + ] + }, + { + "title": "qiskit.algorithms.linear_solvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers" + }, + { + "title": "AbsoluteAverage", + "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage" + }, + { + "title": "HHL", + "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL" + }, + { + "title": "LinearSolver", + "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver" + }, + { + "title": "LinearSolverResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult" + }, + { + "title": "LinearSystemMatrix", + "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix" + }, + { + "title": "LinearSystemObservable", + "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable" + }, + { + "title": "MatrixFunctional", + "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional" + }, + { + "title": "NumPyLinearSolver", + "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver" + }, + { + "title": "NumPyMatrix", + "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix" + }, + { + "title": "TridiagonalToeplitz", + "url": "/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" + } + ] + }, + { + "title": "qiskit.algorithms.minimum_eigensolvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers" + }, + { + "title": "AdaptVQE", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE" + }, + { + "title": "AdaptVQEResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult" + }, + { + "title": "MinimumEigensolver", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver" + }, + { + "title": "MinimumEigensolverResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult" + }, + { + "title": "NumPyMinimumEigensolver", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver" + }, + { + "title": "NumPyMinimumEigensolverResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult" + }, + { + "title": "QAOA", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA" + }, + { + "title": "SamplingMinimumEigensolver", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver" + }, + { + "title": "SamplingMinimumEigensolverResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult" + }, + { + "title": "SamplingVQE", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE" + }, + { + "title": "SamplingVQEResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult" + }, + { + "title": "VQE", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE" + }, + { + "title": "VQEResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult" + } + ] + }, + { + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "AskData", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GradientDescentState", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "Minimizer", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult" + }, + { + "title": "OptimizerState", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "SteppableOptimizer", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer" + }, + { + "title": "TellData", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC" + }, + { + "title": "UMDA", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA" + }, + { + "title": "qiskit.algorithms.optimizers.optimizer_utils", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils" + }, + { + "title": "LearningRate", + "url": "/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate" + } + ] + } + ] + }, + { + "title": "qiskit.algorithms.state_fidelities", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.algorithms.state_fidelities" + }, + { + "title": "BaseStateFidelity", + "url": "/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity" + }, + { + "title": "ComputeUncompute", + "url": "/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute" + }, + { + "title": "StateFidelityResult", + "url": "/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult" + } + ] + }, + { + "title": "qiskit.algorithms.time_evolvers.trotterization", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization" + }, + { + "title": "TrotterQRTE", + "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE" + } + ] }, { - "title": "VQEResult", - "url": "/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult" + "title": "qiskit.algorithms.time_evolvers.variational", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational" + }, + { + "title": "ForwardEulerSolver", + "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver" + }, + { + "title": "ImaginaryMcLachlanPrinciple", + "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple" + }, + { + "title": "ImaginaryVariationalPrinciple", + "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple" + }, + { + "title": "RealMcLachlanPrinciple", + "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple" + }, + { + "title": "RealVariationalPrinciple", + "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple" + }, + { + "title": "VariationalPrinciple", + "url": "/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple" + } + ] } ] }, @@ -1677,225 +1758,288 @@ "title": "Overview", "url": "/api/qiskit/0.41/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.41/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.41/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.41/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.41/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.41/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.41/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.41/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.41/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.41/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.41/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.41/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.41/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3604,6 +3748,14 @@ "title": "Overview", "url": "/api/qiskit/0.41/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.41/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.41/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.md index 85b4bee7c28..d226b69b4b1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.md @@ -1,8 +1,20 @@ +--- +title: eigensolvers +description: API reference for qiskit.algorithms.eigensolvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.eigensolvers +--- + # qiskit.algorithms.eigensolvers -## Eigensolvers Package ([`qiskit.algorithms.eigensolvers`](#module-qiskit.algorithms.eigensolvers "qiskit.algorithms.eigensolvers")) +## Eigensolvers Package + + + +`qiskit.algorithms.eigensolvers` ### Eigensolvers @@ -19,3 +31,4 @@ > | [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.EigensolverResult")() | Eigensolver result. | > | [`NumPyEigensolverResult`](qiskit.algorithms.eigensolvers.NumPyEigensolverResult "qiskit.algorithms.eigensolvers.NumPyEigensolverResult")() | NumPy eigensolver result. | > | [`VQDResult`](qiskit.algorithms.eigensolvers.VQDResult "qiskit.algorithms.eigensolvers.VQDResult")() | VQD Result. | + diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.md index 7b8988f878a..ccaf77374e8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.algorithms.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.gradients +--- + # qiskit.algorithms.gradients -## Gradients ([`qiskit.algorithms.gradients`](#module-qiskit.algorithms.gradients "qiskit.algorithms.gradients")) +## Gradients + + + +`qiskit.algorithms.gradients` ### Estimator Gradients @@ -43,3 +55,4 @@ | [`QFIResult`](qiskit.algorithms.gradients.QFIResult "qiskit.algorithms.gradients.QFIResult")(qfis, metadata, options) | Result of QFI. | | [`QGTResult`](qiskit.algorithms.gradients.QGTResult "qiskit.algorithms.gradients.QGTResult")(qgts, derivative\_type, metadata, ...) | Result of QGT. | | [`SamplerGradientResult`](qiskit.algorithms.gradients.SamplerGradientResult "qiskit.algorithms.gradients.SamplerGradientResult")(gradients, metadata, ...) | Result of SamplerGradient. | + diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.md index 572c4585cea..7503a96b25d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.md @@ -1,16 +1,28 @@ +--- +title: linear_solvers +description: API reference for qiskit.algorithms.linear_solvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.linear_solvers +--- + # qiskit.algorithms.linear\_solvers -## The deprecated Linear solvers ([`qiskit.algorithms.linear_solvers`](#module-qiskit.algorithms.linear_solvers "qiskit.algorithms.linear_solvers")) +## The deprecated Linear solvers + + + +`qiskit.algorithms.linear_solvers` It contains classical and quantum algorithms to solve systems of linear equations such as `HHL`. Although the quantum algorithm accepts a general Hermitian matrix as input, Qiskit’s default Hamiltonian evolution is exponential in such cases and therefore the quantum linear solver will not achieve an exponential speedup. Furthermore, the quantum algorithm can find a solution exponentially faster in the size of the system than their classical counterparts (i.e. logarithmic complexity instead of polynomial), meaning that reading the full solution vector would kill such speedup (since this would take linear time in the size of the system). Therefore, to achieve an exponential speedup we can only compute functions from the solution vector (the so called observables) to learn information about the solution. Known efficient implementations of Hamiltonian evolutions or observables are contained in the following subfolders: -## [Matrices](#matrices) +**[Matrices](#matrices)** A placeholder for efficient implementations of the Hamiltonian evolution of particular types of matrices. -## [Observables](#observables) +**[Observables](#observables)** A placeholder for efficient implementations of functions that can be computed from the solution vector to a system of linear equations. @@ -38,3 +50,4 @@ A placeholder for efficient implementations of functions that can be computed fr | [`LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.LinearSystemObservable")() | The deprecated abstract class for linear system observables in Qiskit. | | [`AbsoluteAverage`](qiskit.algorithms.linear_solvers.AbsoluteAverage "qiskit.algorithms.linear_solvers.AbsoluteAverage")() | The deprecated observable for the absolute average of a linear system of equations solution. | | [`MatrixFunctional`](qiskit.algorithms.linear_solvers.MatrixFunctional "qiskit.algorithms.linear_solvers.MatrixFunctional")(main\_diag, off\_diag) | The deprecated class for the matrix functional of the vector solution to the linear systems. | + diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.md index 618bfe92c3d..4b56d4a91d1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.md @@ -1,8 +1,20 @@ +--- +title: minimum_eigensolvers +description: API reference for qiskit.algorithms.minimum_eigensolvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.minimum_eigensolvers +--- + # qiskit.algorithms.minimum\_eigensolvers -## Minimum Eigensolvers Package ([`qiskit.algorithms.minimum_eigensolvers`](#module-qiskit.algorithms.minimum_eigensolvers "qiskit.algorithms.minimum_eigensolvers")) +## Minimum Eigensolvers Package + + + +`qiskit.algorithms.minimum_eigensolvers` ### Minimum Eigensolvers @@ -24,3 +36,4 @@ | [`AdaptVQEResult`](qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult "qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult")() | AdaptVQE Result. | | [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult")() | Sampling Minimum Eigensolver Result. | | [`SamplingVQEResult`](qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult "qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult")() | VQE Result. | + diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.md index 4f7358a6dd6..3d91ef1d6be 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -78,3 +90,4 @@ The global optimizers here all use NLopt for their core function and can only be | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.md index e0bb9c1fc0b..843dbcc62db 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.md @@ -1,11 +1,24 @@ +--- +title: optimizer_utils +description: API reference for qiskit.algorithms.optimizers.optimizer_utils +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.optimizer_utils +--- + # qiskit.algorithms.optimizers.optimizer\_utils Utils for optimizers -## Optimizer Utils ([`qiskit.algorithms.optimizers.optimizer_utils`](#module-qiskit.algorithms.optimizers.optimizer_utils "qiskit.algorithms.optimizers.optimizer_utils")) +## Optimizer Utils + + + +`qiskit.algorithms.optimizers.optimizer_utils` | | | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | [`LearningRate`](qiskit.algorithms.optimizers.optimizer_utils.LearningRate "qiskit.algorithms.optimizers.optimizer_utils.LearningRate") | Represents a Learning Rate. | + diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.md b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.md index 4e8e2b3fccd..40b08327fe3 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.md @@ -1,8 +1,20 @@ +--- +title: state_fidelities +description: API reference for qiskit.algorithms.state_fidelities +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.state_fidelities +--- + # qiskit.algorithms.state\_fidelities -## State Fidelity Interfaces ([`qiskit.algorithms.state_fidelities`](#module-qiskit.algorithms.state_fidelities "qiskit.algorithms.state_fidelities")) +## State Fidelity Interfaces + + + +`qiskit.algorithms.state_fidelities` ### State Fidelities @@ -16,3 +28,4 @@ > | | | > | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | > | [`StateFidelityResult`](qiskit.algorithms.state_fidelities.StateFidelityResult "qiskit.algorithms.state_fidelities.StateFidelityResult")(fidelities, ...) | This class stores the result of StateFidelity computations. | + diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.md index 8f7eab51946..72b5e31139c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.md @@ -1,3 +1,11 @@ +--- +title: trotterization +description: API reference for qiskit.algorithms.time_evolvers.trotterization +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.time_evolvers.trotterization +--- + # qiskit.algorithms.time\_evolvers.trotterization @@ -9,3 +17,4 @@ This package contains Trotterization-based Quantum Real Time Evolution algorithm | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | | [`TrotterQRTE`](qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE "qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE") | Quantum Real Time Evolution using Trotterization. | + diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.md index 7d3be939619..73c7be14052 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.md @@ -1,8 +1,20 @@ +--- +title: variational +description: API reference for qiskit.algorithms.time_evolvers.variational +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.time_evolvers.variational +--- + # qiskit.algorithms.time\_evolvers.variational -## Variational Quantum Time Evolutions ([`qiskit.algorithms.time_evolvers.variational`](#module-qiskit.algorithms.time_evolvers.variational "qiskit.algorithms.time_evolvers.variational")) +## Variational Quantum Time Evolutions + + + +`qiskit.algorithms.time_evolvers.variational` Algorithms for performing Variational Quantum Time Evolution of quantum states, which can be tailored to near-term devices. `VarQTE` base class exposes an interface, compliant with the Quantum Time Evolution Framework in Qiskit Terra, that is implemented by [`VarQRTE`](qiskit.algorithms.VarQRTE "qiskit.algorithms.VarQRTE") and [`VarQITE`](qiskit.algorithms.VarQITE "qiskit.algorithms.VarQITE") classes for real and imaginary time evolution respectively. The variational approach is taken according to a variational principle chosen by a user. @@ -59,3 +71,4 @@ ODE solvers that implement the SciPy ODE Solver interface. The Forward Euler Sol | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | [`ForwardEulerSolver`](qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver "qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver")(function, t0, y0, t\_bound) | Forward Euler ODE solver. | + diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.md index 78c8d772f6c..fd81b2d76b6 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, ...]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, ...]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.md index 901c1a93987..56d09f9e3a1 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive "bookends" strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.md index 40f57dfa261..df598260d9d 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.md index e4558f4e2ea..af71ebe3bf7 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, ...]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.md index 71b2cd119a1..51994b092bd 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.md index 356f54afb31..49e0db5a490 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.md index 2ffffc20990..e374b0766ed 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, ...]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, ...]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.41/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.41/qiskit.scheduler.methods.basic.md index 6d0ab513269..6bef8c60c54 100644 --- a/docs/api/qiskit/0.41/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.41/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as late as possible" (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as soon as possible" (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.41/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.41/qiskit.scheduler.schedule_circuit.md index a9e2086d690..36e4ab21f18 100644 --- a/docs/api/qiskit/0.41/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.41/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | ----------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, ...]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/docs/api/qiskit/0.42/_toc.json b/docs/api/qiskit/0.42/_toc.json index bd5bfbad59c..b7931be779e 100644 --- a/docs/api/qiskit/0.42/_toc.json +++ b/docs/api/qiskit/0.42/_toc.json @@ -12,22 +12,6 @@ "title": "Overview", "url": "/api/qiskit/0.42/algorithms" }, - { - "title": "AbsoluteAverage", - "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.AbsoluteAverage" - }, - { - "title": "ADAM", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.ADAM" - }, - { - "title": "AdaptVQE", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQE" - }, - { - "title": "AdaptVQEResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult" - }, { "title": "AlgorithmError", "url": "/api/qiskit/0.42/qiskit.algorithms.AlgorithmError" @@ -60,82 +44,14 @@ "title": "AmplitudeEstimatorResult", "url": "/api/qiskit/0.42/qiskit.algorithms.AmplitudeEstimatorResult" }, - { - "title": "AQGD", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.AQGD" - }, - { - "title": "AskData", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.AskData" - }, - { - "title": "BaseEstimatorGradient", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.BaseEstimatorGradient" - }, - { - "title": "BaseQGT", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.BaseQGT" - }, - { - "title": "BaseSamplerGradient", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.BaseSamplerGradient" - }, - { - "title": "BaseStateFidelity", - "url": "/api/qiskit/0.42/qiskit.algorithms.state_fidelities.BaseStateFidelity" - }, - { - "title": "BOBYQA", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.BOBYQA" - }, - { - "title": "CG", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.CG" - }, - { - "title": "COBYLA", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.COBYLA" - }, - { - "title": "ComputeUncompute", - "url": "/api/qiskit/0.42/qiskit.algorithms.state_fidelities.ComputeUncompute" - }, - { - "title": "CRS", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.CRS" - }, - { - "title": "DerivativeType", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.DerivativeType" - }, - { - "title": "DIRECT_L", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L" - }, - { - "title": "DIRECT_L_RAND", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L_RAND" - }, { "title": "Eigensolver", "url": "/api/qiskit/0.42/qiskit.algorithms.Eigensolver" }, - { - "title": "Eigensolver", - "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.Eigensolver" - }, { "title": "EigensolverResult", "url": "/api/qiskit/0.42/qiskit.algorithms.EigensolverResult" }, - { - "title": "EigensolverResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.EigensolverResult" - }, - { - "title": "ESCH", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.ESCH" - }, { "title": "estimate_observables", "url": "/api/qiskit/0.42/qiskit.algorithms.estimate_observables" @@ -144,10 +60,6 @@ "title": "EstimationProblem", "url": "/api/qiskit/0.42/qiskit.algorithms.EstimationProblem" }, - { - "title": "EstimatorGradientResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.EstimatorGradientResult" - }, { "title": "eval_observables", "url": "/api/qiskit/0.42/qiskit.algorithms.eval_observables" @@ -168,26 +80,6 @@ "title": "FasterAmplitudeEstimationResult", "url": "/api/qiskit/0.42/qiskit.algorithms.FasterAmplitudeEstimationResult" }, - { - "title": "FiniteDiffEstimatorGradient", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient" - }, - { - "title": "FiniteDiffSamplerGradient", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffSamplerGradient" - }, - { - "title": "ForwardEulerSolver", - "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver" - }, - { - "title": "GradientDescent", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescent" - }, - { - "title": "GradientDescentState", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescentState" - }, { "title": "Grover", "url": "/api/qiskit/0.42/qiskit.algorithms.Grover" @@ -196,10 +88,6 @@ "title": "GroverResult", "url": "/api/qiskit/0.42/qiskit.algorithms.GroverResult" }, - { - "title": "GSLS", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.GSLS" - }, { "title": "HamiltonianPhaseEstimation", "url": "/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimation" @@ -208,34 +96,14 @@ "title": "HamiltonianPhaseEstimationResult", "url": "/api/qiskit/0.42/qiskit.algorithms.HamiltonianPhaseEstimationResult" }, - { - "title": "HHL", - "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.HHL" - }, { "title": "ImaginaryEvolver", "url": "/api/qiskit/0.42/qiskit.algorithms.ImaginaryEvolver" }, - { - "title": "ImaginaryMcLachlanPrinciple", - "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple" - }, { "title": "ImaginaryTimeEvolver", "url": "/api/qiskit/0.42/qiskit.algorithms.ImaginaryTimeEvolver" }, - { - "title": "ImaginaryVariationalPrinciple", - "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple" - }, - { - "title": "IMFIL", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.IMFIL" - }, - { - "title": "ISRES", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.ISRES" - }, { "title": "IterativeAmplitudeEstimation", "url": "/api/qiskit/0.42/qiskit.algorithms.IterativeAmplitudeEstimation" @@ -248,46 +116,6 @@ "title": "IterativePhaseEstimation", "url": "/api/qiskit/0.42/qiskit.algorithms.IterativePhaseEstimation" }, - { - "title": "L_BFGS_B", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.L_BFGS_B" - }, - { - "title": "LearningRate", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.LearningRate" - }, - { - "title": "LinCombEstimatorGradient", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombEstimatorGradient" - }, - { - "title": "LinCombQGT", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombQGT" - }, - { - "title": "LinCombSamplerGradient", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombSamplerGradient" - }, - { - "title": "LinearSolver", - "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolver" - }, - { - "title": "LinearSolverResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolverResult" - }, - { - "title": "LinearSystemMatrix", - "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemMatrix" - }, - { - "title": "LinearSystemObservable", - "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemObservable" - }, - { - "title": "MatrixFunctional", - "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.MatrixFunctional" - }, { "title": "MaximumLikelihoodAmplitudeEstimation", "url": "/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation" @@ -296,94 +124,22 @@ "title": "MaximumLikelihoodAmplitudeEstimationResult", "url": "/api/qiskit/0.42/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult" }, - { - "title": "Minimizer", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.Minimizer" - }, { "title": "MinimumEigensolver", "url": "/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolver" }, - { - "title": "MinimumEigensolver", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver" - }, { "title": "MinimumEigensolverResult", "url": "/api/qiskit/0.42/qiskit.algorithms.MinimumEigensolverResult" }, - { - "title": "MinimumEigensolverResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult" - }, - { - "title": "NELDER_MEAD", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.NELDER_MEAD" - }, - { - "title": "NFT", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT" - }, { "title": "NumPyEigensolver", "url": "/api/qiskit/0.42/qiskit.algorithms.NumPyEigensolver" }, - { - "title": "NumPyEigensolver", - "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolver" - }, - { - "title": "NumPyEigensolverResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolverResult" - }, - { - "title": "NumPyLinearSolver", - "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyLinearSolver" - }, - { - "title": "NumPyMatrix", - "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyMatrix" - }, { "title": "NumPyMinimumEigensolver", "url": "/api/qiskit/0.42/qiskit.algorithms.NumPyMinimumEigensolver" }, - { - "title": "NumPyMinimumEigensolver", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver" - }, - { - "title": "NumPyMinimumEigensolverResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult" - }, - { - "title": "Optimizer", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.Optimizer" - }, - { - "title": "OptimizerResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerResult" - }, - { - "title": "OptimizerState", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerState" - }, - { - "title": "OptimizerSupportLevel", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerSupportLevel" - }, - { - "title": "P_BFGS", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.P_BFGS" - }, - { - "title": "ParamShiftEstimatorGradient", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftEstimatorGradient" - }, - { - "title": "ParamShiftSamplerGradient", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftSamplerGradient" - }, { "title": "PhaseEstimation", "url": "/api/qiskit/0.42/qiskit.algorithms.PhaseEstimation" @@ -396,10 +152,6 @@ "title": "PhaseEstimationScale", "url": "/api/qiskit/0.42/qiskit.algorithms.PhaseEstimationScale" }, - { - "title": "POWELL", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.POWELL" - }, { "title": "PVQD", "url": "/api/qiskit/0.42/qiskit.algorithms.PVQD" @@ -412,78 +164,18 @@ "title": "QAOA", "url": "/api/qiskit/0.42/qiskit.algorithms.QAOA" }, - { - "title": "QAOA", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.QAOA" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.QFI" - }, - { - "title": "QFIResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.QFIResult" - }, - { - "title": "QGTResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.QGTResult" - }, - { - "title": "QNSPSA", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.QNSPSA" - }, { "title": "RealEvolver", "url": "/api/qiskit/0.42/qiskit.algorithms.RealEvolver" }, - { - "title": "RealMcLachlanPrinciple", - "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple" - }, { "title": "RealTimeEvolver", "url": "/api/qiskit/0.42/qiskit.algorithms.RealTimeEvolver" }, - { - "title": "RealVariationalPrinciple", - "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple" - }, - { - "title": "ReverseEstimatorGradient", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseEstimatorGradient" - }, - { - "title": "ReverseQGT", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseQGT" - }, - { - "title": "SamplerGradientResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.SamplerGradientResult" - }, - { - "title": "SamplingMinimumEigensolver", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver" - }, - { - "title": "SamplingMinimumEigensolverResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult" - }, - { - "title": "SamplingVQE", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQE" - }, - { - "title": "SamplingVQEResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult" - }, { "title": "SciPyImaginaryEvolver", "url": "/api/qiskit/0.42/qiskit.algorithms.SciPyImaginaryEvolver" }, - { - "title": "SciPyOptimizer", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.SciPyOptimizer" - }, { "title": "SciPyRealEvolver", "url": "/api/qiskit/0.42/qiskit.algorithms.SciPyRealEvolver" @@ -496,38 +188,6 @@ "title": "ShorResult", "url": "/api/qiskit/0.42/qiskit.algorithms.ShorResult" }, - { - "title": "SLSQP", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.SLSQP" - }, - { - "title": "SNOBFIT", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.SNOBFIT" - }, - { - "title": "SPSA", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.SPSA" - }, - { - "title": "SPSAEstimatorGradient", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.SPSAEstimatorGradient" - }, - { - "title": "SPSASamplerGradient", - "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.SPSASamplerGradient" - }, - { - "title": "StateFidelityResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.state_fidelities.StateFidelityResult" - }, - { - "title": "SteppableOptimizer", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.SteppableOptimizer" - }, - { - "title": "TellData", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.TellData" - }, { "title": "TimeEvolutionProblem", "url": "/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionProblem" @@ -536,30 +196,10 @@ "title": "TimeEvolutionResult", "url": "/api/qiskit/0.42/qiskit.algorithms.TimeEvolutionResult" }, - { - "title": "TNC", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.TNC" - }, - { - "title": "TridiagonalToeplitz", - "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" - }, { "title": "TrotterQRTE", "url": "/api/qiskit/0.42/qiskit.algorithms.TrotterQRTE" }, - { - "title": "TrotterQRTE", - "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE" - }, - { - "title": "UMDA", - "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.UMDA" - }, - { - "title": "VariationalPrinciple", - "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple" - }, { "title": "VarQITE", "url": "/api/qiskit/0.42/qiskit.algorithms.VarQITE" @@ -572,29 +212,470 @@ "title": "VQD", "url": "/api/qiskit/0.42/qiskit.algorithms.VQD" }, - { - "title": "VQD", - "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQD" - }, { "title": "VQDResult", "url": "/api/qiskit/0.42/qiskit.algorithms.VQDResult" }, - { - "title": "VQDResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQDResult" - }, { "title": "VQE", "url": "/api/qiskit/0.42/qiskit.algorithms.VQE" }, { - "title": "VQE", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQE" + "title": "qiskit.algorithms.eigensolvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers" + }, + { + "title": "Eigensolver", + "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.Eigensolver" + }, + { + "title": "EigensolverResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.EigensolverResult" + }, + { + "title": "NumPyEigensolver", + "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolver" + }, + { + "title": "NumPyEigensolverResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.NumPyEigensolverResult" + }, + { + "title": "VQD", + "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQD" + }, + { + "title": "VQDResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.eigensolvers.VQDResult" + } + ] + }, + { + "title": "qiskit.algorithms.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients" + }, + { + "title": "BaseEstimatorGradient", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.BaseEstimatorGradient" + }, + { + "title": "BaseQGT", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.BaseQGT" + }, + { + "title": "BaseSamplerGradient", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.BaseSamplerGradient" + }, + { + "title": "DerivativeType", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.DerivativeType" + }, + { + "title": "EstimatorGradientResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.EstimatorGradientResult" + }, + { + "title": "FiniteDiffEstimatorGradient", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient" + }, + { + "title": "FiniteDiffSamplerGradient", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.FiniteDiffSamplerGradient" + }, + { + "title": "LinCombEstimatorGradient", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombEstimatorGradient" + }, + { + "title": "LinCombQGT", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombQGT" + }, + { + "title": "LinCombSamplerGradient", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.LinCombSamplerGradient" + }, + { + "title": "ParamShiftEstimatorGradient", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftEstimatorGradient" + }, + { + "title": "ParamShiftSamplerGradient", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.ParamShiftSamplerGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.QFI" + }, + { + "title": "QFIResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.QFIResult" + }, + { + "title": "QGTResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.QGTResult" + }, + { + "title": "ReverseEstimatorGradient", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseEstimatorGradient" + }, + { + "title": "ReverseQGT", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.ReverseQGT" + }, + { + "title": "SamplerGradientResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.SamplerGradientResult" + }, + { + "title": "SPSAEstimatorGradient", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.SPSAEstimatorGradient" + }, + { + "title": "SPSASamplerGradient", + "url": "/api/qiskit/0.42/qiskit.algorithms.gradients.SPSASamplerGradient" + } + ] + }, + { + "title": "qiskit.algorithms.linear_solvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers" + }, + { + "title": "AbsoluteAverage", + "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.AbsoluteAverage" + }, + { + "title": "HHL", + "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.HHL" + }, + { + "title": "LinearSolver", + "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolver" + }, + { + "title": "LinearSolverResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSolverResult" + }, + { + "title": "LinearSystemMatrix", + "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemMatrix" + }, + { + "title": "LinearSystemObservable", + "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.LinearSystemObservable" + }, + { + "title": "MatrixFunctional", + "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.MatrixFunctional" + }, + { + "title": "NumPyLinearSolver", + "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyLinearSolver" + }, + { + "title": "NumPyMatrix", + "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.NumPyMatrix" + }, + { + "title": "TridiagonalToeplitz", + "url": "/api/qiskit/0.42/qiskit.algorithms.linear_solvers.TridiagonalToeplitz" + } + ] + }, + { + "title": "qiskit.algorithms.minimum_eigensolvers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers" + }, + { + "title": "AdaptVQE", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQE" + }, + { + "title": "AdaptVQEResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult" + }, + { + "title": "MinimumEigensolver", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver" + }, + { + "title": "MinimumEigensolverResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult" + }, + { + "title": "NumPyMinimumEigensolver", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver" + }, + { + "title": "NumPyMinimumEigensolverResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult" + }, + { + "title": "QAOA", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.QAOA" + }, + { + "title": "SamplingMinimumEigensolver", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver" + }, + { + "title": "SamplingMinimumEigensolverResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult" + }, + { + "title": "SamplingVQE", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQE" + }, + { + "title": "SamplingVQEResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult" + }, + { + "title": "VQE", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQE" + }, + { + "title": "VQEResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQEResult" + } + ] + }, + { + "title": "qiskit.algorithms.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "AskData", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.AskData" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "GradientDescentState", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.GradientDescentState" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "Minimizer", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.Minimizer" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerResult" + }, + { + "title": "OptimizerState", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerState" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "SteppableOptimizer", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.SteppableOptimizer" + }, + { + "title": "TellData", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.TellData" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.TNC" + }, + { + "title": "UMDA", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.UMDA" + }, + { + "title": "qiskit.algorithms.optimizers.optimizer_utils", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils" + }, + { + "title": "LearningRate", + "url": "/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.LearningRate" + } + ] + } + ] + }, + { + "title": "qiskit.algorithms.state_fidelities", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.algorithms.state_fidelities" + }, + { + "title": "BaseStateFidelity", + "url": "/api/qiskit/0.42/qiskit.algorithms.state_fidelities.BaseStateFidelity" + }, + { + "title": "ComputeUncompute", + "url": "/api/qiskit/0.42/qiskit.algorithms.state_fidelities.ComputeUncompute" + }, + { + "title": "StateFidelityResult", + "url": "/api/qiskit/0.42/qiskit.algorithms.state_fidelities.StateFidelityResult" + } + ] + }, + { + "title": "qiskit.algorithms.time_evolvers.trotterization", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization" + }, + { + "title": "TrotterQRTE", + "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE" + } + ] }, { - "title": "VQEResult", - "url": "/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.VQEResult" + "title": "qiskit.algorithms.time_evolvers.variational", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational" + }, + { + "title": "ForwardEulerSolver", + "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver" + }, + { + "title": "ImaginaryMcLachlanPrinciple", + "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple" + }, + { + "title": "ImaginaryVariationalPrinciple", + "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple" + }, + { + "title": "RealMcLachlanPrinciple", + "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple" + }, + { + "title": "RealVariationalPrinciple", + "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple" + }, + { + "title": "VariationalPrinciple", + "url": "/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple" + } + ] } ] }, @@ -1677,225 +1758,288 @@ "title": "Overview", "url": "/api/qiskit/0.42/opflow" }, - { - "title": "AbelianGrouper", - "url": "/api/qiskit/0.42/qiskit.opflow.converters.AbelianGrouper" - }, - { - "title": "AerPauliExpectation", - "url": "/api/qiskit/0.42/qiskit.opflow.expectations.AerPauliExpectation" - }, { "title": "anti_commutator", "url": "/api/qiskit/0.42/qiskit.opflow.anti_commutator" }, - { - "title": "CircuitGradient", - "url": "/api/qiskit/0.42/qiskit.opflow.gradients.CircuitGradient" - }, - { - "title": "CircuitOp", - "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.CircuitOp" - }, - { - "title": "CircuitQFI", - "url": "/api/qiskit/0.42/qiskit.opflow.gradients.CircuitQFI" - }, - { - "title": "CircuitSampler", - "url": "/api/qiskit/0.42/qiskit.opflow.converters.CircuitSampler" - }, - { - "title": "CircuitStateFn", - "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.CircuitStateFn" - }, { "title": "commutator", "url": "/api/qiskit/0.42/qiskit.opflow.commutator" }, - { - "title": "ComposedOp", - "url": "/api/qiskit/0.42/qiskit.opflow.list_ops.ComposedOp" - }, - { - "title": "ConverterBase", - "url": "/api/qiskit/0.42/qiskit.opflow.converters.ConverterBase" - }, - { - "title": "CVaRExpectation", - "url": "/api/qiskit/0.42/qiskit.opflow.expectations.CVaRExpectation" - }, - { - "title": "CVaRMeasurement", - "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.CVaRMeasurement" - }, - { - "title": "DerivativeBase", - "url": "/api/qiskit/0.42/qiskit.opflow.gradients.DerivativeBase" - }, - { - "title": "DictStateFn", - "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.DictStateFn" - }, - { - "title": "DictToCircuitSum", - "url": "/api/qiskit/0.42/qiskit.opflow.converters.DictToCircuitSum" - }, { "title": "double_commutator", "url": "/api/qiskit/0.42/qiskit.opflow.double_commutator" }, - { - "title": "EvolutionBase", - "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionBase" - }, - { - "title": "EvolutionFactory", - "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionFactory" - }, - { - "title": "EvolvedOp", - "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.EvolvedOp" - }, - { - "title": "ExpectationBase", - "url": "/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationBase" - }, - { - "title": "ExpectationFactory", - "url": "/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationFactory" - }, - { - "title": "Gradient", - "url": "/api/qiskit/0.42/qiskit.opflow.gradients.Gradient" - }, - { - "title": "GradientBase", - "url": "/api/qiskit/0.42/qiskit.opflow.gradients.GradientBase" - }, - { - "title": "Hessian", - "url": "/api/qiskit/0.42/qiskit.opflow.gradients.Hessian" - }, - { - "title": "HessianBase", - "url": "/api/qiskit/0.42/qiskit.opflow.gradients.HessianBase" - }, - { - "title": "ListOp", - "url": "/api/qiskit/0.42/qiskit.opflow.list_ops.ListOp" - }, - { - "title": "MatrixEvolution", - "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.MatrixEvolution" - }, - { - "title": "MatrixExpectation", - "url": "/api/qiskit/0.42/qiskit.opflow.expectations.MatrixExpectation" - }, - { - "title": "MatrixOp", - "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.MatrixOp" - }, - { - "title": "NaturalGradient", - "url": "/api/qiskit/0.42/qiskit.opflow.gradients.NaturalGradient" - }, { "title": "OperatorBase", "url": "/api/qiskit/0.42/qiskit.opflow.OperatorBase" }, - { - "title": "OperatorStateFn", - "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.OperatorStateFn" - }, { "title": "OpflowError", "url": "/api/qiskit/0.42/qiskit.opflow.OpflowError" }, { - "title": "PauliBasisChange", - "url": "/api/qiskit/0.42/qiskit.opflow.converters.PauliBasisChange" - }, - { - "title": "PauliExpectation", - "url": "/api/qiskit/0.42/qiskit.opflow.expectations.PauliExpectation" - }, - { - "title": "PauliOp", - "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliOp" - }, - { - "title": "PauliSumOp", - "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliSumOp" - }, - { - "title": "PauliTrotterEvolution", - "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.PauliTrotterEvolution" - }, - { - "title": "PrimitiveOp", - "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.PrimitiveOp" - }, - { - "title": "QDrift", - "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.QDrift" - }, - { - "title": "QFI", - "url": "/api/qiskit/0.42/qiskit.opflow.gradients.QFI" - }, - { - "title": "QFIBase", - "url": "/api/qiskit/0.42/qiskit.opflow.gradients.QFIBase" - }, - { - "title": "SparseVectorStateFn", - "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.SparseVectorStateFn" - }, - { - "title": "StateFn", - "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.StateFn" - }, - { - "title": "SummedOp", - "url": "/api/qiskit/0.42/qiskit.opflow.list_ops.SummedOp" - }, - { - "title": "Suzuki", - "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.Suzuki" - }, - { - "title": "TaperedPauliSumOp", - "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.TaperedPauliSumOp" - }, - { - "title": "TensoredOp", - "url": "/api/qiskit/0.42/qiskit.opflow.list_ops.TensoredOp" + "title": "qiskit.opflow.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.opflow.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.42/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.42/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.42/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.42/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.42/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.42/qiskit.opflow.converters.TwoQubitReduction" + } + ] }, { - "title": "Trotter", - "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.Trotter" + "title": "qiskit.opflow.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.opflow.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationFactory" + } + ] }, { - "title": "TrotterizationBase", - "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationBase" + "title": "qiskit.opflow.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.opflow.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.42/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.42/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.42/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.42/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.42/qiskit.opflow.expectations.PauliExpectation" + } + ] }, { - "title": "TrotterizationFactory", - "url": "/api/qiskit/0.42/qiskit.opflow.evolutions.TrotterizationFactory" + "title": "qiskit.opflow.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.opflow.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.42/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.42/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.42/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.42/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.42/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.42/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.42/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.42/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.42/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.42/qiskit.opflow.gradients.QFIBase" + } + ] }, { - "title": "TwoQubitReduction", - "url": "/api/qiskit/0.42/qiskit.opflow.converters.TwoQubitReduction" + "title": "qiskit.opflow.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.opflow.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.42/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.42/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.42/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.42/qiskit.opflow.list_ops.TensoredOp" + } + ] }, { - "title": "VectorStateFn", - "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.VectorStateFn" + "title": "qiskit.opflow.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] }, { - "title": "Z2Symmetries", - "url": "/api/qiskit/0.42/qiskit.opflow.primitive_ops.Z2Symmetries" + "title": "qiskit.opflow.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.42/qiskit.opflow.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.42/qiskit.opflow.state_fns.VectorStateFn" + } + ] } ] }, @@ -3604,6 +3748,14 @@ "title": "Overview", "url": "/api/qiskit/0.42/scheduler" }, + { + "title": "qiskit.scheduler.methods.basic", + "url": "/api/qiskit/0.42/qiskit.scheduler.methods.basic" + }, + { + "title": "qiskit.scheduler.schedule_circuit", + "url": "/api/qiskit/0.42/qiskit.scheduler.schedule_circuit" + }, { "title": "ScheduleConfig", "url": "/api/qiskit/0.42/qiskit.scheduler.ScheduleConfig" diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.md b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.md index 85b4bee7c28..d226b69b4b1 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.eigensolvers.md @@ -1,8 +1,20 @@ +--- +title: eigensolvers +description: API reference for qiskit.algorithms.eigensolvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.eigensolvers +--- + # qiskit.algorithms.eigensolvers -## Eigensolvers Package ([`qiskit.algorithms.eigensolvers`](#module-qiskit.algorithms.eigensolvers "qiskit.algorithms.eigensolvers")) +## Eigensolvers Package + + + +`qiskit.algorithms.eigensolvers` ### Eigensolvers @@ -19,3 +31,4 @@ > | [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.EigensolverResult")() | Eigensolver result. | > | [`NumPyEigensolverResult`](qiskit.algorithms.eigensolvers.NumPyEigensolverResult "qiskit.algorithms.eigensolvers.NumPyEigensolverResult")() | NumPy eigensolver result. | > | [`VQDResult`](qiskit.algorithms.eigensolvers.VQDResult "qiskit.algorithms.eigensolvers.VQDResult")() | VQD Result. | + diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.md b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.md index 7b8988f878a..ccaf77374e8 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.gradients.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.algorithms.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.gradients +--- + # qiskit.algorithms.gradients -## Gradients ([`qiskit.algorithms.gradients`](#module-qiskit.algorithms.gradients "qiskit.algorithms.gradients")) +## Gradients + + + +`qiskit.algorithms.gradients` ### Estimator Gradients @@ -43,3 +55,4 @@ | [`QFIResult`](qiskit.algorithms.gradients.QFIResult "qiskit.algorithms.gradients.QFIResult")(qfis, metadata, options) | Result of QFI. | | [`QGTResult`](qiskit.algorithms.gradients.QGTResult "qiskit.algorithms.gradients.QGTResult")(qgts, derivative\_type, metadata, ...) | Result of QGT. | | [`SamplerGradientResult`](qiskit.algorithms.gradients.SamplerGradientResult "qiskit.algorithms.gradients.SamplerGradientResult")(gradients, metadata, ...) | Result of SamplerGradient. | + diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.md b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.md index 572c4585cea..7503a96b25d 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.linear_solvers.md @@ -1,16 +1,28 @@ +--- +title: linear_solvers +description: API reference for qiskit.algorithms.linear_solvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.linear_solvers +--- + # qiskit.algorithms.linear\_solvers -## The deprecated Linear solvers ([`qiskit.algorithms.linear_solvers`](#module-qiskit.algorithms.linear_solvers "qiskit.algorithms.linear_solvers")) +## The deprecated Linear solvers + + + +`qiskit.algorithms.linear_solvers` It contains classical and quantum algorithms to solve systems of linear equations such as `HHL`. Although the quantum algorithm accepts a general Hermitian matrix as input, Qiskit’s default Hamiltonian evolution is exponential in such cases and therefore the quantum linear solver will not achieve an exponential speedup. Furthermore, the quantum algorithm can find a solution exponentially faster in the size of the system than their classical counterparts (i.e. logarithmic complexity instead of polynomial), meaning that reading the full solution vector would kill such speedup (since this would take linear time in the size of the system). Therefore, to achieve an exponential speedup we can only compute functions from the solution vector (the so called observables) to learn information about the solution. Known efficient implementations of Hamiltonian evolutions or observables are contained in the following subfolders: -## [Matrices](#matrices) +**[Matrices](#matrices)** A placeholder for efficient implementations of the Hamiltonian evolution of particular types of matrices. -## [Observables](#observables) +**[Observables](#observables)** A placeholder for efficient implementations of functions that can be computed from the solution vector to a system of linear equations. @@ -38,3 +50,4 @@ A placeholder for efficient implementations of functions that can be computed fr | [`LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.LinearSystemObservable")() | The deprecated abstract class for linear system observables in Qiskit. | | [`AbsoluteAverage`](qiskit.algorithms.linear_solvers.AbsoluteAverage "qiskit.algorithms.linear_solvers.AbsoluteAverage")() | The deprecated observable for the absolute average of a linear system of equations solution. | | [`MatrixFunctional`](qiskit.algorithms.linear_solvers.MatrixFunctional "qiskit.algorithms.linear_solvers.MatrixFunctional")(main\_diag, off\_diag) | The deprecated class for the matrix functional of the vector solution to the linear systems. | + diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.md b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.md index 618bfe92c3d..4b56d4a91d1 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.minimum_eigensolvers.md @@ -1,8 +1,20 @@ +--- +title: minimum_eigensolvers +description: API reference for qiskit.algorithms.minimum_eigensolvers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.minimum_eigensolvers +--- + # qiskit.algorithms.minimum\_eigensolvers -## Minimum Eigensolvers Package ([`qiskit.algorithms.minimum_eigensolvers`](#module-qiskit.algorithms.minimum_eigensolvers "qiskit.algorithms.minimum_eigensolvers")) +## Minimum Eigensolvers Package + + + +`qiskit.algorithms.minimum_eigensolvers` ### Minimum Eigensolvers @@ -24,3 +36,4 @@ | [`AdaptVQEResult`](qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult "qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult")() | AdaptVQE Result. | | [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult")() | Sampling Minimum Eigensolver Result. | | [`SamplingVQEResult`](qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult "qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult")() | VQE Result. | + diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.md index 4f7358a6dd6..3d91ef1d6be 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.md @@ -1,16 +1,28 @@ +--- +title: optimizers +description: API reference for qiskit.algorithms.optimizers +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers +--- + # qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) +## Optimizers + + + +`qiskit.algorithms.optimizers` It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: -## [Local Optimizers](#local-optimizers) +**[Local Optimizers](#local-optimizers)** Given an optimization problem, a **local optimizer** is a function that attempts to find an optimal value within the neighboring set of a candidate solution. -## [Global Optimizers](#global-optimizers) +**[Global Optimizers](#global-optimizers)** Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. @@ -78,3 +90,4 @@ The global optimizers here all use NLopt for their core function and can only be | [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | | [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | | [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | + diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.md b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.md index e0bb9c1fc0b..843dbcc62db 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.optimizer_utils.md @@ -1,11 +1,24 @@ +--- +title: optimizer_utils +description: API reference for qiskit.algorithms.optimizers.optimizer_utils +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.optimizers.optimizer_utils +--- + # qiskit.algorithms.optimizers.optimizer\_utils Utils for optimizers -## Optimizer Utils ([`qiskit.algorithms.optimizers.optimizer_utils`](#module-qiskit.algorithms.optimizers.optimizer_utils "qiskit.algorithms.optimizers.optimizer_utils")) +## Optimizer Utils + + + +`qiskit.algorithms.optimizers.optimizer_utils` | | | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | [`LearningRate`](qiskit.algorithms.optimizers.optimizer_utils.LearningRate "qiskit.algorithms.optimizers.optimizer_utils.LearningRate") | Represents a Learning Rate. | + diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.md b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.md index 4e8e2b3fccd..40b08327fe3 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.state_fidelities.md @@ -1,8 +1,20 @@ +--- +title: state_fidelities +description: API reference for qiskit.algorithms.state_fidelities +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.state_fidelities +--- + # qiskit.algorithms.state\_fidelities -## State Fidelity Interfaces ([`qiskit.algorithms.state_fidelities`](#module-qiskit.algorithms.state_fidelities "qiskit.algorithms.state_fidelities")) +## State Fidelity Interfaces + + + +`qiskit.algorithms.state_fidelities` ### State Fidelities @@ -16,3 +28,4 @@ > | | | > | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | > | [`StateFidelityResult`](qiskit.algorithms.state_fidelities.StateFidelityResult "qiskit.algorithms.state_fidelities.StateFidelityResult")(fidelities, ...) | This class stores the result of StateFidelity computations. | + diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.md b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.md index 8f7eab51946..72b5e31139c 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.trotterization.md @@ -1,3 +1,11 @@ +--- +title: trotterization +description: API reference for qiskit.algorithms.time_evolvers.trotterization +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.time_evolvers.trotterization +--- + # qiskit.algorithms.time\_evolvers.trotterization @@ -9,3 +17,4 @@ This package contains Trotterization-based Quantum Real Time Evolution algorithm | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | | [`TrotterQRTE`](qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE "qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE") | Quantum Real Time Evolution using Trotterization. | + diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.md b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.md index 7d3be939619..73c7be14052 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.md +++ b/docs/api/qiskit/0.42/qiskit.algorithms.time_evolvers.variational.md @@ -1,8 +1,20 @@ +--- +title: variational +description: API reference for qiskit.algorithms.time_evolvers.variational +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.algorithms.time_evolvers.variational +--- + # qiskit.algorithms.time\_evolvers.variational -## Variational Quantum Time Evolutions ([`qiskit.algorithms.time_evolvers.variational`](#module-qiskit.algorithms.time_evolvers.variational "qiskit.algorithms.time_evolvers.variational")) +## Variational Quantum Time Evolutions + + + +`qiskit.algorithms.time_evolvers.variational` Algorithms for performing Variational Quantum Time Evolution of quantum states, which can be tailored to near-term devices. `VarQTE` base class exposes an interface, compliant with the Quantum Time Evolution Framework in Qiskit Terra, that is implemented by [`VarQRTE`](qiskit.algorithms.VarQRTE "qiskit.algorithms.VarQRTE") and [`VarQITE`](qiskit.algorithms.VarQITE "qiskit.algorithms.VarQITE") classes for real and imaginary time evolution respectively. The variational approach is taken according to a variational principle chosen by a user. @@ -59,3 +71,4 @@ ODE solvers that implement the SciPy ODE Solver interface. The Forward Euler Sol | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | [`ForwardEulerSolver`](qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver "qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver")(function, t0, y0, t\_bound) | Forward Euler ODE solver. | + diff --git a/docs/api/qiskit/0.42/qiskit.opflow.converters.md b/docs/api/qiskit/0.42/qiskit.opflow.converters.md index 78c8d772f6c..fd81b2d76b6 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.converters.md @@ -1,8 +1,20 @@ +--- +title: converters +description: API reference for qiskit.opflow.converters +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.converters +--- + # qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) +## Converters + + + +`qiskit.opflow.converters` Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -29,3 +41,4 @@ In addition to the base class, directory holds a few miscellaneous converters wh | [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, ...]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | | [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, ...]) | Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | + diff --git a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.md index 901c1a93987..56d09f9e3a1 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.evolutions.md @@ -1,8 +1,20 @@ +--- +title: evolutions +description: API reference for qiskit.opflow.evolutions +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.evolutions +--- + # qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) +## Operator Evolutions + + + +`qiskit.opflow.evolutions` Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -38,3 +50,4 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | | [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive "bookends" strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | + diff --git a/docs/api/qiskit/0.42/qiskit.opflow.expectations.md b/docs/api/qiskit/0.42/qiskit.opflow.expectations.md index 40f57dfa261..df598260d9d 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.expectations.md @@ -1,8 +1,20 @@ +--- +title: expectations +description: API reference for qiskit.opflow.expectations +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.expectations +--- + # qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) +## Expectations + + + +`qiskit.opflow.expectations` Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. @@ -23,3 +35,4 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | | [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | + diff --git a/docs/api/qiskit/0.42/qiskit.opflow.gradients.md b/docs/api/qiskit/0.42/qiskit.opflow.gradients.md index e4558f4e2ea..af71ebe3bf7 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.gradients.md @@ -1,8 +1,20 @@ +--- +title: gradients +description: API reference for qiskit.opflow.gradients +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.gradients +--- + # qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) +## Gradients + + + +`qiskit.opflow.gradients` Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -109,3 +121,4 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | | [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, ...]) | Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | + diff --git a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.md index 71b2cd119a1..51994b092bd 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.list_ops.md @@ -1,8 +1,20 @@ +--- +title: list_ops +description: API reference for qiskit.opflow.list_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.list_ops +--- + # qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) +## List Operators + + + +`qiskit.opflow.list_ops` List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -31,3 +43,4 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | | [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | | [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | + diff --git a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.md index 356f54afb31..49e0db5a490 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.primitive_ops.md @@ -1,8 +1,20 @@ +--- +title: primitive_ops +description: API reference for qiskit.opflow.primitive_ops +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.primitive_ops +--- + # qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) +## Primitive Operators + + + +`qiskit.opflow.primitive_ops` Operators are defined to be functions which take State functions to State functions. @@ -28,3 +40,4 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | + diff --git a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.md index 2ffffc20990..e374b0766ed 100644 --- a/docs/api/qiskit/0.42/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.42/qiskit.opflow.state_fns.md @@ -1,8 +1,20 @@ +--- +title: state_fns +description: API reference for qiskit.opflow.state_fns +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.opflow.state_fns +--- + # qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) +## State Functions + + + +`qiskit.opflow.state_fns` State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -27,3 +39,4 @@ Measurements are defined to be functionals over StateFns, taking them to real va | [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, ...]) | A class for sparse state functions and measurements in vector representation. | | [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, ...]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | | [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | + diff --git a/docs/api/qiskit/0.42/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.42/qiskit.scheduler.methods.basic.md index 6d0ab513269..6bef8c60c54 100644 --- a/docs/api/qiskit/0.42/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.42/qiskit.scheduler.methods.basic.md @@ -1,3 +1,11 @@ +--- +title: basic +description: API reference for qiskit.scheduler.methods.basic +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.methods.basic +--- + # qiskit.scheduler.methods.basic @@ -10,3 +18,4 @@ The most straightforward scheduling methods: scheduling **as early** or **as lat | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | `as_late_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as late as possible" (alap) scheduling policy. | | `as_soon_as_possible`(circuit, schedule\_config) | Return the pulse Schedule which implements the input circuit using an "as soon as possible" (asap) scheduling policy. | + diff --git a/docs/api/qiskit/0.42/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.42/qiskit.scheduler.schedule_circuit.md index a9e2086d690..36e4ab21f18 100644 --- a/docs/api/qiskit/0.42/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.42/qiskit.scheduler.schedule_circuit.md @@ -1,3 +1,11 @@ +--- +title: schedule_circuit +description: API reference for qiskit.scheduler.schedule_circuit +in_page_toc_min_heading_level: 1 +python_api_type: module +python_api_name: qiskit.scheduler.schedule_circuit +--- + # qiskit.scheduler.schedule\_circuit @@ -9,3 +17,4 @@ QuantumCircuit to Pulse scheduler. | | | | ----------------------------------------------------- | ---------------------------------------------------------------------------- | | `schedule_circuit`(circuit, schedule\_config\[, ...]) | Basic scheduling pass from a circuit to a pulse Schedule, using the backend. | + diff --git a/scripts/lib/api/processHtml.ts b/scripts/lib/api/processHtml.ts index 9963108bca4..61f0c001f57 100644 --- a/scripts/lib/api/processHtml.ts +++ b/scripts/lib/api/processHtml.ts @@ -406,7 +406,7 @@ export function maybeSetModuleMetadata( ): void { const modulePrefix = "module-"; const moduleIdWithPrefix = $main - .find("span, section") + .find("span, section, div.section") .toArray() .map((el) => $(el).attr("id")) .find((id) => id?.startsWith(modulePrefix));