qsharp Paket

Pakete

estimator
utils

Klassen

Pauli	Ein Q#-Pauli-Operator.
QSharpError	Vom Q#-Interpreter zurückgegebener Fehler.
Result	Ein Q#-Messergebnis.
ShotResult	Ein einzelnes Ergebnis eines Schusses.
StateDump	Ein Zustandsdump, das vom Q#-Interpreter zurückgegeben wird.
TargetProfile	Ein Q#-Zielprofil. Ein Zielprofil beschreibt die Funktionen der Hardware oder des Simulators, die zum Ausführen des Q#-Programms verwendet werden.

Functions

circuit

Synthetisiert eine Leitung für ein Q#-Programm. Es muss entweder ein Eintragsausdruck oder ein Vorgang angegeben werden.

ein Vorgang eines Lambdaausdrucks. Der Vorgang darf nur Qubits oder Arrays von Qubits als Parameter verwenden.

circuit(entry_expr: str | None = None, *, operation: str | None = None) -> Circuit

Parameter

Name	Beschreibung
entry_expr	Standardwert: None

Nur Schlüsselwortparameter

Name	Beschreibung
operation Erforderlich

Ausnahmen

Typ	Beschreibung
QSharpError	Wenn beim Synthisieren der Verbindung ein Fehler auftritt.

compile

Kompiliert den Q#-Quellcode in ein Programm, das an ein Ziel übermittelt werden kann.

Verwenden Sie str(), um die QIR-Zeichenfolge aus dem kompilierten Programm abzurufen.

Beispiel:

compile(entry_expr: str) -> QirInputData

Parameter

Name	Beschreibung
entry_expr Erforderlich	Der Q#-Ausdruck, der als Einstiegspunkt für das Programm verwendet wird.

Nur Schlüsselwortparameter

Name	Beschreibung
operation Erforderlich

Gibt zurück

Typ	Beschreibung
	Das kompilierte Programm.

Ausnahmen

Typ	Beschreibung
QSharpError	Wenn beim Synthisieren der Verbindung ein Fehler auftritt.

dump_circuit

Gibt den aktuellen Leitungszustand des Interpreters ab.

Diese Leitung enthält die Gates, die im Simulator bis zum aktuellen Punkt angewendet wurden.

dump_circuit() -> Circuit

Nur Schlüsselwortparameter

Name	Beschreibung
operation Erforderlich

Ausnahmen

Typ	Beschreibung
QSharpError	Wenn beim Synthisieren der Verbindung ein Fehler auftritt.

dump_machine

Gibt den Sparsezustandsvektor des Simulators als StateDump-Objekt zurück.

dump_machine() -> StateDump

Nur Schlüsselwortparameter

Name	Beschreibung
operation Erforderlich

Gibt zurück

Typ	Beschreibung
	Der Zustand des Simulators.

Ausnahmen

Typ	Beschreibung
QSharpError	Wenn beim Synthisieren der Verbindung ein Fehler auftritt.

estimate

Schätzt Ressourcen für Q#-Quellcode.

estimate(entry_expr, params: Dict[str, Any] | List | EstimatorParams | None = None) -> EstimatorResult

Parameter

Name	Beschreibung
entry_expr Erforderlich	Der Eintragsausdruck.
params	Die Parameter zum Konfigurieren der physischen Schätzung. Standardwert: None

Nur Schlüsselwortparameter

Name	Beschreibung
operation Erforderlich

Gibt zurück

Typ	Beschreibung
	Die geschätzten Ressourcen.

Ausnahmen

Typ	Beschreibung
QSharpError	Wenn beim Synthisieren der Verbindung ein Fehler auftritt.

eval

Wertet Q#-Quellcode aus.

Die Ausgabe wird in der Konsole gedruckt.

eval(source: str) -> Any

Parameter

Name	Beschreibung
source Erforderlich	Der auszuwertende Q#-Quellcode.

Nur Schlüsselwortparameter

Name	Beschreibung
operation Erforderlich

Gibt zurück

Typ	Beschreibung
	Der wert, der von der letzten Anweisung im Quellcode zurückgegeben wird.

Ausnahmen

Typ	Beschreibung
QSharpError	Wenn ein Fehler beim Auswerten des Quellcodes vorliegt.

init

Initialisiert den Q#-Interpreter.

init(*, target_profile: TargetProfile = TargetProfile.Unrestricted, project_root: str | None = None, language_features: List[str] = []) -> Config

Parameter

Name	Beschreibung
target_profile Erforderlich	Durch Festlegen des Zielprofils kann der Q#-Interpreter Programme generieren, die mit einem bestimmten Ziel kompatibel sind. Siehe :p y:class: qsharp. TargetProfile.
project_root Erforderlich	Ein optionaler Pfad zu einem Stammverzeichnis, in das ein Q#-Projekt eingeschlossen werden soll. Es muss ein qsharp.json Projektmanifest enthalten.

Nur Schlüsselwortparameter

Name	Beschreibung
target_profile	Standardwert: TargetProfile.Unrestricted
project_root Erforderlich
language_features Erforderlich

Ausnahmen

Typ	Beschreibung
QSharpError	Wenn beim Synthisieren der Verbindung ein Fehler auftritt.

run

Führt den angegebenen Q#-Ausdruck für die angegebene Anzahl von Aufnahmen aus. Jede Aufnahme verwendet eine unabhängige instance des Simulators.

eine List of ShotResults wird zurückgegeben.

run(entry_expr: str, shots: int, *, on_result: Callable[[ShotResult], None] | None = None, save_events: bool = False) -> List[Any]

Parameter

Name	Beschreibung
entry_expr Erforderlich
shots Erforderlich

Nur Schlüsselwortparameter

Name	Beschreibung
on_result Erforderlich
save_events Erforderlich

Ausnahmen

Typ	Beschreibung
QSharpError	Wenn ein Fehler bei der Interpretation der Eingabe vorliegt.

set_classical_seed

Legt den Seed für den Zufallszahlengenerator fest, der für klassische Zufallszahlenvorgänge der Standardbibliothek verwendet wird. Dies gilt für alle ausgeführten, kompilierten oder geschätzten Q#-Code.

set_classical_seed(seed: int | None) -> None

Parameter

Name	Beschreibung
seed Erforderlich	Der Seed, der für den klassischen Zufallszahlengenerator verwendet werden soll. Wenn Keine, wird der Seed aus der Entropie generiert.

Nur Schlüsselwortparameter

Name	Beschreibung
operation Erforderlich

Ausnahmen

Typ	Beschreibung
QSharpError	Wenn beim Synthisieren der Verbindung ein Fehler auftritt.

set_quantum_seed

Legt den Seed für den Zufallszahlengenerator fest, der für Quantenmessungen verwendet wird. Dies gilt für alle ausgeführten, kompilierten oder geschätzten Q#-Code.

set_quantum_seed(seed: int | None) -> None

Parameter

Name	Beschreibung
seed Erforderlich	Der Seed, der für den Quanten zufallszahlengenerator verwendet werden soll. Wenn Keine, wird der Seed aus der Entropie generiert.

Nur Schlüsselwortparameter

Name	Beschreibung
operation Erforderlich

Ausnahmen

Typ	Beschreibung
QSharpError	Wenn beim Synthisieren der Verbindung ein Fehler auftritt.