qsharp 包

包

estimator
utils

类

Pauli	Q# Pauli 运算符。
QSharpError	Q# 解释器返回的错误。
Result	Q# 度量结果。
ShotResult	一次拍摄的单个结果。
StateDump	从 Q# 解释器返回的状态转储。
TargetProfile	Q# 目标配置文件。 目标配置文件描述将用于运行 Q# 程序的硬件或模拟器的功能。

函数

circuit

合成 Q# 程序的线路。 必须提供条目表达式或操作。

lambda 表达式的操作。 该操作必须仅采用量子比特或量子比特数组作为参数。

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

参数

名称	说明
entry_expr	默认值: None

仅限关键字的参数

名称	说明
operation 必需

例外

类型	说明
QSharpError	如果合成线路时出错。

compile

将 Q# 源代码编译为可提交到目标的程序。

若要从编译的程序获取 QIR 字符串，请使用 str () 。

例如：

compile(entry_expr: str) -> QirInputData

参数

名称	说明
entry_expr 必需	将用作程序的入口点的 Q# 表达式。

仅限关键字的参数

名称	说明
operation 必需

返回

类型	说明
	已编译的程序。

例外

类型	说明
QSharpError	如果合成线路时出错。

dump_circuit

转储解释器的当前线路状态。

此线路将包含已在模拟器中应用到当前点的入口。

dump_circuit() -> Circuit

仅限关键字的参数

名称	说明
operation 必需

例外

类型	说明
QSharpError	如果合成线路时出错。

dump_machine

返回模拟器的稀疏状态向量作为 StateDump 对象。

dump_machine() -> StateDump

仅限关键字的参数

名称	说明
operation 必需

返回

类型	说明
	模拟器的状态。

例外

类型	说明
QSharpError	如果合成线路时出错。

estimate

估计 Q# 源代码的资源。

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

参数

名称	说明
entry_expr 必需	条目表达式。
params	用于配置物理估计的参数。 默认值: None

仅限关键字的参数

名称	说明
operation 必需

返回

类型	说明
	估计的资源。

例外

类型	说明
QSharpError	如果合成线路时出错。

eval

评估 Q# 源代码。

输出输出输出到控制台。

eval(source: str) -> Any

参数

名称	说明
source 必需	要评估的 Q# 源代码。

仅限关键字的参数

名称	说明
operation 必需

返回

类型	说明
	由源代码中最后一个语句返回的值。

例外

类型	说明
QSharpError	如果评估源代码时出错。

init

初始化 Q# 解释器。

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

参数

名称	说明
target_profile 必需	设置目标配置文件允许 Q# 解释器生成与特定目标兼容的程序。 请参阅 :p y：class： qsharp。TargetProfile。
project_root 必需	包含 Q# 项目的根目录的可选路径。 它必须包含qsharp.json项目清单。

仅限关键字的参数

名称	说明
target_profile	默认值: TargetProfile.Unrestricted
project_root 必需
language_features 必需

例外

类型	说明
QSharpError	如果合成线路时出错。

run

针对给定的拍摄次数运行给定的 Q# 表达式。 每个镜头都使用模拟器的独立实例。

返回 ShotResults 列表。

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

参数

名称	说明
entry_expr 必需
shots 必需

仅限关键字的参数

名称	说明
on_result 必需
save_events 必需

例外

类型	说明
QSharpError	如果解释输入时出错。

set_classical_seed

设置用于标准库经典随机数运算的随机数生成器的种子。 这适用于执行、编译或估计的所有 Q# 代码。

set_classical_seed(seed: int | None) -> None

参数

名称	说明
seed 必需	用于经典随机数生成器的种子。 如果为 None，则将从熵生成种子。

仅限关键字的参数

名称	说明
operation 必需

例外

类型	说明
QSharpError	如果合成线路时出错。

set_quantum_seed

设置用于量子测量的随机数生成器的种子。 这适用于执行、编译或估计的所有 Q# 代码。

set_quantum_seed(seed: int | None) -> None

参数

名称	说明
seed 必需	用于量子随机数生成器的种子。 如果为 None，则将从熵生成种子。

仅限关键字的参数

名称	说明
operation 必需

例外

类型	说明
QSharpError	如果合成线路时出错。