everett 0.1.2

A clean, zero-dependency statevector quantum simulator.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

//! # everett
//!
//! A clean, zero-dependency statevector quantum simulator.
//!
//! `everett` represents the state of `n` qubits as a complex vector of `2^n`
//! amplitudes and applies gates in place over amplitude index-groups, never by
//! materializing a `2^n x 2^n` matrix. You describe a computation by building a
//! [`Circuit`], then run it on a backend such as [`StateVectorBackend`].
//!
//! ## Example: a Bell state
//!
//! ```
//! use everett::prelude::*;
//!
//! let mut circuit = Circuit::new(2);
//! circuit.h(0).cnot(0, 1);
//!
//! let exec = StateVectorBackend::run(&circuit)?;
//! let state = exec.state();
//! assert!((state.probability(0b00) - 0.5).abs() < 1e-12);
//! assert!((state.probability(0b11) - 0.5).abs() < 1e-12);
//! # Ok::<(), everett::Error>(())
//! ```
//!
//! ## Layout
//!
//! - [`Complex64`]: the amplitude scalar.
//! - [`State`]: the statevector and its observables.
//! - [`Gate1`], [`Gate2`]: gate matrices.
//! - [`Circuit`]: the fluent builder.
//! - [`StateVectorBackend`]: the dense execution backend.
//! - [`algorithms`]: worked, reusable circuits (Bell, GHZ, teleportation, ...).

#![forbid(unsafe_op_in_unsafe_fn)]

pub mod algorithms;
mod backend;
mod circuit;
mod complex;
pub mod density;
mod error;
mod gate;
pub mod kernel;
mod measure;
pub mod noise;
mod op;
pub mod qasm;
mod qubit;
mod rng;
mod state;

pub use backend::{
    DensityMatrixBackend, DensityMatrixExecution, Execution, PauliString, StabilizerBackend,
    StabilizerExecution, StateVectorBackend,
};
pub use circuit::Circuit;
pub use complex::Complex64;
pub use density::DensityMatrix;
pub use error::{Error, Result};
pub use gate::{Gate1, Gate2};
pub use noise::NoiseModel;
pub use op::Op;
pub use qubit::{ClassicalBit, QubitId};
pub use rng::Rng;
pub use state::State;

/// The backend trait that execution targets implement.
pub use backend::Backend;

/// Common imports for everyday use: `use everett::prelude::*;`.
pub mod prelude {
    pub use crate::circuit::Circuit;
    pub use crate::complex::Complex64;
    pub use crate::gate::{Gate1, Gate2};
    pub use crate::state::State;
    pub use crate::{Backend, Execution, StateVectorBackend};
}