qsharp Пакет

Пакеты

estimator
utils

Классы

Pauli	Оператор Q# Паули.
QSharpError	Ошибка, возвращенная интерпретатором Q#.
Result	Результат измерения Q#.
ShotResult	Один результат выстрела.
StateDump	Дамп состояния, возвращенный интерпретатором Q#.
TargetProfile	Целевой профиль Q#. Целевой профиль описывает возможности оборудования или симулятора, которые будут использоваться для запуска программы Q#.

Функции

circuit

Синтезирует цепь для программы Q#. Необходимо указать выражение записи или операцию.

операция лямбда-выражения. Операция должна принимать в качестве параметров только кубиты или массивы кубитов.

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

Параметры

Имя	Описание
entry_expr	значение по умолчанию: None

Параметры Keyword-Only

Имя	Описание
operation Обязательно

Исключения

Тип	Описание
QSharpError	Если возникает ошибка при синтезе цепи.

compile

Компилирует исходный код Q# в программу, которую можно отправить в целевой объект.

Чтобы получить строку QIR из скомпилированной программы, используйте str().

Пример

compile(entry_expr: str) -> QirInputData

Параметры

Имя	Описание
entry_expr Обязательно	Выражение Q#, которое будет использоваться в качестве точки входа для программы.

Параметры Keyword-Only

Имя	Описание
operation Обязательно

Возвращаемое значение

Тип	Описание
	Скомпилированная программа.

Исключения

Тип	Описание
QSharpError	Если возникает ошибка при синтезе цепи.

dump_circuit

Создает дамп текущего состояния канала интерпретатора.

Этот канал будет содержать шлюзы, которые были применены в симуляторе до текущей точки.

dump_circuit() -> Circuit

Параметры Keyword-Only

Имя	Описание
operation Обязательно

Исключения

Тип	Описание
QSharpError	Если возникает ошибка при синтезе цепи.

dump_machine

Возвращает разреженный вектор состояния симулятора в виде объекта StateDump.

dump_machine() -> StateDump

Параметры Keyword-Only

Имя	Описание
operation Обязательно

Возвращаемое значение

Тип	Описание
	Состояние симулятора.

Исключения

Тип	Описание
QSharpError	Если возникает ошибка при синтезе цепи.

estimate

Оценивает ресурсы для исходного кода Q#.

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

Параметры

Имя	Описание
entry_expr Обязательно	Выражение записи.
params	Параметры для настройки физической оценки. значение по умолчанию: None

Параметры Keyword-Only

Имя	Описание
operation Обязательно

Возвращаемое значение

Тип	Описание
	Предполагаемые ресурсы.

Исключения

Тип	Описание
QSharpError	Если возникает ошибка при синтезе цепи.

eval

Оценивает исходный код Q#.

Вывод выводится в консоль.

eval(source: str) -> Any

Параметры

Имя	Описание
source Обязательно	Исходный код Q#, который требуется оценить.

Параметры Keyword-Only

Имя	Описание
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.

Параметры Keyword-Only

Имя	Описание
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 Обязательно

Параметры Keyword-Only

Имя	Описание
on_result Обязательно
save_events Обязательно

Исключения

Тип	Описание
QSharpError	Если имеется ошибка при интерпретации входных данных.

set_classical_seed

Задает начальное значение для генератора случайных чисел, используемого для классических операций со случайными числами стандартной библиотеки. Это относится ко всем выполняемым, скомпилированным или предполагаемым кодам Q#.

set_classical_seed(seed: int | None) -> None

Параметры

Имя	Описание
seed Обязательно	Начальное значение, используемое для классического генератора случайных чисел. Если значение отсутствует, начальное значение будет создано из энтропии.

Параметры Keyword-Only

Имя	Описание
operation Обязательно

Исключения

Тип	Описание
QSharpError	Если возникает ошибка при синтезе цепи.

set_quantum_seed

Задает начальное значение для генератора случайных чисел, используемого для квантовых измерений. Это относится ко всем выполняемым, скомпилированным или предполагаемым кодам Q#.

set_quantum_seed(seed: int | None) -> None

Параметры

Имя	Описание
seed Обязательно	Начальное значение, используемое для квантового генератора случайных чисел. Если значение отсутствует, начальное значение будет создано из энтропии.

Параметры Keyword-Only

Имя	Описание
operation Обязательно

Исключения

Тип	Описание
QSharpError	Если возникает ошибка при синтезе цепи.