Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstring #201

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Add docstring #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
f96fd11
add docstring for gate_factory, richer docstring for state_vector_bat…
Glacialte Jan 10, 2025
28c1fe3
add f32 module
Glacialte Jan 14, 2025
980271e
undo changes
Glacialte Jan 17, 2025
2c4ffc0
iroiro fix
Glacialte Jan 17, 2025
cbae27d
mini fix for conf.py, remove export_values() for pauli_enum in pauli_…
Glacialte Jan 24, 2025
b70955f
add concatenate_descriotion() to gate.hpp
Glacialte Jan 28, 2025
061a608
Merge remote-tracking branch 'origin/main' into add-docstring
Glacialte Jan 28, 2025
ddc91df
fix python package
Glacialte Jan 28, 2025
d7a92d5
mini fix example, gate.hpp
Glacialte Jan 31, 2025
48a7065
reflect description for circuit, operator, paulioperator, statevector…
Glacialte Jan 31, 2025
bcf4211
add description of constructors
Glacialte Feb 14, 2025
fc33700
mini fix
Glacialte Feb 14, 2025
6dff6f4
remove unnecessary option in conf.py
Glacialte Feb 14, 2025
dc7e967
add more detailed description
Glacialte Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
import sys
import subprocess
from pathlib import Path

subprocess.run([sys.executable, '-m', 'nanobind.stubgen', '-m', 'scaluq.scaluq_core', '-o', './stub/scaluq/__init__.py'])
subprocess.run([sys.executable, '-m', 'nanobind.stubgen', '-m', 'scaluq.scaluq_core.gate', '-o', './stub/scaluq/gate.py'])
stub_dir = Path('./stub/scaluq/')
stub_dir.mkdir(parents=True, exist_ok=True)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GateType initialize などはサブモジュールに含まれていないのでscaluq_core直下の分も入れてほしい

subprocess.run([sys.executable, '-m', 'nanobind.stubgen',
'-m', 'scaluq.scaluq_core.f64',
'-o', './stub/scaluq/f64/__init__.py'])

subprocess.run([sys.executable, '-m', 'nanobind.stubgen',
'-m', 'scaluq.scaluq_core.f64.gate',
'-o', './stub/scaluq/f64/gate.py'])

subprocess.run([sys.executable, '-m', 'nanobind.stubgen',
'-m', 'scaluq.scaluq_core.f32',
'-o', './stub/scaluq/f32/__init__.py'])

subprocess.run([sys.executable, '-m', 'nanobind.stubgen',
'-m', 'scaluq.scaluq_core.f32.gate',
'-o', './stub/scaluq/f32/gate.py'])

project = 'scaluq'
copyright = '2024, Fuji Lab.'
Expand All @@ -22,8 +39,8 @@
autoapi_file_patterns = ["*.py"]
autoapi_dirs = ["./stub/scaluq"]
autoapi_add_toctree_entry = True

autoapi_python_class_content = 'class'

autoapi_options = [
"members",
"undoc-members",
Expand All @@ -32,6 +49,8 @@
"imported-members",
]

autodoc_typehints = 'description'

html_theme = "sphinx_rtd_theme"

# `version` is only used for local build.
Expand Down
295 changes: 151 additions & 144 deletions exe/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,159 +7,166 @@ using namespace nlohmann;

int main() {
scaluq::initialize(); // must be called before using any scaluq methods
{
std::uint64_t n_qubits = 3;
scaluq::StateVector<double> state(n_qubits);
state.load({0, 1, 2, 3, 4, 5, 6, 7});
Json j = state;
std::cout << j << std::endl;
state = j;
std::cout << state << std::endl;
// {
// std::uint64_t n_qubits = 3;
// scaluq::StateVector<double> state(n_qubits);
// state.load({0, 1, 2, 3, 4, 5, 6, 7});
// Json j = state;
// std::cout << j << std::endl;
// state = j;
// std::cout << state << std::endl;

scaluq::Circuit<double> circuit(n_qubits);
circuit.add_gate(scaluq::gate::X<double>(0));
circuit.add_gate(scaluq::gate::CNot<double>(0, 1));
circuit.add_gate(scaluq::gate::Y<double>(1));
circuit.add_gate(scaluq::gate::RX<double>(1, std::numbers::pi / 2));
circuit.update_quantum_state(state);
// scaluq::Circuit<double> circuit(n_qubits);
// circuit.add_gate(scaluq::gate::X<double>(0));
// circuit.add_gate(scaluq::gate::CNot<double>(0, 1));
// circuit.add_gate(scaluq::gate::Y<double>(1));
// circuit.add_gate(scaluq::gate::RX<double>(1, std::numbers::pi / 2));
// circuit.update_quantum_state(state);

scaluq::Operator<double> observable(n_qubits);
observable.add_random_operator(1, 0);
auto value = observable.get_expectation_value(state);
std::cout << value << std::endl;
}
{
std::uint64_t n_qubits = 2, batch_size = 2;
scaluq::StateVectorBatched<double> states(batch_size, n_qubits);
states.set_Haar_random_state(batch_size, n_qubits, false);
// scaluq::Operator<double> observable(n_qubits);
// observable.add_random_operator(1, 0);
// auto value = observable.get_expectation_value(state);
// std::cout << value << std::endl;
// }
// {
// std::uint64_t n_qubits = 2, batch_size = 2;
// scaluq::StateVectorBatched<double> states(batch_size, n_qubits);
// states.set_Haar_random_state(batch_size, n_qubits, false);

Circuit<double> cirq(n_qubits);
cirq.add_param_gate(gate::ParamRX<double>(1, {2}), "RX");
std::map<std::string, std::vector<double>> params = {{"RX", {0.5, 1.5}}};
cirq.update_quantum_state(states, params);
// Circuit<double> cirq(n_qubits);
// cirq.add_param_gate(gate::ParamRX<double>(1, {2}), "RX");
// std::map<std::string, std::vector<double>> params = {{"RX", {0.5, 1.5}}};
// cirq.update_quantum_state(states, params);

Json j = states;
std::cout << j << std::endl;
states = j;
std::cout << states << std::endl;
}
{
double coef = 2.0;
std::string pauli_string = "X 0 Z 1 Y 2";
PauliOperator<double> pauli(pauli_string, coef);
Json j = pauli;
std::cout << j << std::endl;
pauli = j;
}
{
std::uint64_t n_qubits = 3;
Operator<double> op(n_qubits);
op.add_operator({0b001, 0b010, Complex<double>(2)});
op.add_operator({"X 2 Y 1", 1});
Json j = op;
std::cout << j << std::endl;
op = j;
}
{
std::cout << Json(gate::I<double>()) << std::endl;
std::cout << Json(gate::X<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::Y<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::Z<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::H<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::S<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::Sdag<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::T<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::Tdag<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::SqrtX<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::SqrtXdag<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::SqrtY<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::SqrtYdag<double>(2, {0, 3})) << std::endl;
std::cout << Json(gate::RX<double>(2, 0.5, {0, 3})) << std::endl;
std::cout << Json(gate::RY<double>(2, 0.5, {0, 3})) << std::endl;
std::cout << Json(gate::RZ<double>(2, 0.5, {0, 3})) << std::endl;
std::cout << Json(gate::U1<double>(2, 0.5, {0, 3})) << std::endl;
std::cout << Json(gate::U2<double>(2, 0.5, 0.3, {0, 3})) << std::endl;
std::cout << Json(gate::U3<double>(2, 0.5, 0.3, 0.1, {0, 3})) << std::endl;
std::cout << Json(gate::Swap<double>(1, 2, {0, 3})) << std::endl;
// Json j = states;
// std::cout << j << std::endl;
// states = j;
// std::cout << states << std::endl;
// }
// {
// double coef = 2.0;
// std::string pauli_string = "X 0 Z 1 Y 2";
// PauliOperator<double> pauli(pauli_string, coef);
// Json j = pauli;
// std::cout << j << std::endl;
// pauli = j;
// }
// {
// std::uint64_t n_qubits = 3;
// Operator<double> op(n_qubits);
// op.add_operator({0b001, 0b010, Complex<double>(2)});
// op.add_operator({"X 2 Y 1", 1});
// Json j = op;
// std::cout << j << std::endl;
// op = j;
// }
// {
// std::cout << Json(gate::I<double>()) << std::endl;
// std::cout << Json(gate::X<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::Y<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::Z<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::H<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::S<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::Sdag<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::T<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::Tdag<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::SqrtX<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::SqrtXdag<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::SqrtY<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::SqrtYdag<double>(2, {0, 3})) << std::endl;
// std::cout << Json(gate::RX<double>(2, 0.5, {0, 3})) << std::endl;
// std::cout << Json(gate::RY<double>(2, 0.5, {0, 3})) << std::endl;
// std::cout << Json(gate::RZ<double>(2, 0.5, {0, 3})) << std::endl;
// std::cout << Json(gate::U1<double>(2, 0.5, {0, 3})) << std::endl;
// std::cout << Json(gate::U2<double>(2, 0.5, 0.3, {0, 3})) << std::endl;
// std::cout << Json(gate::U3<double>(2, 0.5, 0.3, 0.1, {0, 3})) << std::endl;
// std::cout << Json(gate::Swap<double>(1, 2, {0, 3})) << std::endl;

PauliOperator<double> pauli("X 2 Y 1");
std::cout << Json(gate::Pauli<double>(pauli)) << std::endl;
std::cout << Json(gate::PauliRotation<double>(pauli, 0.5)) << std::endl;
// PauliOperator<double> pauli("X 2 Y 1");
// std::cout << Json(gate::Pauli<double>(pauli)) << std::endl;
// std::cout << Json(gate::PauliRotation<double>(pauli, 0.5)) << std::endl;

auto probgate =
gate::Probablistic<double>({.1, .9}, {gate::X<double>(0), gate::I<double>()});
std::cout << Json(probgate) << std::endl;
// auto probgate =
// gate::Probablistic<double>({.1, .9}, {gate::X<double>(0), gate::I<double>()});
// std::cout << Json(probgate) << std::endl;

std::cout << Json(gate::ParamRX<double>(2, 1.5, {0, 3})) << std::endl;
std::cout << Json(gate::ParamRY<double>(2, 1.5, {0, 3})) << std::endl;
std::cout << Json(gate::ParamRZ<double>(2, 1.5, {0, 3})) << std::endl;
std::cout << Json(gate::ParamPauliRotation<double>(pauli, 0.5)) << std::endl;
// std::cout << Json(gate::ParamRX<double>(2, 1.5, {0, 3})) << std::endl;
// std::cout << Json(gate::ParamRY<double>(2, 1.5, {0, 3})) << std::endl;
// std::cout << Json(gate::ParamRZ<double>(2, 1.5, {0, 3})) << std::endl;
// std::cout << Json(gate::ParamPauliRotation<double>(pauli, 0.5)) << std::endl;

auto paramprobgate = gate::ParamProbablistic<double>(
{.1, .9}, {gate::ParamRX<double>(0), gate::I<double>()});
std::cout << Json(paramprobgate) << std::endl;
}
// auto paramprobgate = gate::ParamProbablistic<double>(
// {.1, .9}, {gate::ParamRX<double>(0), gate::I<double>()});
// std::cout << Json(paramprobgate) << std::endl;
// }
// {
// auto x = gate::X<double>(1, {2});
// Json j = x;
// std::cout << j << std::endl;
// Gate<double> gate = j;
// std::cout << gate << std::endl;
// }
// {
// auto x = gate::RX<double>(1, 0.5, {2});
// Json j = x;
// std::cout << j << std::endl;
// Gate<double> gate = j;
// std::cout << gate << std::endl;
// }
// {
// auto x = gate::Swap<double>(1, 3, {2});
// Json j = x;
// std::cout << j << std::endl;
// Gate<double> gate = j;
// std::cout << gate << std::endl;
// }
// {
// PauliOperator<double> pauli("X 2 Y 1");
// auto x = gate::PauliRotation<double>(pauli, 1.5, {0, 3});
// Json j = x;
// std::cout << j << std::endl;
// Gate<double> gate = j;
// std::cout << gate << std::endl;
// }
// {
// auto probgate =
// gate::Probablistic<double>({.1, .9}, {gate::X<double>(0, {2, 3}),
// gate::I<double>()});
// Json j = probgate;
// std::cout << j << std::endl;
// Gate<double> gate = j;
// std::cout << gate << std::endl;
// }
// {
// auto x = gate::ParamRX<double>(1, {2});
// Json j = x;
// std::cout << j << std::endl;
// ParamGate<double> gate = j;
// std::cout << gate << std::endl;
// }
// {
// auto paramprobgate = gate::ParamProbablistic<double>(
// {.1, .9}, {gate::ParamRX<double>(0), gate::I<double>()});
// Json j = paramprobgate;
// std::cout << j << std::endl;
// ParamGate<double> gate = j;
// std::cout << gate << std::endl;
// }
// {
// Circuit<double> circuit(10);
// circuit.add_gate(gate::X<double>(0, {3}));
// circuit.add_param_gate(gate::ParamRX<double>(0, 0.5, {3}), "RX");
// Json j = circuit;
// std::cout << j << std::endl;
// Circuit<double> c = j;
// std::cout << Json(c) << std::endl;
// }
{
auto x = gate::X<double>(1, {2});
Json j = x;
std::cout << j << std::endl;
Gate<double> gate = j;
std::cout << gate << std::endl;
int n_qubits = 1;
StateVector<double> state(n_qubits);
auto sqrtx = gate::SqrtX<double>(0, {});
auto mat = sqrtx->get_matrix();
std::cout << mat << std::endl;
}
{
auto x = gate::RX<double>(1, 0.5, {2});
Json j = x;
std::cout << j << std::endl;
Gate<double> gate = j;
std::cout << gate << std::endl;
}
{
auto x = gate::Swap<double>(1, 3, {2});
Json j = x;
std::cout << j << std::endl;
Gate<double> gate = j;
std::cout << gate << std::endl;
}
{
PauliOperator<double> pauli("X 2 Y 1");
auto x = gate::PauliRotation<double>(pauli, 1.5, {0, 3});
Json j = x;
std::cout << j << std::endl;
Gate<double> gate = j;
std::cout << gate << std::endl;
}
{
auto probgate =
gate::Probablistic<double>({.1, .9}, {gate::X<double>(0, {2, 3}), gate::I<double>()});
Json j = probgate;
std::cout << j << std::endl;
Gate<double> gate = j;
std::cout << gate << std::endl;
}
{
auto x = gate::ParamRX<double>(1, {2});
Json j = x;
std::cout << j << std::endl;
ParamGate<double> gate = j;
std::cout << gate << std::endl;
}
{
auto paramprobgate = gate::ParamProbablistic<double>(
{.1, .9}, {gate::ParamRX<double>(0), gate::I<double>()});
Json j = paramprobgate;
std::cout << j << std::endl;
ParamGate<double> gate = j;
std::cout << gate << std::endl;
}
{
Circuit<double> circuit(10);
circuit.add_gate(gate::X<double>(0, {3}));
circuit.add_param_gate(gate::ParamRX<double>(0, 0.5, {3}), "RX");
Json j = circuit;
std::cout << j << std::endl;
Circuit<double> c = j;
std::cout << Json(c) << std::endl;
}

scaluq::finalize();
}
2 changes: 1 addition & 1 deletion exe/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def main():

print(operator.to_json())

states = StateVectorBatched.Haar_random_state(2, 3)
states = StateVectorBatched.Haar_random_state(2, 3, False)
prx = gate.ParamRX(0, 2.0, [1])
pry = gate.ParamRY(1, 2.0, [2])
params = {
Expand Down
Loading