From 40cab27e61f69e6aab3ddb58b7247aedb1a989be Mon Sep 17 00:00:00 2001 From: arfy slowy Date: Mon, 5 Feb 2024 10:20:57 +0700 Subject: [PATCH] Development (#5) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: adding documentation [Documentation] adding information about using testing example Signed-off-by: slowy07 * docs: adding documentation [Documentation] ``include/constants.h`` adding commented code for information about variable ``chop``, `maxn`, `eps` ``include/internal/classFunction/iomanip.h`` ``IDisplay`` class is an abstract class the provides a generic interface for displaying object . the ``Display_Impl_`` class concrete class that implements the ``IDisplay`` interface for Eigen matrices. - the first constructor takes an eigen matrix as input and double as a parameter, the double parameter specifies amount of chopping that should be done whne displaying the matrix - the second constructure takes a complex number as input an a double as parameter, the double parameter specifieds tha amount of chopping that soubld be done when displaying the complex number ``include/traits.h`` adding preprocessor directive to check the version of the GCC compiler ``clara_test/tests/traits.cpp`` adding testing for test ``traits.h`` ``clara_test/run_test`` adding support for macOs and support for ubuntu and arch based package Signed-off-by: slowy07 * chore(test): adding run_test interactive to github action Signed-off-by: slowy07 * fix: fixing directories Signed-off-by: slowy07 * fix: fixing directories Signed-off-by: slowy07 * chroe: ``evects`` function (#1) added necessary using statements to define ComplexScalar and ComplexMatrix types for handling complex numbers. replaced dyn_mat with Eigen::Matrix to match the type of rA. improved the check for matrix size by comparing the rows and columns separately. changed rA.template cas() to rA.template cast() to handle complex matrix conversion. * chore(add): adding more information and unitest [Documentation] adding reference used in clara adding unitest for mac os Signed-off-by: slowy07 * fix: fix interpreter Signed-off-by: slowy07 * fix: fix interpreter Signed-off-by: slowy07 * chore(feat): improvement exception function call [Documentation] make expection hierarchy for custom exceptions, this exception based on the standard ``std::exception`` class, provide a mechanisem for creating custom exception types with specific description that can be thrown and caught in the application code Signed-off-by: slowy07 * chore(feat): update ``testing/_test.cpp`` [Documentation] testing quantum bit manipulation - the code initialize the number of bits and the number of trials. it creates a vector of vectors called `indices`, where each sub-vector contains indices representing bits for trial operations - it perform a series trials using `TOF` operation on the `Bit_circuit`, the `TOF` operation applies controlled NOT operation on the specified bits in the circuit - after the trials the code display the initial and final states of the bit circuit as well as the hamming weight ( number of set bits ) - create `ket` and `bra` instance representing quantim states and display them using the `disp` function Signed-off-by: slowy07 * chore(feat): update ``testing/grover_search.cpp`` [Documentation] grover algorithm starts with equal superposition of all possible states, then iteratively applies the oracle and diffusion operator to amplify the probability of the marked state while reducing the probability of other states, after a sufficient number of iterations, measuring the final state gives a high probability of obtaining the marked state fix: fixing ``clara/include/operations.h`` [Documentation] fixing code to provide a flexible efficient way to apply a controlled quantum gate a quantum state, allowing for various types of control and target subsystem configurations. the use of eigen library provides efficient matrix operations, and the code is optimized for performance using multi-threading fix: fixing ``clara/include/random.h`` fixing function to provide a convenient and safe way to generate random indices whithin specified range, making use of the standard library random number generation capabilitesm use of thread local random number generators is particularly helpful multi-threading applications to avoid potential concurency issues Signed-off-by: slowy07 * chore(attemp: 1): testing grover search and testing channels Signed-off-by: slowy07 * docs: adding documentation Signed-off-by: slowy07 * chore: test macos environment (#3) * fix: typo spelling run * fix: header fix test on macOS clara Signed-off-by: slowy07 * fix: header fix test on macOS clara Signed-off-by: slowy07 * fix: header fix test on macOS clara Signed-off-by: slowy07 * fix: header fix test on macOS clara Signed-off-by: slowy07 * fix: header fix test on macOS clara Signed-off-by: slowy07 * fix: header fix test on macOS clara Signed-off-by: slowy07 * fix: remove temporary macos Signed-off-by: slowy07 * feat: add testing with docker image * docs: update Documentation [Documentation] code documentation is a collection of documents and code comments explaining how code works and how to use it. Signed-off-by: slowy07 * fix: identation action test Signed-off-by: slowy07 * chore: adding operation testing [Documentation] AllTest: applies a custom quantum gate represented by the Pauli X gate (`gt.x`) to a single qubit state (`ket psi = 1_ket`) and checks if the result matches the expected state ('0_ket') and checks if the result matches the expected state (`0_ket`) EmptyControl: test case validation the functionally of applying controlled quantum gates (`U`) to a pure state (`ket psi`) and a density matrix (`cmat rho`). it randomly generates a quantum state and applies the random quantum gate `u` to both he pure state and the corresponding density matrix. the result are compared to check if they are approximately equal within a specified tolerance [Documentation random testing clara] AllTest: generate two `bigint` value `a` and `b`, both set to 42. it then calls the `clara::rand` function with `a` and `b` as input parameter. the test verifies that the output of the `clara:rand` function falls within the range [a, b] (inclusive), and thus, it is expected to be equal to either `a` or `b` Average: further examines the random double generation by calculation by calculating the average of the generated `N` random double values within range [-10, 10]. the average value is then checked to ensure that its approximately close to 0 with a tolerance of 2e-1 Signed-off-by: slowy07 * chore: trying update code with macOS test clara [Documentation] testing on macOS according issue #4 Signed-off-by: slowy07 * fix: environment changes Signed-off-by: slowy07 * fix: try use xcode --install referenced issues #4 Signed-off-by: slowy07 * fix: try use xcode --install referenced issues #4 Signed-off-by: slowy07 * fix: fixing cmake referenced issues #4 Signed-off-by: slowy07 * fix: testing timer according #4 Signed-off-by: slowy07 * fix: testing timer according #4 Signed-off-by: slowy07 * fix: testing timer according #4 Signed-off-by: slowy07 * docs: update documentation Signed-off-by: slowy07 * docs: adding more documentation [Documentation] adding more documentation on ``include`` Signed-off-by: slowy07 * chore: testing adding action environment windows test Signed-off-by: slowy07 * fix: test with specific command to test on windows Signed-off-by: slowy07 * fix: test rmdir to rd according information from microsoft official website : https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/rd Signed-off-by: slowy07 * fix: test rd to rmdir with shell powershell according information from microsoft official website : https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/rd Signed-off-by: slowy07 * fix: test to adding path from eigen was installed Signed-off-by: slowy07 * fix: testing env github action path setting eigen according from github documentation: https://docs.github.com/en/actions/learn-github-actions/variables Signed-off-by: slowy07 * fix: testing env github action path setting eigen according from github documentation: https://docs.github.com/en/actions/learn-github-actions/variables Signed-off-by: slowy07 * fix: attemp fixing on directory command Signed-off-by: slowy07 * fix: try to adding cmake list for windows Signed-off-by: slowy07 * fix: typo Signed-off-by: slowy07 * fix: call cmake Signed-off-by: slowy07 * fix: call cmake Signed-off-by: slowy07 * fix: call cmake Signed-off-by: slowy07 * fix: call cmake Signed-off-by: slowy07 * fix: remove windows test and adding on arch latest Signed-off-by: slowy07 * fix: adding Signed-off-by: slowy07 * fix: adding separate the install test Signed-off-by: slowy07 * fix: adding arch based by separated the test Signed-off-by: slowy07 * fix: adding arch based by separated the test Signed-off-by: slowy07 * chore: update shell test Signed-off-by: slowy07 * fix: rename testing filename Signed-off-by: slowy07 * chore: testing GPU support install Signed-off-by: slowy07 * chore: attemp (1) test gpu CUDA Signed-off-by: slowy07 * chore: attemp (2) test gpu CUDA Signed-off-by: slowy07 * chore: attemp (3) test base on windows Signed-off-by: slowy07 * chore: attemp (4) test base on windows Signed-off-by: slowy07 * chore: attemp (5) test base on windows Signed-off-by: slowy07 * chore: attemp (6) test base on windows Signed-off-by: slowy07 * chore: attemp (7) test base on windows Signed-off-by: slowy07 * fix: fixing CWE-120, CWE-20 [Documentation] information CWE-120: The product copies an input buffer to an output buffer without verifying that the size of the input buffer is less than the size of the output buffer, leading to a buffer overflow. fix: typo on input_output.h fix: delete windows test chore: adding ``input_output_testing`` [Documentation] adding unitesting using google test framwork to test the functionallity of the `save` and `load` function from `clara` library `input_output` Signed-off-by: slowy07 * docs: adding documentation code chore: update ``experimental_test`` [Documentation] The `experimental_test.h` header file defines classes and functions for simulating quantum circuits. The classes provided are: - `clara::experimental::ClaraCircuit`: Represents a quantum circuit for simulation. - `clara::experimental::LogicalCircuit`: Represents a logical circuit with gates and their details. - `clara::experimental::Test`: Represents a test class for quantum circuit operations. ClaraCircuit Class This class represents a quantum circuit for simulation. It provides functionalities for creating, manipulating, and simulating quantum circuits. Class: `clara::experimental::ClaraCircuit` - Constructor: Initializes a quantum circuit. Parameters: - `number_qubit`: Number of qubits in the circuit. - `number_classical`: Number of classical bits in the circuit. - `dimension`: Dimension of the quantum state space (default: 2). - Methods: - `measure(std::vector subsys)`: Measures specified subsystem qubits. - `measure_all()`: Measures all unmeasured qubits in the circuit. - `apply(const cmat& gate, const std::vector& subsys)`: Applies a quantum gate to specified subsystem qubits. - `apply_all(const cmat& gate)`: Applies a quantum gate to all unmeasured qubits. - `reset()`: Resets the quantum circuit to its initial state. - Accessor methods for retrieving circuit information: - `dimension()`: Returns the dimension of the quantum state space. - `get_number_qubit()`: Returns the number of qubits in the circuit. - `get_number_classical()`: Returns the number of classical bits in the circuit. - `get_size()`: Returns the total size of the circuit (qubits + classical bits). - `get_num_measured_qubits()`: Returns the number of measured qubits. - `get_num_active_qubits()`: Returns the number of active (unmeasured) qubits. - `get_psi()`: Returns the current quantum state of the circuit. - `get_results()`: Returns the measured results as a vector of indices. - `get_results_as_N()`: Returns the measured results as an integer in base-N representation. - `bits()`: Returns a reference to the classical bits associated with the circuit. LogicalCircuit Class This class represents a logical circuit with gates and their details. Class: `clara::experimental::LogicalCircuit` - Methods: - `add(const cmat& gate, const std::string& gate_name, const idx_vec& ctrl, const idx_vec& target)`: Adds a gate to the logical circuit. - `gate_gate_count()`: Returns the total count of gates added to the logical circuit. - `display(std::ostream& os) const`: Displays the logical circuit's gates and their details. chore: add more testing for make sure code works very well chore: adding reversible [Documentation] provided functionalities to work with dynamic bitset, perform bitwise operations, and represent bit circuits with various gate operations Signed-off-by: slowy07 * fix: testing timer Signed-off-by: slowy07 * chore: more upgrade stuff [Documentation] change from `pi` to `std::pi` docs: add more documentation `gates.h` fix: fixing entanglement which testing always return `out of range` Signed-off-by: slowy07 * chore: add quantum operation [Documentation] this code demonstrate various quantum channels using clara lib. it perform operations on a quantum state, such as partial transpose, measurement channels application and entropy computation. `performChannelsOperations()`: - step process - create the initial state `|00⟩ + |11⟩` and display it - perform partial transpose on the first subsystem of the state and display eigen values - set up a measurement channels with two kraus operators (pauli Z operatios for `|0⟩` and `|11⟩`) - apply the measurement channels to first subsystem and display the resulting state - partially trace down the second subsystem and display the resulting state. -compute and diplasy the von-neummann entropy of the final state. Signed-off-by: slowy07 * docs: adding documentation on ``functions.h`` [Documentation] function applies a scalar function element-wise to each entry of the input matrix 'A'. the result is a new matrix of the same dimensions, where each entry is the result of applying the provided scalar function to the corresponding entry in 'A'. Signed-off-by: slowy07 * chore: adding quantum fourier transform [Documentation] adding algorithm that can be used to efficiently transform a quantum state from one basis to another. - Command Line Argument the code check if exactly two command line arguments are provided, if not it prints an errpr message and exists the program - Extracting Command Line Arguments - the number CPU cores to use (`num_core`) and the number qubits in quantum system (`n`) are extracted from the command line arguments - Setting OpenMP Threads - the number of OpenMP threads to use for parallel processing is set to `num_core` - Creating Quantum State Vector - A vector `qubits` is created to store indices - A quantum state vector `psi` is created using `mket` function with the qubit indices. - An initial copy `result` of the quantum state is also created - Measuring Execution Time - A `Timer` object `t` is created to measure the execution time - Quantum operations - A loops iterates over each qubit index - A hadamard gate (`gt.H`) applied to each qubit - Another Nested llop applies controlled-phase gate, where the control and target qubits are determined by the loop indices - The gate are applied to the `result` quantum state vector - Qubit Swap Operations - Another loop swaps qubit state using the `gt.SWAP` gate - Qubit at specific indices are swapped - Printing Result - the program prints the number of CPU cores used, the number of qubits, and the execution time measured by the timer Signed-off-by: slowy07 * .git/refs/COMMIT_EDITMSG Signed-off-by: slowy07 * fix: remove testing shoutOperator Signed-off-by: slowy07 * fix: adding preprocessor directive to catch macos Signed-off-by: slowy07 * docs: adding CONTRIBUTING Signed-off-by: slowy07 * chore: adding entropies [Documentation] adding entropies, entrpoies is a measure of the amount of randomness or uncertainty ins tate of a quantum system. - creating quantum system the code creates a complex matrix `rho` representing a quantum state using predefined state `st.pb00`, the state is likely defined in the include `clarah.h` header - partial trace calculation the `ptrace()` function is used to compute the partial trace of the quantums state `rho` over subsystem B. the result stored in the matrix `rhoA` - displaying states the `disp()` function is used to display the original quantum state matrix `rho` and the result of the partial trace `rhoA` - entropy calculation the `tsallis()` function is used to calculate the tsallis-1 and tsallis-2 entropies for the quantum matrix `rho`. the calculated entropies displayed - quantum mutual information calculation teh `qmutualinformation()` function to calculation the quantum mutual information between subsystem A and B the quantum state `rho`. the calculated mutual information is displayed Signed-off-by: slowy07 * chore: adding quantum circuit simulation [Documentation] demonstrate the simulation of quantum circuit, including gate operations and measurement, the process code by: - create quantum state `psi` and initialized to |00⟩ state - controlled (CNOT) gate `U` is created using the tensor product (`kron`) of the hadamard gate (`gt.H`) and the identity gate (`gt.Id2`) - the gate `U` applied to the quantums state `psi` resulting in a new state stored in the variable `result` state - X gate (`gt.X`) is applied to the `result` state at qubit 1, updating the state - print the `producing` bell state - the state measurement is performed on the `result` state using hadamard gate (`gt.H`) on qubit 0. the measurement result, probabilites, and resulting states are store in the `measured tuple` Signed-off-by: slowy07 * fix: remove unused header chore: commented some code Signed-off-by: slowy07 --------- Signed-off-by: slowy07 Co-authored-by: khaira nabila <75076265+khairanabila@users.noreply.github.com> Co-authored-by: rulanugrh --- include/clara.h | 2 + testing/_test.cpp | 106 ++++--------------------------------------- testing/channels.cpp | 46 +++++++++---------- 3 files changed, 34 insertions(+), 120 deletions(-) diff --git a/include/clara.h b/include/clara.h index c145dd4..7e02de9 100644 --- a/include/clara.h +++ b/include/clara.h @@ -36,6 +36,8 @@ #include #include +#include +#include // inter dependicies #include "classFunction/codes.h" #include "classFunction/exception.h" diff --git a/testing/_test.cpp b/testing/_test.cpp index b8a1b1e..d2d295a 100644 --- a/testing/_test.cpp +++ b/testing/_test.cpp @@ -6,7 +6,6 @@ #include #include -#include "../include/clara.h" #include "../include/experimental/experimental_test.h" /** @@ -18,101 +17,14 @@ */ using namespace clara; +using namespace::experimental; int main() { - std::cout << "testing testing \n"; - - // initialize bit circuit with 70 bits - const idx bits = 70; - experimental::Bit_circuit b{bits}; - - const idx trials = 20; - - // number of trials - b.rand(); - auto c = b; - - /** - * random number generator `gen` is set up using - * random_device for generating random indices. for each trial - * vector `v` is filled wuth values from `0` to `bits-1`. the element - * of `v` represent the indices of the `TOF` (Toffoli) operation. these indices - * are store for later use in trials - */ - std::random_device rd; - std::mt19937 gen{rd()}; - std::vector> indices(trials); - - for (idx i = 0; i < trials; ++i) { - std::vector v(bits); - std::iota(v.begin(), v.end(), 0); - std::shuffle(v.begin(), v.end(), gen); - std::vector tof(v.data(), v.data() + 3); - indices[i] = tof; - } - - /** - * the first half of the trials is performed. the indices for each trials are - * printed, and the `TOF` operations is applied to the `Bit_circuit` using - * corresponding indices - */ - for (idx i = 0; i < trials; ++i) { - std::cout << "first: "; - for (auto&& elem : indices[i]) - std::cout << elem << " "; - std::cout << std::endl; - b.TOF(indices[i]); - } - - /** - * the second half of the trials performed in reverse order. the indices for each - * trial are again printed, and the `TOF` operation is applied to the `Bit_circuit` - * using the corresponding indices - */ - for (idx i = trials; i-- > 0;) { - std::cout << "second: "; - for (auto&& elem : indices[i]) - std::cout << elem << " "; - std::cout << std::endl; - b.TOF(indices[i]); - } - - /** - * the initail and final state are printed. the hamming weight (number of set bits) - * of `b` is displayed. the count of NOT, X and TOF gates used in `b` is printed - */ - std::cout << "initial: " << b << std::endl; - std::cout << "final: " << c << std::endl; - std::cout << "hamming weight: " << b.count() << std::endl; - - std::cout << b.gate_count.NOT << " " << b.gate_count.X << " " << b.gate_count.TOF << std::endl; - std::cout << (b == c) << std::endl; - std::cout << (b != c) << std::endl; - - /** - * various quantum states and projections are created and printed - */ - experimental::Dynamic_bitset bb(9); - bb.set(1).set(3).set(8); - std::cout << bb << std::endl; - - std::cout << "info: " << std::endl; - std::cout << bb.to_string('o', 'X') << std::endl; - - experimental::Dynamic_bitset vlad(20); - std::cout << vlad << std::endl; - - std::vector vv(20); - for (auto& elem : vv) { - std::cout << elem; - } - std::cout << std::endl; - - ket x = (10_ket + 01_ket) / std::sqrt(2); - std::cout << disp(x) << std::endl; - - bra y = (10_bra + 01_bra) / std::sqrt(2); - std::cout << disp(x) << std::endl; - - cmat z = 110_prj; - std::cout << disp(z) << std::endl; + ClaraCircuit claraCircuit(10, 10); + claraCircuit.apply_all(gt.H); + std::cout << claraCircuit.get_num_active_qubits() << std::endl; + + claraCircuit.measure({3, 1, 7}); + std::cout << claraCircuit.get_num_active_qubits() << std::endl; + // std::cout << claraCircuit.get_num_measured_qubits() << std::endl; + // std::cout << claraCircuit.get_num_active_qubits() << std::endl; } diff --git a/testing/channels.cpp b/testing/channels.cpp index 57fbd5a..16b8851 100644 --- a/testing/channels.cpp +++ b/testing/channels.cpp @@ -42,27 +42,27 @@ int main() { std::cout << "their sum is: " << sum(hevals(choim)) << "\n"; - std::vector Kperps = choi2kraus(choim); - std::cout << "kraus rank of channel : " << Kperps.size() << "\n"; - - cmat rho_out1 = clara::apply(rho_in, Kperps); - // verification norm difference - std::cout << "norm difference ouput states: " << norm(rho_out1 - rho_out) << "\n"; - - std::cout << "superoperator matrix:\n"; - cmat smat = kraus2super(Ks); - std::cout << disp(smat) << "\n"; - - std::cout << "the eigenvalues of the superoperator matrix :\n"; - dyn_col_vect evalsupop = evals(smat); - std::cout << disp(transpose(evalsupop)) << "\n"; - - std::cout << "their absolute values are: \n"; - for (idx i = 0; i < (idx)evalsupop.size(); ++i) - std::cout << std::abs(evalsupop(i)) << " "; - - // verification - std::cout << "\n norm difference for the superoperator action: "; - cmat rho_out2 = transpose(reshape(smat * reshape(transpose(rho_in), D * D, 1), D, D)); - std::cout << norm(rho_out - rho_out2) << "\n"; +// std::vector Kperps = choi2kraus(choim); +// std::cout << "kraus rank of channel : " << Kperps.size() << "\n"; +// +// cmat rho_out1 = clara::apply(rho_in, Kperps); +// // verification norm difference +// std::cout << "norm difference ouput states: " << norm(rho_out1 - rho_out) << "\n"; +// +// std::cout << "superoperator matrix:\n"; +// cmat smat = kraus2super(Ks); +// std::cout << disp(smat) << "\n"; +// +// std::cout << "the eigenvalues of the superoperator matrix :\n"; +// dyn_col_vect evalsupop = evals(smat); +// std::cout << disp(transpose(evalsupop)) << "\n"; +// +// std::cout << "their absolute values are: \n"; +// for (idx i = 0; i < (idx)evalsupop.size(); ++i) +// std::cout << std::abs(evalsupop(i)) << " "; +// +// // verification +// std::cout << "\n norm difference for the superoperator action: "; +// cmat rho_out2 = transpose(reshape(smat * reshape(transpose(rho_in), D * D, 1), D, D)); +// std::cout << norm(rho_out - rho_out2) << "\n"; }